mirror of https://github.com/shlinkio/shlink.git synced 2024-12-24 08:00:13 -06:00

History

Alejandro Celaya 5737acf759 Merge pull request #1099 from mikafouenski/develop Run periodic `visit:locate` as opt-in		2021-05-30 17:55:13 +02:00
..
config	Skip downloading GeoLite db if global tracking or IP tracking are disabled	2021-05-30 12:30:03 +02:00
build	Changed approach to ensure the default value for the version while building the docker image is latest	2021-03-01 21:17:32 +01:00
docker-entrypoint.sh	Update docker/docker-entrypoint.sh	2021-05-30 17:41:40 +02:00
README.md	Simplified docker image docs, linking to the website for anything other than the very basics	2021-01-17 17:40:47 +01:00

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 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.