wagesj45/ngxstat
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update requirements and AGENTS instructions

Browse source
This commit is contained in:
Jordan Wages 2025-07-17 00:17:46 -05:00
commit d216433a07
6 changed files with 153 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,4 +1,25 @@
# ngxstat
Per-domain Nginx log analytics with hybrid static reports and live insights.
##
## Generating Reports
Use the `generate_reports.py` script to build aggregated JSON and HTML files from `database/ngxstat.db`.
Create a virtual environment and install dependencies:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
Then run one or more of the interval commands:
```bash
python scripts/generate_reports.py hourly
python scripts/generate_reports.py daily
python scripts/generate_reports.py weekly
python scripts/generate_reports.py monthly
```
Reports are written under the `output/` directory. Each command updates the corresponding `<interval>.json` file and produces an HTML dashboard using Chart.js.