Self-host Shlink with Levelrail

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

  • Authorshlinkio
  • LicenceMIT
  • Memory128 MiB
  • Archarm64
  • Services1

How to self-host Shlink

  1. Pull the images

    One image is pulled on your server.

    Show images
    • shlinkio/shlink:stable
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 8080.

  3. Fill in the secrets

    2 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Shlink requirements

Memory
About 128 MiB
Architectures
amd64 image published, arm64 image published
Ports
8080
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 8080 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Shlink. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Shlink docs page.

Deploy Shlink your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Shlink from the CLI

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

Deploy Shlink with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/shlink/deploy

Shlink configuration

Shlink services

ServiceImagePortsVolumes
shlink shlinkio/shlink:stable 8080 shlink_data -> /etc/shlink/data

Shlink environment variables

VariableServiceValue
DEFAULT_DOMAIN shlink Preset by the template
IS_HTTPS_ENABLED shlink Preset by the template

Ports and volumes

Ports
8080
Volumes
1 named mount: shlink_data -> /etc/shlink/data

Shlink FAQ

How much memory does Shlink need?

The catalog lists about 128 MiB of memory for Shlink.

Does Shlink run on arm64?

For Shlink, an arm64 image is published; amd64 is image published.

What licence is Shlink under?

Shlink is licensed under MIT, which is permissive, with few conditions on reuse.

Does Shlink need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Shlink use?

Shlink listens on port 8080 inside the stack.

Where does Shlink keep its data?

In a named volume: shlink_data mounted at /etc/shlink/data.

Can I deploy Shlink on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id shlink for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image shlinkio/shlink:stable is what you deploy there.

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