This project is currently work in progress and not in a productive usable state. Keep track of following releases for actual usable versions.

vctr [ˈvɛktər] is a self hosted service to access, create, manage and analyze short links.

You can test vctr's live demo hosted on on s2.zekro.de. The password is test.
Attention: This data may not be consistent, of course, and entries may be deleted and/or modified.

• ✔️ fully implemented
• ✖️ partially implemented but not fully functional yet
• ❌ not implemented

• [UI ] General Settings View
• [API] Short link analysis details endpoint
• [UI ] Short link details and analysis

vctr uses following configuration structrue:

{
    "Logging": {
        "LogLevel": {
            "Default": "Debug"
        }
    },

    "ConnectionStrings": {
        "MySQL": "Server=localhost;Database=vctr;User Id=vctr;Password=password"
    },

    "Secrets": {
        "IPInfoToken": ""
    },
    
    "Server": {
        "URL": "localhost"
    }
}

Settings can be provided by:

• an appsettings.json file in the root direction
• environment variables
  Every key must start with VCTR_ and groups are seperated by __, for example: VCTR_CONNECTIONSTRINGS__MYSQL.
• command arguments
  Groups are seperated by :, for example: --ConnectionStrings:MySQL.

vctr currently requires a connection to a MySQL / MariaDB database to save persistent data.

The recommended way to set up and install vctr is by using the provided docker image, which can be built using the Dockerfile in this repository or by pulling the latest pre-built image from Docker Hub registry.

# docker pull zekro/vctr:latest

# docker run \
    --name vctr \
    --publish 80:80 \
    --env 'VCTR_CONNECTIONSTRINGS__MYSQL=Server=localhost;Database=vctr;User Id=vctr;Password=password' \
    --env 'VCTR_SERVER__URL=localhost' \
    --env 'VCTR_SECRETS__IPINFOTOKEN=token' \
    --detached \
    zekro/vctr:latest

Then, open up your browser and connect to the published address of vctr to initially set a password which is used to access the service.

For that, following installations are required:

• ASP.NET Core 2.1 SDK
• node JS >= 12.13.x

Then, compile it with the following command to a self-contained binary with all nessecary web assets and libraries:

$ dotnet publish -c Release -r linux-x64 --self-contained true

Of course, you need to modify the RID (Runtime Identifier) depending on your needs. Here you can find a catalog of runtime identifiers available.

The resulting assets are located at

bin/Release/netcoreapp2.1/linux-x64/

Don't be surprised because the binaies will be named slms2asp. That's the actual current namespace of the application, which was created when vctr was not the official project name.

© 2019 Ringo Hoffmann (zekro Development).
Covered by the MIT Licence.