hosting/mash-playbook
1
0
Fork 0
Code Pull requests Activity

Update Healthchecks docs

Browse source 
Related to 3842af27ed
This commit is contained in:
Slavi Pantaleev 2024-01-06 18:24:36 +02:00
parent 3842af27ed
commit 2ba61fadcf
1 changed files with 10 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/services/healthchecks.md
View file

@ -49,24 +49,22 @@ You can create as many accounts as you wish.
### Email integration
To allow Healthchecks to send emails, add the following **additional** configuration:
If you've enabled the [exim-relay](exim-relay.md) mailer service, Healtchecks will automatically be configured to send through it.
If you need to configure Healthchecks to send email directly, the [ansible.role.healthchecks](https://github.com/mother-of-all-self-hosting/ansible-role-healthchecks) Ansible role provides various variables for tweaking the email-sending configuration in its `default/main.yml` file (`healthchecks_environment_variable_default_from_email` and various `healthchecks_environment_variable_email_*` variables).
```yaml
healthchecks_environment_variables_additional_variables: |
DEFAULT_FROM_EMAIL=healthchecks@example.com
EMAIL_HOST=smtp.example.com
EMAIL_HOST_PASSWORD=
EMAIL_HOST_USER=
EMAIL_PORT=587
EMAIL_USE_TLS=True
EMAIL_USE_VERIFICATION=True
```
### Integrating with other services
Refer to the [upstream `.env.example` file](https://github.com/healthchecks/healthchecks/blob/master/docker/.env.example) for discovering additional environment variables.
You can pass these to the Healthchecks container using the `healthchecks_environment_variables_additional_variables` variable. See [Email integration](#email-integration) for an example.
You can pass these to the Healthchecks container using the `healthchecks_environment_variables_additional_variables` variable. Example:
```yml
healthchecks_environment_variables_additional_variables: |
DISCORD_CLIENT_ID=123
DISCORD_CLIENT_SECRET=456
```
## Usage