diff --git a/CHANGELOG.md b/CHANGELOG.md index 80de00d..68bdd0a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +## [2.2.1-rc.1](https://github.com/AnotherStranger/docker-borg-backup/compare/v2.2.0...v2.2.1-rc.1) (2023-12-13) + + +### Code Refactoring + +* **docs:** :memo: update documentation for BORG_AUTHORIZED_KEYS ([d0ba5ca](https://github.com/AnotherStranger/docker-borg-backup/commit/d0ba5ca8eac5550d7f5e2629d07070b0da094cb9)) +* :recycle: keep old way of adding authorized keys in docker-compose.yml ([607bdea](https://github.com/AnotherStranger/docker-borg-backup/commit/607bdea704e52e976f805dbbfb27c7d2af0803f7)) + ## [2.2.0](https://github.com/AnotherStranger/docker-borg-backup/compare/v2.1.4...v2.2.0) (2023-12-13) diff --git a/README.md b/README.md index bff0c3c..8e12eb0 100644 --- a/README.md +++ b/README.md @@ -60,12 +60,12 @@ volumes: ### Environment variables -| Variable | Description | Example | -|------------------------------|-----------------------------------------------------------------------------------|------------------------| -| `BORG_AUTHORIZED_KEYS` | Public ssh keys for backups. Use either this Variable or the authorized_key file. | `\n` | -| `BORG_UID` | UID for the backup user. | `1000` | -| `BORG_GID` | GID for the backup user. | `1000` | -| `BORG_SERVE_ADDITIONAL_ARGS` | Additional CMD args to borg serve | `--append-only` | +| Variable | Description | Example | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------| +| `BORG_AUTHORIZED_KEYS` | Public ssh keys for backups. Use either this Variable or the authorized_key file. May contain comment lines starting with `#` | `\n` | +| `BORG_UID` | UID for the backup user. | `1000` | +| `BORG_GID` | GID for the backup user. | `1000` | +| `BORG_SERVE_ADDITIONAL_ARGS` | Additional CMD args to borg serve | `--append-only` | ### Important Notes diff --git a/docker-compose.yml b/docker-compose.yml index b531815..3475f10 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -8,8 +8,13 @@ services: image: horaceworblehat/borg-server environment: - # Specify you public ssh keys here. Separate keys by adding \n - BORG_AUTHORIZED_KEYS: "key_one\nkey_two" + # Specify you public ssh keys here. You can also separate keys by adding \n + BORG_AUTHORIZED_KEYS: | + # comment + key_one + # another comment + key_two + # BORG_AUTHORIZED_KEYS: key_one\nkey_two BORG_SERVE_ADDITIONAL_ARGS: "--storage-quota 900G --append-only" BORG_UID: "1000" BORG_GID: "1000"