examples corrected
This commit is contained in:
parent
d767346345
commit
34123becd0
2 changed files with 20 additions and 34 deletions
20
README.md
20
README.md
|
|
@ -229,8 +229,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "slack-alerts",
|
"name": "slack-alerts",
|
||||||
"type": "slack",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "slack",
|
||||||
"webhookUrl": "${SLACK_WEBHOOK_URL}",
|
"webhookUrl": "${SLACK_WEBHOOK_URL}",
|
||||||
"channel": "#backups",
|
"channel": "#backups",
|
||||||
"username": "zerobyte",
|
"username": "zerobyte",
|
||||||
|
|
@ -242,8 +242,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "email-admin",
|
"name": "email-admin",
|
||||||
"type": "email",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "email",
|
||||||
"smtpHost": "smtp.example.com",
|
"smtpHost": "smtp.example.com",
|
||||||
"smtpPort": 587,
|
"smtpPort": 587,
|
||||||
"username": "admin@example.com",
|
"username": "admin@example.com",
|
||||||
|
|
@ -258,8 +258,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "discord-backups",
|
"name": "discord-backups",
|
||||||
"type": "discord",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "discord",
|
||||||
"webhookUrl": "${DISCORD_WEBHOOK_URL}",
|
"webhookUrl": "${DISCORD_WEBHOOK_URL}",
|
||||||
"username": "zerobyte",
|
"username": "zerobyte",
|
||||||
"avatarUrl": "https://example.com/avatar.png",
|
"avatarUrl": "https://example.com/avatar.png",
|
||||||
|
|
@ -271,8 +271,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "gotify-notify",
|
"name": "gotify-notify",
|
||||||
"type": "gotify",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "gotify",
|
||||||
"serverUrl": "https://gotify.example.com",
|
"serverUrl": "https://gotify.example.com",
|
||||||
"token": "${GOTIFY_TOKEN}",
|
"token": "${GOTIFY_TOKEN}",
|
||||||
"path": "/message",
|
"path": "/message",
|
||||||
|
|
@ -284,8 +284,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "ntfy-notify",
|
"name": "ntfy-notify",
|
||||||
"type": "ntfy",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "ntfy",
|
||||||
"serverUrl": "https://ntfy.example.com",
|
"serverUrl": "https://ntfy.example.com",
|
||||||
"topic": "zerobyte-backups",
|
"topic": "zerobyte-backups",
|
||||||
"priority": "high",
|
"priority": "high",
|
||||||
|
|
@ -298,8 +298,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "pushover-notify",
|
"name": "pushover-notify",
|
||||||
"type": "pushover",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "pushover",
|
||||||
"userKey": "${PUSHOVER_USER_KEY}",
|
"userKey": "${PUSHOVER_USER_KEY}",
|
||||||
"apiToken": "${PUSHOVER_API_TOKEN}",
|
"apiToken": "${PUSHOVER_API_TOKEN}",
|
||||||
"devices": "phone,tablet",
|
"devices": "phone,tablet",
|
||||||
|
|
@ -311,8 +311,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "telegram-notify",
|
"name": "telegram-notify",
|
||||||
"type": "telegram",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "telegram",
|
||||||
"botToken": "${TELEGRAM_BOT_TOKEN}",
|
"botToken": "${TELEGRAM_BOT_TOKEN}",
|
||||||
"chatId": "123456789"
|
"chatId": "123456789"
|
||||||
}
|
}
|
||||||
|
|
@ -322,8 +322,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "custom-shoutrrr",
|
"name": "custom-shoutrrr",
|
||||||
"type": "custom",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "custom",
|
||||||
"shoutrrrUrl": "${SHOUTRRR_URL}"
|
"shoutrrrUrl": "${SHOUTRRR_URL}"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -331,8 +331,8 @@ Secrets/credentials in the config file can reference environment variables using
|
||||||
|
|
||||||
- **Fields:**
|
- **Fields:**
|
||||||
- `name`: Unique name for the notification config
|
- `name`: Unique name for the notification config
|
||||||
- `type`: Notification type (email, slack, discord, gotify, ntfy, pushover, telegram, custom)
|
- `config.type`: Notification type (email, slack, discord, gotify, ntfy, pushover, telegram, custom)
|
||||||
- `config`: Type-specific config, secrets via `${ENV_VAR}`
|
- `config`: Type-specific config with `type` field, secrets via `${ENV_VAR}`
|
||||||
|
|
||||||
##### Admin Setup (Automated)
|
##### Admin Setup (Automated)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -45,19 +45,6 @@
|
||||||
"readOnly": false,
|
"readOnly": false,
|
||||||
"ssl": true
|
"ssl": true
|
||||||
}
|
}
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "sftp-volume",
|
|
||||||
"config": {
|
|
||||||
"backend": "sftp",
|
|
||||||
"host": "sftp.example.com",
|
|
||||||
"port": 22,
|
|
||||||
"username": "user",
|
|
||||||
"password": "${SFTP_PASSWORD}",
|
|
||||||
"privateKey": "${SFTP_PRIVATE_KEY}",
|
|
||||||
"path": "/data",
|
|
||||||
"readOnly": false
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"repositories": [
|
"repositories": [
|
||||||
|
|
@ -123,8 +110,7 @@
|
||||||
"backend": "sftp",
|
"backend": "sftp",
|
||||||
"host": "sftp.example.com",
|
"host": "sftp.example.com",
|
||||||
"port": 22,
|
"port": 22,
|
||||||
"username": "user",
|
"user": "sftpuser",
|
||||||
"password": "${SFTP_PASSWORD}",
|
|
||||||
"privateKey": "${SFTP_PRIVATE_KEY}",
|
"privateKey": "${SFTP_PRIVATE_KEY}",
|
||||||
"path": "/backups"
|
"path": "/backups"
|
||||||
}
|
}
|
||||||
|
|
@ -139,14 +125,14 @@
|
||||||
"includePatterns": ["important-folder"],
|
"includePatterns": ["important-folder"],
|
||||||
"excludePatterns": ["*.tmp", "*.log"],
|
"excludePatterns": ["*.tmp", "*.log"],
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"notifications": ["slack-alerts", "email-admin", "discord-backups", "gotify-notify", "ntfy-notify", "pushover-notify", "telegram-notify", "custom-shoutrrr"]
|
"notifications": ["slack-alerts"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"notificationDestinations": [
|
"notificationDestinations": [
|
||||||
{
|
{
|
||||||
"name": "slack-alerts",
|
"name": "slack-alerts",
|
||||||
"type": "slack",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "slack",
|
||||||
"webhookUrl": "${SLACK_WEBHOOK_URL}",
|
"webhookUrl": "${SLACK_WEBHOOK_URL}",
|
||||||
"channel": "#backups",
|
"channel": "#backups",
|
||||||
"username": "zerobyte",
|
"username": "zerobyte",
|
||||||
|
|
@ -155,8 +141,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "email-admin",
|
"name": "email-admin",
|
||||||
"type": "email",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "email",
|
||||||
"smtpHost": "smtp.example.com",
|
"smtpHost": "smtp.example.com",
|
||||||
"smtpPort": 587,
|
"smtpPort": 587,
|
||||||
"username": "admin@example.com",
|
"username": "admin@example.com",
|
||||||
|
|
@ -168,8 +154,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "discord-backups",
|
"name": "discord-backups",
|
||||||
"type": "discord",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "discord",
|
||||||
"webhookUrl": "${DISCORD_WEBHOOK_URL}",
|
"webhookUrl": "${DISCORD_WEBHOOK_URL}",
|
||||||
"username": "zerobyte",
|
"username": "zerobyte",
|
||||||
"avatarUrl": "https://example.com/avatar.png",
|
"avatarUrl": "https://example.com/avatar.png",
|
||||||
|
|
@ -178,8 +164,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "gotify-notify",
|
"name": "gotify-notify",
|
||||||
"type": "gotify",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "gotify",
|
||||||
"serverUrl": "https://gotify.example.com",
|
"serverUrl": "https://gotify.example.com",
|
||||||
"token": "${GOTIFY_TOKEN}",
|
"token": "${GOTIFY_TOKEN}",
|
||||||
"path": "/message",
|
"path": "/message",
|
||||||
|
|
@ -188,8 +174,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "ntfy-notify",
|
"name": "ntfy-notify",
|
||||||
"type": "ntfy",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "ntfy",
|
||||||
"serverUrl": "https://ntfy.example.com",
|
"serverUrl": "https://ntfy.example.com",
|
||||||
"topic": "zerobyte-backups",
|
"topic": "zerobyte-backups",
|
||||||
"priority": "high",
|
"priority": "high",
|
||||||
|
|
@ -199,8 +185,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "pushover-notify",
|
"name": "pushover-notify",
|
||||||
"type": "pushover",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "pushover",
|
||||||
"userKey": "${PUSHOVER_USER_KEY}",
|
"userKey": "${PUSHOVER_USER_KEY}",
|
||||||
"apiToken": "${PUSHOVER_API_TOKEN}",
|
"apiToken": "${PUSHOVER_API_TOKEN}",
|
||||||
"devices": "phone,tablet",
|
"devices": "phone,tablet",
|
||||||
|
|
@ -209,16 +195,16 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "telegram-notify",
|
"name": "telegram-notify",
|
||||||
"type": "telegram",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "telegram",
|
||||||
"botToken": "${TELEGRAM_BOT_TOKEN}",
|
"botToken": "${TELEGRAM_BOT_TOKEN}",
|
||||||
"chatId": "123456789"
|
"chatId": "123456789"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "custom-shoutrrr",
|
"name": "custom-shoutrrr",
|
||||||
"type": "custom",
|
|
||||||
"config": {
|
"config": {
|
||||||
|
"type": "custom",
|
||||||
"shoutrrrUrl": "${SHOUTRRR_URL}"
|
"shoutrrrUrl": "${SHOUTRRR_URL}"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue