feat: add more info about web services

This commit is contained in:
2025-11-12 15:05:42 +01:00
parent c2f2ba4e7c
commit 871d80285e

View File

@@ -89,6 +89,24 @@ the following actions:
- Restore
- Integrity check
## Using web interface
Head to http://<host>:3000, you'll have a dashboard to manage your dumps.
You're responsible of authentication and TLS, these are not automatically
set up by this tool. I recommend running behind a reverse proxy such as
*Traefik* to handle basic auth middleware, and *Let's Encrypt* certificates.
An orther solution would be to use a tool like *Authelia* to secure access.
## Using API
Available API commands are:
| Endpoint | Method | Arguments | Response |
| --- | --- | --- | --- |
| /list | GET | nil | Job List |
| /dump | POST | `{id=<job id>}` | Backup Job Result |
| /restore | POST | `{id=<job id>}` | Restore Job Result |
| /check-integrity | POST | `{id=<job id>}` | Job Integrity Status |
# Building yourself
There is a `Justfile` (*Makefile* alternative), which produces a *Docker* image, so this is pretty simple:
```bash