diff --git a/README.md b/README.md index b92bc92..0818653 100644 --- a/README.md +++ b/README.md @@ -153,22 +153,22 @@ export GIT_BACKUP_INTERVAL=45m ``` note: -- if you don't specify the trailing 'm' or 'h' then hours are assumed. -- the interval is added to the start of the last backup and not the time it finished, therefore ensure the interval is greater than the duration of a backup. +- if you don't specify the trailing 'm' or 'h' then hours are assumed. +- the interval is added to the start of the last backup and not the time it finished, therefore ensure the interval is greater than the duration of a backup. ## rotating backups A new bundle is created every time a change is detected in the repository. To keep only the _x_ most recent, use the -following provider specific environment variables: -`GITEA_BACKUPS=x` -`GITHUB_BACKUPS=x` -`GITLAB_BACKUPS=x` -`BITBUCKET_BACKUPS=x` +following provider specific environment variables: +`GITEA_BACKUPS=x` +`GITHUB_BACKUPS=x` +`GITLAB_BACKUPS=x` +`BITBUCKET_BACKUPS=x` ## setting the request timeout -By default, soba will wait up to five minutes for a response to complete. This could be anything from an API call to discover repositories to a clone of a large repository. -If you have a slow connection or very large repositories, you may want to increase this. To do so, set the environment variable `GIT_REQUEST_TIMEOUT` to the number of seconds you wish to wait. For example, to wait up to ten minutes: +By default, soba will wait up to five minutes for a response to complete. This could be anything from an API call to discover repositories to a clone of a large repository. +If you have a slow connection or very large repositories, you may want to increase this. To do so, set the environment variable `GIT_REQUEST_TIMEOUT` to the number of seconds you wish to wait. For example, to wait up to ten minutes: ```bash export GIT_REQUEST_TIMEOUT=600 ``` @@ -177,18 +177,18 @@ export GIT_REQUEST_TIMEOUT=600 ### Telegram *(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 -- submit a username for the bot -- record bot token -To get the chat id: -- add the bot user to the group (get group info and click Add) -- run command:`curl -s -X POST https://api.telegram.org/bot/getUpdates` -- record the chat id in the response +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 +- submit a username for the bot +- record bot token +To get the chat id: +- add the bot user to the group (get group info and click Add) +- run command:`curl -s -X POST https://api.telegram.org/bot/getUpdates` +- record the chat id in the response ### Slack *(since release 1.2.16)* @@ -221,17 +221,17 @@ You can see a sample [here](examples/webhook-short.json). > NOTE: The long format webhook will contain a list of your repos and, if there's an error, may contain other details including URLs. Please keep this in mind when sending to endpoints that may be insecure. ### ntfy -*(since release 1.2.10)* -ntfy is a popular service that enables push notifications for desktop and mobile apps. -To send a message on completion of a run: set the environment variable `SOBA_NTFY_URL` with the url of the endpoint. -For example: +*(since release 1.2.10)* +ntfy is a popular service that enables push notifications for desktop and mobile apps. +To send a message on completion of a run: set the environment variable `SOBA_NTFY_URL` with the url of the endpoint. +For example: `$ export SOBA_NTFY_URL=https://ntfy.sh/example-topic` ## logging ### persistence -Messages are written to stdout and can be persisted by directing to a file, e.g. +Messages are written to stdout and can be persisted by directing to a file, e.g. `soba > soba.log` #### logging to /var/log/soba