mirror of https://github.com/shlinkio/shlink.git synced 2024-12-22 23:23:42 -06:00

History

Alejandro Celaya 6f17f70137 Allowed to delay GeoLite2 db download on docker images		2022-09-18 17:00:03 +02:00
..
config	Added support to build the docker image with RoadRunner instead of openswoole	2022-08-27 13:01:38 +02:00
docker-entrypoint.sh	Allowed to delay GeoLite2 db download on docker images	2022-09-18 17:00:03 +02:00
README.md	Replaced references to regular swoole by openswoole	2022-01-23 11:29:53 +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 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.
IS_HTTPS_ENABLED: Either true or false. Tells if Shlink is being served with HTTPs or not.
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 IS_HTTPS_ENABLED=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.