sascha/backup-monitor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README - mongo 8, JSON push format, remove deprecated query params

Browse source
This commit is contained in:
sascha 2026-04-08 21:46:17 +02:00
parent 8880659862
commit e0e9de0e85
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -2,7 +2,7 @@
A self-hosted backup monitoring dashboard with a premium dark-theme UI, MongoDB backend, and deep integrations for Borgmatic, Uptime Kuma, Prometheus, and webhooks. A self-hosted backup monitoring dashboard with a premium dark-theme UI, MongoDB backend, and deep integrations for Borgmatic, Uptime Kuma, Prometheus, and webhooks.
![Dark Theme](https://img.shields.io/badge/theme-Sentinel%20Dark-0b1326?style=flat-square) ![Python](https://img.shields.io/badge/python-3.12-blue?style=flat-square) ![MongoDB](https://img.shields.io/badge/mongodb-4.4+-green?style=flat-square) ![Tailwind](https://img.shields.io/badge/tailwind-CSS-38bdf8?style=flat-square) ![Dark Theme](https://img.shields.io/badge/theme-Sentinel%20Dark-0b1326?style=flat-square) ![Python](https://img.shields.io/badge/python-3.12-blue?style=flat-square) ![MongoDB](https://img.shields.io/badge/mongodb-8-green?style=flat-square) ![Tailwind](https://img.shields.io/badge/tailwind-CSS-38bdf8?style=flat-square)
## Features ## Features
@ -49,7 +49,7 @@ services:
- mongo - mongo
mongo: mongo:
image: mongo:4.4 # Use 7+ if your CPU supports AVX image: mongo:8
container_name: backup-mongo container_name: backup-mongo
restart: always restart: always
volumes: volumes:
@ -65,7 +65,9 @@ After each backup, send a POST request:
```bash ```bash
# Minimal push # Minimal push
curl -X POST "http://localhost:9999/api/push?host=myserver&status=ok" curl -X POST -H "Content-Type: application/json" \
-d '{"host":"myserver","status":"ok"}' \
http://localhost:9999/api/push
# Full push with stats # Full push with stats
curl -X POST -H "Content-Type: application/json" \ curl -X POST -H "Content-Type: application/json" \
@ -82,8 +84,9 @@ curl -X POST -H "Content-Type: application/json" \
http://localhost:9999/api/push http://localhost:9999/api/push
# With API key # With API key
curl -X POST -H "X-API-Key: your-key" \ curl -X POST -H "X-API-Key: your-key" -H "Content-Type: application/json" \
"http://localhost:9999/api/push?host=myserver&status=ok" -d '{"host":"myserver","status":"ok"}' \
http://localhost:9999/api/push
``` ```
### Borgmatic Integration ### Borgmatic Integration