From 2c3cbe7146b8e9f3ddad55c245dbae9f3983c327 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Sun, 11 Nov 2018 12:04:42 +0100
Subject: [PATCH] Installed geoip2 and added to docs
---
README.md | 8 ++++++++
composer.json | 1 +
2 files changed, 9 insertions(+)
diff --git a/README.md b/README.md
index dbb18ce7..7b4d7bee 100644
--- a/README.md
+++ b/README.md
@@ -104,6 +104,12 @@ Those tasks can be performed using shlink's CLI, so it should be easy to schedul
If you don't run this command regularly, the stats will say all visits come from *unknown* locations.
+* Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
+
+ When shlink is installed it downloads a fresh [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) db file. Running this command will update this file.
+
+ The file does not change very frequently, so it shouldn't be needed to run this command more than once per month.
+
* Generate website previews: `/path/to/shlink/bin/cli short-url:process-previews`
Running this will improve the performance of the `doma.in/abc123/preview` URLs, which return a preview of the site.
@@ -186,3 +192,5 @@ Available commands:
visit
visit:process Processes visits where location is not set yet
```
+
+> This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)
diff --git a/composer.json b/composer.json
index 9064973d..86b52828 100644
--- a/composer.json
+++ b/composer.json
@@ -24,6 +24,7 @@
"doctrine/orm": "^2.5",
"endroid/qr-code": "^1.7",
"firebase/php-jwt": "^4.0",
+ "geoip2/geoip2": "^2.9",
"guzzlehttp/guzzle": "^6.2",
"lstrojny/functional-php": "^1.8",
"mikehaertl/phpwkhtmltopdf": "^2.2",