mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-23 13:23:33 +03:00
Code Issues Projects Releases Packages Wiki Activity
shlink/docker
History
Alejandro Celaya 13d70cd12a Updated docker entry point to make sure debugging and verbosity of commands works as expected
2021-12-07 19:14:56 +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 Updated docker entry point to make sure debugging and verbosity of commands works as expected 2021-12-07 19:14:56 +01:00
README.md Added support for openswoole and migrated docker images from swoole to openswoole 2021-12-05 10:08:10 +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 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.