# Shlink Web Client

Shlink Web Client is the official web interface for Shlink, a self-hosted URL shortener. It is open source and self-hosted, installable on TrueNAS, Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/577/shlink-web-client

## Description

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.

## Health score

75/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 21 days ago)
- Popular: 52 (401 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 100 (128 MB minimum RAM, runs on ARM)

## Links

- GitHub: https://github.com/shlinkio/shlink-web-client
- TrueNAS: https://apps.truenas.com/catalog/shlink
- Official website: https://app.shlink.io
- Docker Hub: https://hub.docker.com/r/shlinkio/shlink-web-client/
- Unraid: https://ca.unraid.net/apps/shlink-web-client-0c9oyqj15w5nov?q=shlink-web-client

## 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.

## Alternatives

- 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…

---
Source: Our Local Host (https://ourlocalhost.com/app/577/shlink-web-client), the self-hosted and open-source app directory.
