Make project docs and integration test generic

This commit is contained in:
Codex
2026-07-15 01:07:22 +02:00
parent 398c1ae6c3
commit ca0269a146
7 changed files with 171 additions and 98 deletions
+16 -17
View File
@@ -34,7 +34,7 @@ The web app listens on `0.0.0.0:8080`.
- delete files with `deletefile`;
- remove empty per-backup folders with `rmdir`.
- Never delete a local archive unless upload completed and the remote object was verified.
- Mock `pvesh` and `rclone` in automated tests. Manual integration testing is limited to `scripts/integration-test-adguard.sh`.
- Mock `pvesh` and `rclone` in automated tests. Manual integration testing is limited to `scripts/integration-test.sh` and must only run when the user explicitly asks for a real backup test.
## Runtime data
@@ -44,17 +44,20 @@ SQLite database:
/opt/pve-cloud-backup/data/app.db
```
Current important settings live in SQLite, not files. Common live values on this node have included:
Important runtime settings live in SQLite, not files:
- Proxmox node: `astrid`
- Proxmox storage: `hitachi`
- local dump path: `/mnt/pve/hitachi/dump`
- rclone remote: `onedrive`
- remote path: `pve-cloud-backup`
- timezone: `Europe/Berlin`
- manual test guest: `adguard`, VMID `110`, type `lxc`
- Proxmox node
- Proxmox backup storage
- local dump directory
- rclone executable path
- rclone remote name
- remote path inside that rclone remote
- timezone
- retention defaults
- Discord webhook URL
- CORS origins
Do not hardcode those into normal app behavior. They are local operational context.
Treat all node names, storage names, guest names, VMIDs, rclone remotes, and filesystem paths as operator-specific runtime data. Do not hardcode deployment-specific values in application code or publish-facing docs.
## Backend map
@@ -187,25 +190,21 @@ curl -fsS http://127.0.0.1:8080/api/backups | python3 -m json.tool
Manual integration test:
```bash
API_URL=http://127.0.0.1:8080 /opt/pve-cloud-backup/scripts/integration-test-adguard.sh
INTEGRATION_VMID=<vmid> API_URL=http://127.0.0.1:8080 /opt/pve-cloud-backup/scripts/integration-test.sh
```
Only run the manual integration test when the user explicitly wants a real Proxmox/rclone backup test.
## Git workflow
Remote:
```text
origin ssh://gitea@gitea.reversed.dev:2222/space/pve-cloud-backups.git
```
Default branch:
```text
main
```
Do not document private deployment remotes, hostnames, or organization names in committed files. Local git remotes belong in `.git/config`, not project documentation.
Before committing, check:
```bash