diff --git a/README.md b/README.md index bc0f56c..933d5ec 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# grafana-dashboard +# Grafana Provisioning Dashboards -Provisioned Grafana dashboards exported from TrueNAS \ No newline at end of file +This repository stores the JSON dashboards that TrueNAS Grafana loads via provisioning. + +## Directory structure + +- `HomeLab/` — dashboards for services in the HomeLab folder. +- `GBarmUB/` — dashboards for the GBarmUB folder. +- `prometheus-2-0-stats.json` — dashboard kept in the root folder. + +## Workflow + +1. Modify dashboards in Grafana and export via the API or provisioning scripts. +2. Save updates into this directory structure. +3. Commit and push changes so Grafana provisioning always matches Git. + +## Sync commands + +``` +cd /mnt/RAID10/Apps/obs/grafana/provisioning +# Pull latest changes from remote +git pull --rebase +# Stage and commit local updates +git add . +git commit -m "Update dashboards" +# Push to Gitea remote +git push +``` + +Provisioning is enabled via `/usr/share/grafana/conf/custom.ini`, which is bind-mounted from `/mnt/RAID10/Apps/obs/grafana/conf/custom.ini`.