UUXO/dbbackup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 28 Wiki Activity

docs: remove undocumented --notify flag from README

Browse Source 
The --notify CLI flag was documented but not implemented.
Notifications are configured via environment variables only.
This commit is contained in:
Alexander Renz
2026-01-05 12:35:33 +01:00
parent f29e6fe102
commit 2e942f04a4
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -287,7 +287,6 @@ dbbackup backup single mydb --dry-run
| `--cloud` | Cloud storage URI | - | | `--cloud` | Cloud storage URI | - |
| `--encrypt` | Enable encryption | false | | `--encrypt` | Enable encryption | false |
| `--dry-run, -n` | Run preflight checks only | false | | `--dry-run, -n` | Run preflight checks only | false |
| `--notify` | Enable notifications | false |
| `--debug` | Enable debug logging | false | | `--debug` | Enable debug logging | false |
## Encryption ## Encryption
@@ -438,7 +437,7 @@ dbbackup backup cluster -n # Short flag
## Notifications ## Notifications
Get alerted on backup events via email or webhooks. Get alerted on backup events via email or webhooks. Configure via environment variables.
### SMTP Email ### SMTP Email
@@ -451,8 +450,8 @@ export NOTIFY_SMTP_PASSWORD="secret"
export NOTIFY_SMTP_FROM="dbbackup@example.com" export NOTIFY_SMTP_FROM="dbbackup@example.com"
export NOTIFY_SMTP_TO="admin@example.com,dba@example.com" export NOTIFY_SMTP_TO="admin@example.com,dba@example.com"
# Enable notifications # Run backup (notifications triggered when SMTP is configured)
dbbackup backup single mydb --notify dbbackup backup single mydb
``` ```
### Webhooks ### Webhooks
@@ -465,7 +464,8 @@ export NOTIFY_WEBHOOK_SECRET="signing-secret" # Optional HMAC signing
# Slack webhook # Slack webhook
export NOTIFY_WEBHOOK_URL="https://hooks.slack.com/services/T00/B00/XXX" export NOTIFY_WEBHOOK_URL="https://hooks.slack.com/services/T00/B00/XXX"
dbbackup backup single mydb --notify # Run backup (notifications triggered when webhook is configured)
dbbackup backup single mydb
``` ```
**Webhook payload:** **Webhook payload:**