14c6ead389
Issuing a VOLUME instruction in a production Dockerfile requires the Docker engine to create a volume whether or not it is mapped to the host or a named volume. Neither of these paths have data that needs to be persisted for production use, so their inclusion under a typical `docker run` example forces the engine to create extraneous volumes which quickly become orphaned whenever the container is recreated. |
||
|---|---|---|
| .github | ||
| bin | ||
| config | ||
| data | ||
| docker | ||
| docs | ||
| module | ||
| public | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .phpstorm.meta.php | ||
| build.sh | ||
| CHANGELOG.md | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| docker-compose.ci.yml | ||
| docker-compose.override.yml.dist | ||
| docker-compose.yml | ||
| Dockerfile | ||
| indocker | ||
| infection-db.json | ||
| infection.json | ||
| LICENSE | ||
| migrations.php | ||
| phpcs.xml | ||
| phpstan.neon | ||
| phpunit-api.xml | ||
| phpunit-db.xml | ||
| phpunit.xml.dist | ||
| README.md | ||
| UPGRADE.md | ||
A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
Table of Contents
Full documentation
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.
Docker image
Starting with version 1.15.0, an official docker image is provided. You can learn how to use it 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.
Self hosted
First, make sure the host where you are going to run shlink fulfills these requirements:
- PHP 8.0
- The next PHP extensions: json, curl, pdo, intl, gd and gmp.
- apcu extension is recommended if you don't plan to use swoole.
- xml extension is required if you want to generate QR codes in svg format.
- MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
- The web server of your choice with PHP integration (Apache or Nginx recommended).
Download
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.zipfile that suits your needs. You will find one for every supported PHP version and with/without swoole 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:
- Clone the project with git (
git clone https://github.com/shlinkio/shlink.git), or download it by clicking the Clone or download green button. - Download the Composer PHP package manager inside the project folder.
- Run
./build.sh 1.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 runningshlink -Vfrom the command line).
After that, you will have a dist file inside the
builddirectory, 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.
- Clone the project with git (
Configure
Despite how you built the project, you now need to configure it, by following these steps:
- If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
- Recursively grant write permissions to the
datadirectory. Shlink uses it to cache some information. - Setup the application by running the
bin/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. - Generate your first API key by running
bin/cli api-key:generate. You will need the key in order to interact with shlink's API.
Using shlink
Once shlink is installed, there are two main ways to interact with it:
-
The command line. Try running
bin/cliand see all the available commands.All of those commands can be run with the
--help/-hflag 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. -
The REST API. The complete docs on how to use the API can be found here, and a sandbox which also documents every endpoint can be found in the API Spec portal.
However, you probably don't want to consume the raw API yourself. That's why a nice web client is provided that can be directly used from https://app.shlink.io, or hosted by yourself.
Both the API and CLI allow you to do the same operations, except for API key management, which can be done from the command line interface only.
Contributing
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