From ba63df67c3b234be709da44e564c105cc07ffb5e Mon Sep 17 00:00:00 2001 From: Timo Behrendt Date: Tue, 4 Feb 2025 21:33:31 +0100 Subject: [PATCH] reformat readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b982010..8321b91 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,31 @@ BackupSidecar is configured through environment variables. Below is a breakdown These variables apply to both directory and PostgreSQL backups. -- **`BACKUP_MODE`** _(optional)_ – Defines the backup type (`directory` or `postgres`). Defaults to `directory`. -- **`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_REST_USERNAME`** _(optional)_ – The username for REST server authentication. -- **`RESTIC_REST_PASSWORD`** _(optional)_ – The password for REST server authentication. -- **`GOTIFYHOST`** _(required)_ – The Gotify server URL. -- **`GOTIFYTOKEN`** _(required)_ – The API token for Gotify. -- **`GOTIFYTOPIC`** _(required)_ – The topic under which backup notifications will be sent. +- **`BACKUP_MODE`** _(optional)_ - Defines the backup type (`directory` or `postgres`). Defaults to `directory`. +- **`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_REST_USERNAME`** _(optional)_ - The username for REST server authentication. +- **`RESTIC_REST_PASSWORD`** _(optional)_ - The password for REST server authentication. +- **`GOTIFYHOST`** _(required)_ - The Gotify server URL. +- **`GOTIFYTOKEN`** _(required)_ - The API token for Gotify. +- **`GOTIFYTOPIC`** _(required)_ - The topic under which backup notifications will be sent. ### Directory Backup 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 For `postgres` mode, the following database-related variables are required: -- **`PGHOST`** _(required)_ – The hostname of the PostgreSQL server. -- **`PGDATABASE`** _(required)_ – The name of the database to back up. -- **`PGUSER`** _(required)_ – The PostgreSQL username. -- **`PGPORT`** _(optional)_ – The port for PostgreSQL (defaults to `5432`). -- **`PGPASSWORD`** _(optional)_ – The password for authentication. Setting this prevents interactive prompts. -- **`PG_DUMP_ARGS`** _(optional)_ – Additional flags for `pg_dump`. +- **`PGHOST`** _(required)_ - The hostname of the PostgreSQL server. +- **`PGDATABASE`** _(required)_ - The name of the database to back up. +- **`PGUSER`** _(required)_ - The PostgreSQL username. +- **`PGPORT`** _(optional)_ - The port for PostgreSQL (defaults to `5432`). +- **`PGPASSWORD`** _(optional)_ - The password for authentication. Setting this prevents interactive prompts. +- **`PG_DUMP_ARGS`** _(optional)_ - Additional flags for `pg_dump`. ## Dependencies