shlink/docker/README.md

Shlink Docker image

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

It exposes a shlink instance served with openswoole, 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.

• DEFAULT_DOMAIN: The default short domain used for this shlink instance. For example doma.in.
• USE_HTTPS: Either true or false.
• 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 DEFAULT_DOMAIN=doma.in \
    -e USE_HTTPS=true \
    -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.