Shlink

Development256MB+ RAM

Self-hosted URL shortener with detailed analytics and REST API

Download Server Compass Install Shlink to server

developmentdevtoolsshlinkopen-sourceself-hosteddocker

Deploy Shlink in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Shlink

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Step-by-step deployment guide

Deploy Shlink on a VPS with Server Compass

Use the Shlink template in Server Compass to deploy a self-hosted URL shortener API with persistent storage on your VPS, then verify the Shlink API health endpoint in a browser.

About 7 minutesBrowser verified

Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Shlink app

Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template

Step 3

Search for Shlink

Use the template picker search to find Shlink in the Server Compass template catalog.

Searching for Shlink in the Server Compass template picker

Step 4

Select the Shlink template

Choose the Shlink template. Server Compass fills in the Shlink API service, public short-link domain, initial API key, and persistent data volume.

Shlink template selected in Server Compass

Step 5

Review the Shlink settings

Confirm the app name and compose services. In this run, the app was named shlink-demo and used host port 4034.

Reviewing Shlink project settings and compose services

Step 6

Deploy Shlink

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing Shlink environment variables and port before deployment

Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Shlink image, starts the container, and verifies the stack.

Server Compass deploying the Shlink template on the VPS

Step 8

Confirm Shlink is running

After deployment finishes, return to the Apps tab and confirm the Shlink app is marked Running with its application URL available.

Shlink template running in the Server Compass Apps tab

Step 9

Open Shlink in the browser

Open the application URL in a browser. The Shlink API health endpoint confirms the URL shortener API is reachable.

The deployed Shlink API health endpoint loaded in a browser

After Shlink Opens

Store the initial API key in a password manager and rotate it after creating production credentials.
Set SHLINK_DOMAIN to your final public domain before creating production short URLs.
Configure HTTPS before exposing Shlink publicly.
Back up the Shlink data volume before relying on production redirects.

Verified Result

The Shlink API health endpoint loaded successfully in a browser.

Download Server Compass Docs

Shlink deployment questions

What does the Shlink template deploy?

It deploys the Shlink URL shortener API with a persistent data volume for short URLs, visits, and configuration.

Which port did the tutorial use?

The tutorial used host port 4034, which maps to the Shlink web service on container port 8080.

Why does the guide stop at the login or setup health endpoint?

The tutorial verifies the clean Shlink API health endpoint because domain, API keys, redirects, and short URL settings depend on the production instance.

Should this become a blog post?

No. The deployment guide should live on the Shlink template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying Shlink with Server Compass, complete these steps to finish setup

Save the INITIAL_API_KEY for API usage

Optionally deploy shlinkio/shlink-web-client for a web UI

Update DEFAULT_DOMAIN to your production domain

Test by creating a short URL via the REST API

Need help? Check out our documentation for detailed guides.

Shlink FAQ

Common questions about self-hosting Shlink

How do I deploy Shlink with Server Compass?

Simply download Server Compass, connect to your VPS, and select Shlink from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Shlink?

Shlink requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Shlink data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Shlink backup and restore procedures.

How do I update Shlink to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Shlink image will be pulled and deployed with zero downtime.

Is Shlink free to self-host?

Shlink is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Related Templates

View all Development

PocketBase

Open-source backend in a single file with realtime database, auth, and file storage

Appwrite

Open-source backend-as-a-service - self-hosted Firebase alternative

Parse Server

Open-source backend framework with dashboard

Supabase

Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio

Ready to Self-Host Shlink?

Download Server Compass and deploy Shlink to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass