Revert "feat: make gotify optional (#14)"
All checks were successful
CD / Check changes (push) Successful in 7s
CD / Create tag (push) Successful in 17s
CD / Build and push (amd64) (push) Successful in 28s
CD / Build and push (arm64) (push) Successful in 1m23s
CD / Create manifest (push) Successful in 11s

This reverts commit cd92ce697e.
This commit is contained in:
2025-09-04 20:03:40 +02:00
parent cd92ce697e
commit 0c0305301e
2 changed files with 11 additions and 37 deletions

View File

@@ -1,6 +1,6 @@
# BackupSidecar # BackupSidecar
BackupSidecar is a lightweight backup solution designed to run as a cron job in Kubernetes. It automates backups using Restic and supports both directory and PostgreSQL database backups. Optional notifications can be sent via Gotify to keep you informed of backup results. BackupSidecar is a lightweight backup solution designed to run as a cron job in Kubernetes. It automates backups using Restic and supports both directory and PostgreSQL database backups. Notifications are sent via Gotify to keep you informed of backup results.
## Configuration ## Configuration
@@ -15,10 +15,9 @@ These variables apply to both directory and PostgreSQL backups.
- **`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.
- **`ENABLE_GOTIFY`** _(optional)_ - Enable Gotify notifications. Set to `true` to enable, any other value or unset disables notifications. Defaults to `true`. - **`GOTIFYHOST`** _(required)_ - The Gotify server URL.
- **`GOTIFYHOST`** _(required when ENABLE_GOTIFY=true)_ - The Gotify server URL. - **`GOTIFYTOKEN`** _(required)_ - The API token for Gotify.
- **`GOTIFYTOKEN`** _(required when ENABLE_GOTIFY=true)_ - The API token for Gotify. - **`GOTIFYTOPIC`** _(required)_ - The topic under which backup notifications will be sent.
- **`GOTIFYTOPIC`** _(required when ENABLE_GOTIFY=true)_ - The topic under which backup notifications will be sent.
### Directory Backup ### Directory Backup
@@ -83,8 +82,6 @@ spec:
value: "directory" # or "postgres" value: "directory" # or "postgres"
- name: SOURCEDIR - name: SOURCEDIR
value: "/data/source" value: "/data/source"
- name: ENABLE_GOTIFY
value: "true"
- name: GOTIFYHOST - name: GOTIFYHOST
value: "http://gotify.example.com" value: "http://gotify.example.com"
- name: GOTIFYTOKEN - name: GOTIFYTOKEN
@@ -107,17 +104,10 @@ spec:
## Notifications ## Notifications
The script can send success or failure notifications via Gotify when enabled. To enable notifications, set `ENABLE_GOTIFY=true` and provide the required Gotify configuration variables (`GOTIFYHOST`, `GOTIFYTOKEN`, `GOTIFYTOPIC`). When notifications are disabled, backup status messages are still logged to the console. The script sends success or failure notifications via Gotify.
Example success notification: Example success notification:
``` ```
Backup successful. Snapshot 56ff6a909a44e01f67d2d88f9a76aa713d437809d7ed14a2361e28893f38befb: files new: 1, files changed: 0, data added: 1019 bytes in 0.277535184 sec Backup successful. Snapshot 56ff6a909a44e01f67d2d88f9a76aa713d437809d7ed14a2361e28893f38befb: files new: 1, files changed: 0, data added: 1019 bytes in 0.277535184 sec
``` ```
When Gotify is disabled, you'll see a single message at startup indicating notifications are disabled, followed by normal backup status messages:
```
2024-01-15T10:30:00 - Gotify notifications disabled. Backup status will be logged to console only.
2024-01-15T10:30:05 - Backup successful. Snapshot 56ff6a909a44e01f67d2d88f9a76aa713d437809d7ed14a2361e28893f38befb: files new: 1, files changed: 0, data added: 1019 bytes in 0.277535184 sec
```

View File

@@ -26,17 +26,10 @@ done
####################################### #######################################
# Validate common required environment variables. # Validate common required environment variables.
####################################### #######################################
# Gotify notification settings (optional). # Gotify notification settings.
# Set ENABLE_GOTIFY to "true" to enable notifications, any other value or unset disables them. : "${GOTIFYHOST:?Environment variable GOTIFYHOST is not set}"
ENABLE_GOTIFY="${ENABLE_GOTIFY:-true}" : "${GOTIFYTOKEN:?Environment variable GOTIFYTOKEN is not set}"
: "${GOTIFYTOPIC:?Environment variable GOTIFYTOPIC is not set}"
if [ "$ENABLE_GOTIFY" = "true" ]; then
: "${GOTIFYHOST:?Environment variable GOTIFYHOST is not set (required when ENABLE_GOTIFY=true)}"
: "${GOTIFYTOKEN:?Environment variable GOTIFYTOKEN is not set (required when ENABLE_GOTIFY=true)}"
: "${GOTIFYTOPIC:?Environment variable GOTIFYTOPIC is not set (required when ENABLE_GOTIFY=true)}"
else
log "Gotify notifications disabled. Backup status will be logged to console only."
fi
# Restic encryption password. # Restic encryption password.
: "${RESTIC_PASSWORD:?Environment variable RESTIC_PASSWORD is not set}" : "${RESTIC_PASSWORD:?Environment variable RESTIC_PASSWORD is not set}"
@@ -69,11 +62,9 @@ case "$BACKUP_MODE" in
esac esac
####################################### #######################################
# Build the Gotify URL (only if Gotify is enabled). # Build the Gotify URL.
####################################### #######################################
if [ "$ENABLE_GOTIFY" = "true" ]; then GOTIFYURL="${GOTIFYHOST}/message?token=${GOTIFYTOKEN}"
GOTIFYURL="${GOTIFYHOST}/message?token=${GOTIFYTOKEN}"
fi
####################################### #######################################
# Date format for logging. # Date format for logging.
@@ -96,13 +87,6 @@ log() {
####################################### #######################################
send_notification() { send_notification() {
local message="$1" local message="$1"
# Only send notification if Gotify is enabled
if [ "$ENABLE_GOTIFY" != "true" ]; then
log "$message"
return 0
fi
if ! curl -s -X POST "$GOTIFYURL" -F "title=${GOTIFYTOPIC}" -F "message=${message}" >/dev/null; then if ! curl -s -X POST "$GOTIFYURL" -F "title=${GOTIFYTOPIC}" -F "message=${message}" >/dev/null; then
log "Warning: Failed to send notification with message: ${message}" log "Warning: Failed to send notification with message: ${message}"
fi fi