diff --git a/README.md b/README.md index 02deb566..ad272f98 100644 --- a/README.md +++ b/README.md @@ -374,7 +374,7 @@ https://api.slack.com/apps/APP_ID/oauth?). To enable Discord integration, you will need to: -* register a new application on https://discordapp.com/developers/applications/me +* Register a new application on https://discordapp.com/developers/applications/me * add a redirect URI to your Discord application. The URI format is `SITE_ROOT/integrations/add_discord/`. For example, if you are running a development server on `localhost:8000` then the redirect URI would be @@ -387,16 +387,7 @@ To enable Discord integration, you will need to: ### Pushover Pushover integration works by creating an application on Pushover.net which -is then subscribed to by Healthchecks users. The registration workflow is as follows: - -* On Healthchecks, the user adds a "Pushover" integration to a project -* Healthchecks redirects user's browser to a Pushover.net subscription page -* User approves adding the Healthchecks subscription to their Pushover account -* Pushover.net HTTP redirects back to Healthchecks with a subscription token -* Healthchecks saves the subscription token and uses it for sending Pushover - notifications - -To enable the Pushover integration, you will need to: +is then subscribed to by Healthchecks users. To enable the Pushover integration, you will need to: * Register a new application on Pushover via https://pushover.net/apps/build. * Within the Pushover 'application' configuration, enable subscriptions. @@ -407,6 +398,16 @@ To enable the Pushover integration, you will need to: `PUSHOVER_API_TOKEN` and `PUSHOVER_SUBSCRIPTION_URL` environment variables. The Pushover subscription URL should look similar to `https://pushover.net/subscribe/yourAppName-randomAlphaNumericData`. + +The registration workflow is as follows: + +* On Healthchecks, the user adds a "Pushover" integration to a project +* Healthchecks redirects user's browser to a Pushover.net subscription page +* User approves adding the Healthchecks subscription to their Pushover account +* Pushover.net HTTP redirects back to Healthchecks with a subscription token +* Healthchecks saves the subscription token and uses it for sending Pushover + notifications + ### Signal @@ -444,11 +445,11 @@ scheme. To enable Apprise integration, you will need to: -* ensure you have apprise installed in your local environment: +* Ensure you have apprise installed in your local environment: ```bash pip install apprise ``` -* enable the apprise functionality by setting the `APPRISE_ENABLED` environment variable. +* Enable the apprise functionality by setting the `APPRISE_ENABLED` environment variable. ### Shell Commands diff --git a/templates/docs/configuring_notifications.html b/templates/docs/configuring_notifications.html index fcedaeb4..e4496717 100644 --- a/templates/docs/configuring_notifications.html +++ b/templates/docs/configuring_notifications.html @@ -20,6 +20,115 @@ methods are active for each check. You can click the icons to toggle them on and
You can also toggle the integrations by clicking the "ON" / "OFF" labels in individual check's details pages:
+To enable the Slack "self-service" integration, you will need to create a "Slack App".
+To do so:
+incoming-webhook
for the Bot Token Scopes
+ https://api.slack.com/apps/APP_ID/oauth?).SITE_ROOT/integrations/add_slack_btn/
.
+ For example, if your SITE_ROOT is https://my-hc.example.org
then the redirect URL would be
+ https://my-hc.example.org/integrations/add_slack_btn/
.SLACK_CLIENT_ID
and SLACK_CLIENT_SECRET
environment
+ variables.To enable Discord integration, you will need to:
+localhost:8000
then the redirect URI would be
+ http://localhost:8000/integrations/add_discord/
DISCORD_CLIENT_ID
and DISCORD_CLIENT_SECRET
environment
+ variables.Pushover integration works by creating an application on Pushover.net which + is then subscribed to by Healthchecks users. To enable the Pushover integration, you will need to:
+http://healthchecks.example.com/
).PUSHOVER_API_TOKEN
and PUSHOVER_SUBSCRIPTION_URL
environment
+ variables. (The Pushover subscription URL should look similar to
+ https://pushover.net/subscribe/yourAppName-randomAlphaNumericData
.The registration workflow is as follows:
+Healthchecks uses signal-cli to send Signal + notifications. Healthcecks interacts with signal-cli over DBus.
+To enable the Signal integration:
+SIGNAL_CLI_ENABLED
environment variable to True
.TELEGRAM_BOT_NAME
and TELEGRAM_TOKEN
environment variables.+ $ ./manage.py settelegramwebhook + Done, Telegram's webhook set to: https://my-monitoring-project.com/integrations/telegram/bot/ ++ +
For this to work, your `SITE_ROOT` needs to be correct and use "https://" scheme.
+ +To enable Apprise integration, you will need to:
+pip install apprise+
APPRISE_ENABLED
environment variable.The "Shell Commands" integration runs user-defined local shell commands when checks
+go up or down. This integration is disabled by default, and can be enabled by setting
+the `SHELL_ENABLED
` environment variable to True
.
Note: be careful when using "Shell Commands" integration, and only enable it when
+you fully trust the users of your Healthchecks instance. The commands will be executed
+by the manage.py sendalerts
process, and will run with the same system permissions as
+the sendalerts
process.
To enable the Matrix integration you will need to:
++ MATRIX_HOMESERVER=https://matrix.org + MATRIX_USER_ID=@mychecks:matrix.org + MATRIX_ACCESS_TOKEN=[a long string of characters returned by the login call] ++
SITE_NAME sets a quota on the maximum number of SMS, WhatsApp, and phone-call notifications an account can send per given month. The specific limit depends on the