Overview:
Shlink is a PHP-based, self-hosted URL shortener that allows you to serve shortened URLs under your own domain. It is designed for developers and system administrators who want full control over their link management infrastructure. The project provides both a REST API and a command-line interface (CLI) for interacting with the shortened URLs. Shlink supports multiple database backends, including MySQL, MariaDB, PostgreSQL, MicrosoftSQL, and SQLite, and can be deployed via Docker or from source.
Core Features:
Self-hosted deployment: Can be run via Docker, a pre-built distributable package, or built from source with PHP 8.4 or 8.5.
Multiple database support: Works with MySQL, MariaDB, PostgreSQL, MicrosoftSQL Server, or SQLite.
API and CLI interaction: Offers a complete REST API with documentation and a CLI tool that supports most operations.
API key management: Generate and manage API keys through the CLI only, ensuring secure programmatic access.
Configurable installation: Setup is done via a command-line installer that guides users through database and environment configuration.
Use Cases:
Developers needing a private URL shortener: Use your own domain to create and manage short links without relying on third-party services.
System administrators deploying on their own infrastructure: Containerize with Docker or install directly on a PHP-compatible server using a dist file or source build.
Teams requiring programmatic link management: Integrate with the REST API for automating short link creation, redirection, and analytics within internal workflows.
Why It Matters:
Shlink provides a straightforward, self-hosted alternative to proprietary URL shorteners for those who want to keep link serving under their own domain. It supports multiple database engines, runs on standard PHP infrastructure, and offers both API and CLI access. The project does not claim to replace any specific commercial product, but its focus on self-hosting and flexible deployment gives users a transparent option for managing short URLs without external dependencies.
