Self-host Shlink on a VPS

A self-hosted URL shortener with a full REST API for creating and tracking short links.

levelrail-cli templates deploy shlink --name my-shlink

Specification

Status
Listed
Category
Developer Tools
Services
shlink
Ports
8080
Volumes
1
Memory
about 128 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About Shlink

A self-hosted URL shortener with a full REST API for creating and tracking short links. Runs as a single container from the shlink image, listening on port 8080; data is kept in named volumes.

What it deploys

Shlink runs as one service in a single Compose app, listening on port 8080, with 1 named volume mount.

ServiceImageTagPortsVolumes
shlink shlinkio/shlink stable 8080 shlink_data -> /etc/shlink/data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 8080 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. Values are never shown here.

ServiceVariableValue
shlinkDEFAULT_DOMAINPreset by the template
shlinkIS_HTTPS_ENABLEDPreset by the template

Install Shlink on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get shlink
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy shlink --name my-shlink

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Shlink.

More in Developer Tools

All Developer Tools templates