mirror of
https://github.com/shlinkio/shlink.git
synced 2024-12-28 09:51:40 -06:00
35 lines
1.6 KiB
Markdown
35 lines
1.6 KiB
Markdown
# Shlink Docker image
|
|
|
|
[](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Build+docker+image%22)
|
|
[](https://hub.docker.com/r/shlinkio/shlink/)
|
|
|
|
This image provides an easy way to set up [shlink](https://shlink.io) on a container-based runtime.
|
|
|
|
It exposes a shlink instance served with [RoadRunner](https://roadrunner.dev), 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](https://shlink.io/documentation/geolite-license-key/) about this.
|
|
|
|
To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
|
|
|
|
```bash
|
|
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](https://shlink.io/documentation/install-docker-image/).
|