Alejandro Celaya 2fc6fb0a9a Added option to disable orphan visitstracking 3 years ago
..
config 2fc6fb0a9a Added option to disable orphan visitstracking 3 years ago
README.md 78038b3141 Simplified docker image docs, linking to the website for anything other than the very basics 3 years ago
build 18afd92fc3 Fixed how docker image version is extracted from github ref 3 years ago
docker-entrypoint.sh e3ff447152 Updated to mezzio-swoole 3 3 years ago

README.md

Shlink Docker image

Docker build status Docker pulls

This image provides an easy way to set up shlink on a container-based runtime.

It exposes a shlink instance served with swoole, which can be linked to external databases to persist data.

Usage

The most basic way to run Shlink's docker image is by providing these mandatory env vars.

  • SHORT_DOMAIN_HOST: The custom short domain used for this shlink instance. For example doma.in.
  • SHORT_DOMAIN_SCHEMA: Either http or https.
  • GEOLITE_LICENSE_KEY: Your GeoLite2 license key. Learn more about this.

To run shlink on top of a local docker service, and using an internal SQLite database, do the following:

docker run \
    --name shlink \
    -p 8080:8080 \
    -e SHORT_DOMAIN_HOST=doma.in \
    -e SHORT_DOMAIN_SCHEMA=https \
    -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
    shlinkio/shlink:stable

Full documentation

All the features supported by Shlink are also supported by the docker image.

If you want to learn more, visit the full documentation.