OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-25 02:10:18 -06:00
Code Issues Packages Projects Releases Wiki Activity
07ce5f05a2
shlink/docker
History
Alejandro Celaya 882d64ae11 Add deprecation note for ENABLE_PERIODIC_VISIT_LOCATE env var
2023-05-23 10:55:49 +02:00
..
config Standardize logger for all Shlink execution contexts 2023-05-07 13:18:19 +02:00
docker-entrypoint.sh Add deprecation note for ENABLE_PERIODIC_VISIT_LOCATE env var 2023-05-23 10:55:49 +02:00
README.md Replace references to doma.in with s.test 2023-01-19 09:05:52 +01:00

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 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 s.test.
  • 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=s.test \
    -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.