Shlink Web Client

Shlink Web Client is the official web interface for Shlink, a self-hosted URL shortener.

  • Tools & Utilities
  • Web & Publishing
Shlink Web Client is the official web interface for Shlink, a self-hosted URL shortener. It provides a browser-based dashboard for creating, organizing, and monitoring shortened links and their traffic, for homelab users who want a graphical front end instead of calling the Shlink API directly.

Platform availability

Available on 2 of 10 platforms

  • Unraid
  • TrueNAS
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

75/100 Good

Maintained
100last commit 21 days ago
Popular
52401 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
100128 MB minimum RAM, runs on ARM

Availability: platform listings confirmed today, links checked 53 days ago

GitHub stars
401
Open issues
3
Last commit
2026-10-31
Latest release
v4.9.0
License
MIT
Activity
steady

Checked 18 days ago - source: GitHub (shlinkio/shlink-web-client)

Resources & Compatibility

Minimum requirements: 128 MB RAM. ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Check the health endpoint after starting After the app starts, request the /rest/health endpoint (you can type it into a browser or use a terminal tool like curl). This quick check tells you whether the Shlink service is answering; if it fails, your short links and web interface will not work yet. source
  • Test that short links redirect Once a short link exists, open it in a browser to confirm it jumps to the intended long URL. This tests the public redirect path that visitors use, so if it does not redirect correctly, people clicking your links will see errors. source
  • Shlink server setup Run a Shlink server first, then generate an API key with the CLI command shlink api-key:generate and add that key to the client's servers.json file. source

Fetched 37 days ago - each note links to its source

Alternatives (2)

  • Simple-URL-Shortener
  • rs-short - Rs-short is a minimal, lightweight link shortener written in Rust for self-hosters who want a fast, private, resource-efficient URL shorten…

Checked 40 days ago - source: AlternativeTo

Common questions

How do I serve the self-hosted web client without dynamic routes returning 404?

Configure the web server to fall back to index.html when the requested file does not exist because the app uses a client-side router. Apache is covered by the included .htaccess, and nginx can use the same approach as the Docker config.

What port should I expose for the Docker image?

The Docker image serves the static app on port 8080.

Can I preconfigure Shlink servers and API keys before first use?

You can place a servers.json file in the project root with the server name, URL, and API key starting with version 2.1.0. Otherwise, the first browser configuration is stored in local storage and can be exported or imported.

How can I add authentication when reverse-proxying the web client?

One reverse-proxy setup adds an Authelia redirect in the web client's advanced configuration for authentication.

What should I try first if the self-hosted client cannot see the Shlink server?

Test the same Shlink server using the hosted web client first to isolate the problem from your self-hosted client.

Answers sourced from github.com, www.reddit.com, www.reddit.com

Community

Collected 54 days ago - public community threads