Getting started

Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it.

Additionally, there's also an official Shlink web client which, by making use of Shlink's REST API, provides a beautiful web UI to handle multiple Shlink instances.

This documentation will walk you through the process of getting both Shlink and shlink-web-client installed, using one of the many available approaches.

You will also learn how it is architected, how to use it once installed, and answers to frequently asked questions.

Table of contents

• Getting started
• Install docker image
• Install from dist file
• Serve with openswoole
• Classic web server
• GeoLite2 license key
• Long-running tasks
• Update your instance
• Tracking visits
• Some features
• Environment variables
• Advanced
• Special redirects
• Multiple domains
• Import short URLs
• Real-time updates
• Using a reverse proxy
• Shlink architecture
• Command line
• CLI entry point
• Installation tool
• REST API
• Authentication
• Error management
• API key roles
• Endpoints
• Shlink web client
• Installation
• Serve in sub path
• Pre-configuring servers
• Integrations
• Short Menu for Mac
• Short Menu for iOS
• GNOME Shell extension
• Troubleshooting