mirror of https://github.com/shlinkio/shlink.git synced 2024-11-24 05:38:06 +03:00

History

Alejandro Celaya 81f82d3b73 Reduced docker image size by ensuring dev native libs are not included in final image		2022-01-03 18:48:08 +01:00
..
config	Moved env vars to common global config files, so that theycan be used in non-docker contexts too	2021-08-07 11:05:20 +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	Reduced docker image size by ensuring dev native libs are not included in final image	2022-01-03 18:48:08 +01:00
README.md	Added new IS_HTTPS_ENABLED env var and deprecated USE_HTTPS	2021-12-10 16:24:38 +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.