Skip to content

Commit

Permalink
update README for release 1.2.20.
Browse files Browse the repository at this point in the history
  • Loading branch information
jonhadfield committed Oct 8, 2024
1 parent 5b9d8b4 commit d0cd4cb
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,11 @@ export GIT_REQUEST_TIMEOUT=600
## notifications

### Telegram
*(since release 1.2.20)*
*(since release 1.2.20)*
To send a Telegram message on completion, set the environment variables:
`SOBA_TELEGRAM_BOT_TOKEN` with the bot token
`SOBA_TELEGRAM_CHAT_ID` with the chat/group id

To get the bot token:
- send a message to @BotFather of /newbot
- submit a name, e.g. soba-notifier
Expand All @@ -192,8 +193,8 @@ To get the chat id:
- record the chat id in the response

### Slack
*(since release 1.2.16)*
To send a Slack message on completion, set the environment variables:
*(since release 1.2.16)*
To send a Slack message on completion, set the environment variables:
`SLACK_CHANNEL_ID` with the channel id
`SLACK_API_TOKEN` with the token for the Slack app
For example:
Expand Down Expand Up @@ -250,7 +251,7 @@ run soba and direct output:

### rotation

[Logrotate](https://linux.die.net/man/8/logrotate) is a utility that comes with most Linux distributions and removes and/or compresses messages older than a certain number of hours or days.
[Logrotate](https://linux.die.net/man/8/logrotate) is a utility that comes with most Linux distributions and removes and/or compresses messages older than a certain number of hours or days.
This example assumes you persist the log file to /var/log/soba/soba.log
create a file in /etc/logrotate.d/soba with the following content:

Expand Down Expand Up @@ -285,7 +286,7 @@ ensure the user running soba has an entry in `/etc/cron.allow`.

run `crontab -e`

add the following (assuming you have a user called soba with a script to run it called backup in their home directory):
add the following (assuming you have a user called soba with a script to run it called backup in their home directory):
`* * * * * /usr/bin/flock -n /tmp/soba.lockfile /home/soba/backup >> /var/log/soba/soba.log 2>&1`

note: A useful tool for testing cron jobs is [crontab guru](https://crontab.guru/).
Expand Down

0 comments on commit d0cd4cb

Please sign in to comment.