Why this Configuration?
- True Data Sovereignty: 100% GDPR-compliant on-premises deployment. You own your configuration and data without vendor lock-in.
- Hardware Agnostic: Optimized and verified across low-power ARM64 SBCs (Raspberry Pi 5) and x86_64 hypervisors (Proxmox VE LXC & VM).
- Engine Freedom: Tested and supported under standard Docker Engine and unprivileged rootless Podman.
- Platform Verification: Tested on Proxmox LXC: docker (5.1.6, 2026-09-14), podman (5.1.6, 2026-09-14); Proxmox VM: docker (5.1.6, 2026-09-14), podman (5.1.6, 2026-09-14).
Quick Start (Standalone Docker Compose)
The snippet below is immediately ready to run in any standard Docker or Podman environment:
services:
shlink:
image: "shlinkio/shlink:latest"
container_name: njorddeploy-shlink
restart: unless-stopped
environment:
- "DEFAULT_DOMAIN=localhost:8089"
- "IS_HTTPS_ENABLED=false"
- "INITIAL_API_KEY=shlink_master_api_key_123"
- "DB_DRIVER=sqlite"
ports:
- "8089:8080"
volumes:
- "./data/shlink/data:/etc/shlink/data"
user: "0:0"
networks:
- njorddeploy_net
networks:
njorddeploy_net:
Start the service directly via the command line: docker compose up -d
Configuration & Environment Variables
Key configuration parameters and defaults derived from the NjordDeploy component template:
| Variable | Default Value | Description |
|---|---|---|
SHLINK_WEB_PORT |
8089 |
Web port for Shlink server. |
SHLINK_INITIAL_API_KEY |
shlink_master_api_key_123 |
Initial API key for administrative access. |
Ecosystem & Enterprise Integration
- Reverse Proxy Ingress Ready: Pre-configured for Caddy, Traefik, or Nginx Proxy Manager with automatic Let's Encrypt TLS certificates.
- Zero-Trust Mesh VPN: Seamless integration with WireGuard or Tailscale/Headscale mesh networks for secure remote administration.
- Transactional State Backups: Ready for point-in-time database dumps and container-safe persistent volume freezing.
Effortless Management with NjordDeploy
Deploy, monitor, and update this service with a single click on your own hardware via the NjordDeploy Configurator.