Portainer Templates logo

Portainer Templates

Shlink Shlink

Stack

Business Apps

Shlink - a self-hosted URL shortener: short links on your own domain with a full REST API, QR codes, rich visit analytics (with optional GeoIP), tags, device-based redirect rules, and link expiration.

Configuration

Type
Compose
Platform
linux
Env vars
DEFAULT_DOMAIN=localhost:5000GEOLITE_LICENSE_KEY=''INITIAL_API_KEY=''IS_HTTPS_ENABLED=false
Source
Repo

Template by deployable-sh·Source

Report issue

Services

shlink

Configuration

Image
shlinkio/shlink:4.4.6
Ports
5000:5000
Env vars
PORT=5000DEFAULT_DOMAIN=${DEFAULT_DOMAIN:-localhost:5000}IS_HTTPS_ENABLED=${IS_HTTPS_ENABLED:-false}INITIAL_API_KEY=${INITIAL_API_KEY}DB_DRIVER=postgresDB_HOST=dbDB_PORT=5432DB_NAME=shlinkDB_USER=shlinkDB_PASSWORD=shlink-local-onlyGEOLITE_LICENSE_KEY=${GEOLITE_LICENSE_KEY:-}
Restart
unless-stopped

Image details

Pulls: 35.4M
User: shlinkio
Created: Oct 24, 2017
Updated: 2 days ago
Status: active

db

Configuration

Image
postgres:16
Volumes
/var/lib/postgresql/data : dbdata
Env vars
POSTGRES_USER=shlinkPOSTGRES_PASSWORD=shlink-local-onlyPOSTGRES_DB=shlink
Restart
unless-stopped

Image details

Pulls: 11.6B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Shlink

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Shlink, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: shlink

services:
  shlink:
    image: shlinkio/shlink:4.4.6
    restart: unless-stopped
    environment:
      PORT: "5000"
      DEFAULT_DOMAIN: ${DEFAULT_DOMAIN:-localhost:5000}
      IS_HTTPS_ENABLED: ${IS_HTTPS_ENABLED:-false}
      INITIAL_API_KEY: ${INITIAL_API_KEY}
      DB_DRIVER: postgres
      DB_HOST: db
      DB_PORT: "5432"
      DB_NAME: shlink
      DB_USER: shlink
      DB_PASSWORD: shlink-local-only
      GEOLITE_LICENSE_KEY: ${GEOLITE_LICENSE_KEY:-}
    ports:
      - "5000:5000"
    depends_on:
      - db

  db:
    image: postgres:16
    restart: unless-stopped
    environment:
      POSTGRES_USER: shlink
      POSTGRES_PASSWORD: shlink-local-only
      POSTGRES_DB: shlink
    volumes:
      - dbdata:/var/lib/postgresql/data

volumes:
  dbdata:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f shlink/compose.yaml up -d

More install options in our documentation.

Container Documentation

shlink Documentation

A self-hosted and PHP-based URL shortener application with CLI and REST interfaces

db Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve Shlink on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying shlink.example.com to http://shlink:5000

Add this to your Caddyfile

shlink.example.com {
	reverse_proxy http://shlink:5000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, shlink can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull shlinkio/shlink:4.4.6

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Shlink is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • shlink runs shlinkio/shlink:4.4.6, starts after db
  • db runs postgres:16

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000

Volumes

A volume is where Shlink keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/postgresql/data kept in the dbdata volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Shlink takes 14 of them, all with defaults you can leave alone or tweak:

  • PORT, defaults to 5000
  • DEFAULT_DOMAIN, defaults to localhost:5000
  • IS_HTTPS_ENABLED, defaults to false
  • INITIAL_API_KEY, pulled from your own environment
  • DB_DRIVER, defaults to postgres
  • DB_HOST, defaults to db
  • DB_PORT, defaults to 5432
  • DB_NAME, defaults to shlink
  • DB_USER, defaults to shlink
  • DB_PASSWORD, defaults to shlink-local-only
  • GEOLITE_LICENSE_KEY, pulled from your own environment
  • POSTGRES_USER, defaults to shlink
  • POSTGRES_PASSWORD, defaults to shlink-local-only
  • POSTGRES_DB, defaults to shlink

Restart policy

The restart policy here is unless-stopped, so Docker restarts Shlink after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like shlink) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Shlink up. Add the template list to Portainer once, then deploying Shlink is a click rather than a wall of config.