https://github.com/tom-draper/nginx-analytics
A modern, flexible and privacy-focused analytics solution for Nginx.
https://github.com/tom-draper/nginx-analytics
analytics analyze analyzer api log-analyzer logs nginx nginx-analytics
Last synced: 6 months ago
JSON representation
A modern, flexible and privacy-focused analytics solution for Nginx.
- Host: GitHub
- URL: https://github.com/tom-draper/nginx-analytics
- Owner: tom-draper
- Created: 2025-03-03T10:19:29.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-31T16:29:01.000Z (6 months ago)
- Last Synced: 2025-03-31T17:36:35.149Z (6 months ago)
- Topics: analytics, analyze, analyzer, api, log-analyzer, logs, nginx, nginx-analytics
- Language: TypeScript
- Homepage: https://nginx-analytics.vercel.app
- Size: 822 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nginx Analytics
A modern, flexible and privacy-focused analytics solution for Nginx.
## Getting Started
### Dashboard
#### Option 1: Dashboard
Deploy the dashboard to the same server as Nginx.
Follow the dashboard deployment guide.
#### Option 2: Dashboard + Agent
Deploy the lightweight agent to your server to securely expose your log files to the dashboard, and stream log file content and changes in real-time. Deploy the dashboard anywhere.
Best when server resources are tight, or log files are large.
Follow the agent deployment guide.
#### Option 3: Dashboard + Nginx
Update your Nginx configuration to serve your log files over HTTP as restricted static files. Deploy the dashboard anywhere.
Limited functionality; best if you want to avoid further deployments to your server.
Follow the Nginx configuration guide.
#### Options 4: File Upload
Drag-and-drop your `access.log` and `error.log` directly into the dashboard. Get started straight away on our deployment.
### Configuration
#### Locations
IP-location inference can be set up quickly, utilising MaxMind's free GeoLite2 database. Simply drop the `GeoLite2-Country.mmdb` or `GeoLite2-City.mmdb` file in the root folder of the agent or dashboard deployment.
#### System Monitoring
System resource monitoring for CPU, memory and storage usage is disabled by default. Enable it by setting `NGINX_ANALYTICS_SYSTEM_MONITORING=true` in the environment variables of your agent or dashboard deployment.
#### Authentication
When using the agent, it's recommended to use an auth token, by setting the same private environment variable `NGINX_ANALYTICS_AUTH_TOKEN` for both the agent (server) and the dashboard/CLI (client) deployment.
The agent will check that the auth token provided by the client matches the value it has stored locally before granting access to the logs.
#### Password Protection
If your dashboard is publically accessible, set up password protection by assigning a value to the `NGINX_ANALYTICS_PASSWORD` environment variable for the dashboard deployment.
#### HTTPS
Deploying with HTTPS is always recommended. Without this, you risk exposing any personal information within your log files such as IP addresses.
#### Nginx
Currently this solution only works with the default Nginx log format, but future plans include support for custom formats.
To better configure Nginx to get the most out of your analytics, take a look at the Nginx configuration guide.
## Contributions
Contributions, issues and feature requests are welcome.
- Fork it (https://github.com/tom-draper/nginx-analytics)
- Create your feature branch (`git checkout -b my-new-feature`)
- Commit your changes (`git commit -am 'Add some feature'`)
- Push to the branch (`git push origin my-new-feature`)
- Create a new Pull Request
---
If you find value in my work, consider supporting me.
Buy Me a Coffee: https://www.buymeacoffee.com/tomdraper
PayPal: https://www.paypal.com/paypalme/tomdraper