Merge pull request #743 from acelaya-forks/feature/geolite-license

Feature/geolite license

CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## 2.1.4 - 2020-04-30
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#742](https://github.com/shlinkio/shlink/issues/742) Allowed a custom GeoLite2 license key to be provided, in order to avoid download limits.
+
+
 ## 2.1.3 - 2020-04-09
 
 #### Added

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",

config/autoload/installer.global.php

@@ -31,6 +31,7 @@ return [
             Option\WebWorkerNumConfigOption::class,
             Option\RedisServersConfigOption::class,
             Option\ShortCodeLengthOption::class,
+            Option\GeoLiteLicenseKeyConfigOption::class,
         ],
 
         'installation_commands' => [

docker/README.md

@@ -18,7 +18,7 @@ It also expects these two env vars to be provided, in order to properly generate
 So based on this, to run shlink on a local docker service, you should run a command like this:
 
 ```bash
-docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https shlinkio/shlink:stable
+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
 ```
 
 ### Interact with shlink's CLI on a running container.
@@ -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"
 }
 ```
 

docker/config/shlink_in_docker.local.php

@@ -147,4 +147,8 @@ return [
         ],
     ],
 
+    'geolite2' => [
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
+    ],
+
 ];

module/Core/src/Config/SimplifiedConfigParser.php

@@ -33,6 +33,7 @@ class SimplifiedConfigParser
         'task_worker_num' => ['mezzio-swoole', 'swoole-http-server', 'options', 'task_worker_num'],
         'visits_webhooks' => ['url_shortener', 'visits_webhooks'],
         'default_short_codes_length' => ['url_shortener', 'default_short_codes_length'],
+        'geolite_license_key' => ['geolite2', 'license_key'],
     ];
     private const SIMPLIFIED_CONFIG_SIDE_EFFECTS = [
         'delete_short_url_threshold' => [

module/Core/test/Config/SimplifiedConfigParserTest.php

@@ -60,6 +60,7 @@ class SimplifiedConfigParserTest extends TestCase
                 'https://third-party.io/foo',
             ],
             'default_short_codes_length' => 8,
+            'geolite_license_key' => 'kjh23ljkbndskj345',
         ];
         $expected = [
             'app_options' => [
@@ -127,6 +128,10 @@ class SimplifiedConfigParserTest extends TestCase
                     ],
                 ],
             ],
+
+            'geolite2' => [
+                'license_key' => 'kjh23ljkbndskj345',
+            ],
         ];
 
         $result = ($this->postProcessor)(array_merge($config, $simplified));