t.behrendt/backupsidecar
1
0
Fork 0
Code Issues 4 Pull Requests 3 Actions Packages Activity

reformat readme
All checks were successful
Build and Release Docker Image / Build and Push amd64 (push) Successful in 22s
Details
Build and Release Docker Image / Build and Push arm64 (push) Successful in 45s
Details
Build and Release Docker Image / Create and Push Multi-Arch Manifest (push) Successful in 18s
Details

Browse Source
This commit is contained in:
Timo Behrendt
2025-02-04 21:33:31 +01:00
parent 2070e56db5
commit ba63df67c3
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -10,31 +10,31 @@ BackupSidecar is configured through environment variables. Below is a breakdown
These variables apply to both directory and PostgreSQL backups. These variables apply to both directory and PostgreSQL backups.
- **`BACKUP_MODE`** _(optional)_ – Defines the backup type (`directory` or `postgres`). Defaults to `directory`. - **`BACKUP_MODE`** _(optional)_ - Defines the backup type (`directory` or `postgres`). Defaults to `directory`.
- **`RESTIC_PASSWORD`** _(required)_ – The encryption password for Restic. - **`RESTIC_PASSWORD`** _(required)_ - The encryption password for Restic.
- **`RESTIC_REPOSITORY`** _(required)_ – The URI of the Restic repository (e.g., `rest:http://your-rest-server:8000/backup`). - **`RESTIC_REPOSITORY`** _(required)_ - The URI of the Restic repository (e.g., `rest:http://your-rest-server:8000/backup`).
- **`RESTIC_REST_USERNAME`** _(optional)_ – The username for REST server authentication. - **`RESTIC_REST_USERNAME`** _(optional)_ - The username for REST server authentication.
- **`RESTIC_REST_PASSWORD`** _(optional)_ – The password for REST server authentication. - **`RESTIC_REST_PASSWORD`** _(optional)_ - The password for REST server authentication.
- **`GOTIFYHOST`** _(required)_ – The Gotify server URL. - **`GOTIFYHOST`** _(required)_ - The Gotify server URL.
- **`GOTIFYTOKEN`** _(required)_ – The API token for Gotify. - **`GOTIFYTOKEN`** _(required)_ - The API token for Gotify.
- **`GOTIFYTOPIC`** _(required)_ – The topic under which backup notifications will be sent. - **`GOTIFYTOPIC`** _(required)_ - The topic under which backup notifications will be sent.
### Directory Backup ### Directory Backup
When running in `directory` mode, the following variable must be set: When running in `directory` mode, the following variable must be set:
- **`SOURCEDIR`** _(required)_ – The path of the directory to be backed up. - **`SOURCEDIR`** _(required)_ - The path of the directory to be backed up.
### PostgreSQL Backup ### PostgreSQL Backup
For `postgres` mode, the following database-related variables are required: For `postgres` mode, the following database-related variables are required:
- **`PGHOST`** _(required)_ – The hostname of the PostgreSQL server. - **`PGHOST`** _(required)_ - The hostname of the PostgreSQL server.
- **`PGDATABASE`** _(required)_ – The name of the database to back up. - **`PGDATABASE`** _(required)_ - The name of the database to back up.
- **`PGUSER`** _(required)_ – The PostgreSQL username. - **`PGUSER`** _(required)_ - The PostgreSQL username.
- **`PGPORT`** _(optional)_ – The port for PostgreSQL (defaults to `5432`). - **`PGPORT`** _(optional)_ - The port for PostgreSQL (defaults to `5432`).
- **`PGPASSWORD`** _(optional)_ – The password for authentication. Setting this prevents interactive prompts. - **`PGPASSWORD`** _(optional)_ - The password for authentication. Setting this prevents interactive prompts.
- **`PG_DUMP_ARGS`** _(optional)_ – Additional flags for `pg_dump`. - **`PG_DUMP_ARGS`** _(optional)_ - Additional flags for `pg_dump`.
## Dependencies ## Dependencies