4 Commits

Author SHA1 Message Date
19456b3e4c Update README.md 2025-11-12 14:06:28 +00:00
871d80285e feat: add more info about web services 2025-11-12 15:05:42 +01:00
c2f2ba4e7c feat: update README 2025-11-12 14:47:51 +01:00
d9137ac281 feat: remove compose example now in README 2025-11-12 14:46:51 +01:00
3 changed files with 18 additions and 11 deletions

1
.gitignore vendored
View File

@@ -1,5 +1,4 @@
backups
./config.yaml
compose.yaml
ddbb
main

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

View File

@@ -1,10 +0,0 @@
services:
ddbb:
image: ramiuslr/ddbb:latest
container_name: ddbb
restart: always
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- ./backup:/backup
ports:
- 12345:12345