# Shlink

Shlink is a self-hosted other app. A self-hosted URL shortener application that lets you create and manage shortened links under your own domain, with both command-line and REST API interfaces. It is open source and self-hosted, installable on Docker Hub, Proxmox, Kubernetes (Helm), TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/408/shlink

## Description

A self-hosted URL shortener application that lets you create and manage shortened links under your own domain, with both command-line and REST API interfaces.

## Platform availability

Available on 4 of 9 platforms: Unraid, TrueNAS, Proxmox, Helm.

## Health score

82/100 (Excellent), based on 5 of 5 factors.
- Maintained: 100 (last commit 33 days ago)
- Popular: 75 (5,318 GitHub stars)
- Easy to install: 65 (4 install platforms, install notes, Docker image)
- Light to run: 80 (1 GB minimum RAM, runs on ARM)
- Security check: 75 (no serious findings, CI, tests, OpenSSF Scorecard 4.5/10)

## Links

- Docker Hub: https://hub.docker.com/r/shlinkio/shlink
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=shlink
- Kubernetes (Helm): https://artifacthub.io/packages/helm/geek-cookbook/shlink
- TrueNAS: https://apps.truenas.com/catalog/shlink/
- Unraid: https://ca.unraid.net/apps/shlink-18mbjto0nhwleg?q=shlink
- Official website: https://shlink.io/
- GitHub: https://github.com/shlinkio/shlink
- Documentation: https://shlink.io/documentation

## Common questions

### How can I confirm Shlink has started and that short links are reachable?

Open the Shlink health endpoint to confirm the service started. The public short-code page and network port must also be reachable by visitors for links to resolve.

### How should I configure async API visit-notification callbacks?

Use your actual Shlink URL as the callback base instead of the example callback base. Otherwise new-visit and new-short-url events may not reach the tool you set up.

### Does Shlink include a separate web client for management?

An official Shlink web client uses the REST API to provide a web UI for handling multiple Shlink instances.

### Where can I find guidance for using a reverse proxy with Shlink?

The Shlink documentation includes a Using a reverse proxy section under advanced topics.

### Is there a Docker Compose approach for self-hosting Shlink?

A self-hosted community thread covers setting up Shlink using Docker Compose and adapting a containerized deployment.

## Alternatives

- Beacons: Create a free, beautiful, and highly customizable link in bio website with Beacons.
- Dub.co: Open-source link management with analytics, free QR code generation, custom domains, advanced audience targeting, team collaboration, and S…
- Fli.so: Fli.so is a lightning-fast URL shortener built with SvelteKit and PocketBase.
- Polr: Like everything else here, Polr is an open source and self-hostable web application.
- TinyURL: Converts long URLs into short, secure links, supports branded domains, bulk shortening via API, link analytics, QR code generation, and das…
- YOURLS: YOURLS is a free, open-source self-hosted URL shortener that lets you create shortened links on your own server, with analytics, plugins, a…
- bit.ly: Shortens URLs, generates customizable QR codes, tracks clicks, offers branded domains, bulk management, analytics, browser extension, and A…

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