OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-12-18 21:23:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
2eff9929d8
shlink/docker
History
Alejandro Celaya 78038b3141 Simplified docker image docs, linking to the website for anything other than the very basics
2021-01-17 17:40:47 +01:00
..
config Documented how to provide the unix socket to connect to mysql, maria and postgres databases 2020-11-29 19:46:34 +01:00
build Fixed how docker image version is extracted from github ref 2020-07-31 21:32:06 +02:00
docker-entrypoint.sh Updated to mezzio-swoole 3 2021-01-14 20:19:38 +01: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

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