Skip to content

Commit

Permalink
bump package version
Browse files Browse the repository at this point in the history
This also updates the documentation to mention the new notifier & give examples of the request's body.
  • Loading branch information
shtlrs committed Dec 18, 2023
1 parent b4d752a commit a1ab683
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ like `cron`, or a Kubernetes CronJob.
- [Discord](#discord)
- [Slack](#slack)
- [Telegram](#telegram)
- [Json](#json)
- [Rotation](#rotation)
- [Cooldown](#cooldown)

Expand Down Expand Up @@ -572,6 +573,39 @@ Modern:
![blackbox](https://github.com/lemonsaurus/blackbox/raw/main/img/blackbox_telegram_fail.png)


### Json
- **Notifier Type**: `json`
- **Required fields**: `url`
- YAML will look like this:
```notifiers:
json:
json_1:
url: https://mydomain.com/api/blackbox-notifications
```
**Note**: All notifications are sent as a `POST` request because the data will live within the request's body.

The body of the HTTP request will look like this

```json
{
"backup-data": [
{
"source": "main_postgres",
"success": true,
"output": "",
"backup": [
{
"name": "main_dropbox",
"success": true
}
]
}
]
}
```


## Rotation

By default, `blackbox` will automatically remove all backup files older than 7
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "blackbox-cli"
packages = [
{ include = "blackbox" }
]
version = "v2.3.2"
version = "v2.4.0"
description = "Tool for automatic backups of databases"
authors = ["Leon Sandøy <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit a1ab683

Please sign in to comment.