From af8b6b7f9646c8866da3fad39289a316daa92eac Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Wed, 29 Apr 2020 19:24:18 +0200 Subject: [PATCH] Documented how to pass a GEOLITE license key --- composer.json | 2 +- docker/README.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index cd0d699a..e6c59e98 100644 --- a/composer.json +++ b/composer.json @@ -52,7 +52,7 @@ "shlinkio/shlink-common": "^3.0", "shlinkio/shlink-config": "^1.0", "shlinkio/shlink-event-dispatcher": "^1.4", - "shlinkio/shlink-installer": "^4.3.2", + "shlinkio/shlink-installer": "^4.4.0", "shlinkio/shlink-ip-geolocation": "^1.4", "symfony/console": "^5.0", "symfony/filesystem": "^5.0", diff --git a/docker/README.md b/docker/README.md index 3977fa37..b19c0335 100644 --- a/docker/README.md +++ b/docker/README.md @@ -121,6 +121,8 @@ This is the complete list of supported env vars: In the future, these redis servers could be used for other caching operations performed by shlink. +* `GEOLITE_LICENSE_KEY`: The license key used to download new GeoLite2 database files. This is not mandatory, as a default license key is provided, but it is **strongly recommended** that you provide your own. Go to [https://shlink.io/documentation/geolite-license-key](https://shlink.io/documentation/geolite-license-key) to know how to generate it. + An example using all env vars could look like this: ```bash @@ -147,6 +149,7 @@ docker run \ -e TASK_WORKER_NUM=32 \ -e "VISITS_WEBHOOKS=http://my-api.com/api/v2.3/notify,https://third-party.io/foo" \ -e DEFAULT_SHORT_CODES_LENGTH=6 \ + -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \ shlinkio/shlink:stable ``` @@ -187,7 +190,8 @@ The whole configuration should have this format, but it can be split into multip "password": "123abc", "host": "something.rds.amazonaws.com", "port": "3306" - } + }, + "geolite_license_key": "kjh23ljkbndskj345" } ```