Installation

This guides you through the installation of npmGrafStats.

See the requirements page for what you will need! A complete installation is available with the docker-compose.yml file.

This instruction presumes that your working directory is /home/docker

pre setup

1. create an influx Organisation called npmgrafstats
2. Create a Bucket called npmgrafstats and a API-Token for npmgrafstats with write access to the bucket
3. Get your GeoLite2-City.mmdb from the geoliteupdate container or download it from maxmind manually to the /home/docker/geolite directory

Set up your credentials, variables and directories

4. Set HOME_IPS to your External/Public IP

5. Set REDIRECTION_LOGS to TRUE for Reverse-Proxy and Redirection logs, to ONLY for only Redirection logs and FALSE for only Reverse-Proxy logs

6. create the monitoringips.txt file and fill it with the IP's of Uptimerobot, Hetrixtools or similar services. (1 IP per row)(This is optional but is recommended if you monitor your domains via http(s) with external services).

7. set your credentials for InfluxDB

8. Start the docker container or docker-compose with adjusted settings

Grafana

8. Add InfluxDB Bucket npmgrafstats as data source into grafana
9. Download the dashboard file (NPM Map Dashboard v2.1.1.json) or import it with the ID: 18826 and set the previously added data source