|Project Name||Stars||Downloads||Repos Using This||Packages Using This||Most Recent Commit||Total Releases||Latest Release||Open Issues||License||Language|
|Shlink||2,232||3 days ago||121||June 14, 2023||31||mit||PHP|
|The definitive self-hosted URL shortener|
|Shortify||64||a month ago||3||gpl-3.0||Python|
|Shortify is a URL shortener RESTful API built with Python and FastAPI ⚡|
|Bitly||17||8 months ago||4||January 12, 2021||other||PHP|
|Bitly v4 API|
|Url Shortner||11||5 years ago||mit||Go|
|High scalable tiny-url app that stays on Etcd and Cassandra|
|Bitlygo||8||6 months ago||2||gpl-3.0||Go|
|URL Shortener - Short URLs & Custom Free Link Powered by Go language and PostgreSQL database. (API, JSON)|
|Alpa||7||a year ago||8||agpl-3.0||TypeScript|
|( अल्प ) — A fast ⚡ self-hosted link 🔗 shortener.|
|Shrtnr||4||9 years ago||2||Go|
|A URL shortener in Go backed by Redis|
|Shorten URLs with ease. Made in NodeJS using MongoDB (mongoose)|
|Frontend Mentor Url Shortening Project||2||2 months ago||SCSS|
|A pair programming project which leverages the URL Shortening API and stores condensed URLs using Local Storage.|
|Simple self-hosted shorthner url app that produce short url with primary service based on RESTful API|
A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.
This document contains the very basics to get started with Shlink. If you want to learn everything you can do with it, visit the full searchable documentation.
You can learn how to use the official docker image by reading the docs.
The idea is that you can just generate a container using the image and provide the custom config via env vars.
First, make sure the host where you are going to run shlink fulfills these requirements:
In order to run Shlink, you will need a built version of the project. There are two ways to get it.
Using a dist file
The easiest way to install shlink is by using one of the pre-bundled distributable packages.
Go to the latest version and download the
shlink*_dist.zip file that suits your needs. You will find one for every supported PHP version and with/without openswoole integration.
Finally, decompress the file in the location of your choice.
Building from sources
If for any reason you want to build the project yourself, follow these steps:
git clone https://github.com/shlinkio/shlink.git), or download it by clicking the Clone or download green button.
./build.sh 3.0.0, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when running
shlink -Vfrom the command line).
After that, you will have a dist file inside the
build directory, that you need to decompress in the location of your choice.
This is the process used when releasing new Shlink versions. After tagging the new version with git, the GitHub release is automatically created by a GitHub workflow, attaching the generated dist file to it.
Despite how you built the project, you now need to configure it, by following these steps:
datadirectory. Shlink uses it to cache some information.
vendor/bin/shlink-installer installscript. It is a command line tool that will guide you through the installation process. Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.
bin/cli api-key:generate. You will need the key in order to interact with Shlink's API.
Once shlink is installed, there are two main ways to interact with it:
The command line: Try running
bin/cli to see all the available commands.
All of them can be run with the
-h flag in order to see how to use them and all the available options.
It is probably a good idea to symlink the CLI entry point (
bin/cli) to somewhere in your path, so that you can run shlink from any directory.
Both the API and CLI allow you to do mostly the same operations, except for API key management, which can be done from the command line interface only.
If you are trying to find out how to run the project in development mode or how to provide contributions, read the CONTRIBUTING doc.
This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com