Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GilbN authored Aug 8, 2024
1 parent 70c58fd commit 9650ec6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A python script that will parse the nginx access.log and send geolocation metric

![](https://i.imgur.com/mh0IhYA.jpg)

### For the linuxserver/letsencrypt docker mod, click here : https://github.com/gilbN/lsio-docker-mods/tree/master/letsencrypt/geoip2-nginx-stats
### For the linuxserver/letsencrypt docker mod, click here : https://github.com/linuxserver/docker-mods/tree/swag-geoip2influx

***

Expand All @@ -36,6 +36,7 @@ Add the ones that differ on your system.
| SEND_NGINX_LOGS | true | Set to `false` to disable nginx logs. Optional, defaults to `true`. |
| GEOIP2INFLUX_LOG_LEVEL | info | Sets the log level in geoip2influx.log. Use `debug` for verbose logging Optional, defaults to info. |
| GEOIP2INFLUX_LOG_PATH | /config/log/geoip2influx/geoip2influx.log | Optional. Defaults to example. |
| GEOIP_DB_PATH | /config/geoip2db/GeoLite2-City.mmdb | Optional. Defaults to example. |
| INFLUX_RETENTION | 7d | Sets the retention for the database. Optional, defaults to example.|
| INFLUX_SHARD | 1d | Set the shard for the database. Optional, defaults to example. |
| MAXMINDDB_LICENSE_KEY | xxxxxxx | Add your Maxmind licence key |
Expand Down Expand Up @@ -151,7 +152,9 @@ Then use the `/config/log/nginx/access.log` file in the `NGINX_LOG_PATH` variabl

## Updates

**xx.xx.24** - Refactor to alpine 3.20. New env required. MAXMINDDB_USER_ID.
**06.08.24** - Complete refactor of the python code. Deprecate the old geoip2influx.py file.

**28.07.24** - Refactor to alpine 3.20. New env required. MAXMINDDB_USER_ID.

**21.06.20** - Added $host(domain) to the nginx log metrics. This will break your nginx logs parsing, as you need to update the custom log format.

Expand Down

0 comments on commit 9650ec6

Please sign in to comment.