A dead man's switch that sends alerts if a GET request doesn't arrive on time.
DO NOT USE HOWL TO PROTECT ANYTHING IMPORTANT. Howl is extremely alpha and should not be trusted. Howl comes with ABSOLUTELY NO WARRANTY. I am not responsible for any damages.
A service is a platform which can send data like emails or discord. Currently the supported services are:
Adding a service only requires adding a class to services.py. Refer to
Email as a template.
The action of sending a GET request to Howl to notify it that you still exist
is called a checkin. This requires authenticating with the Howl server using
a username and a password generated by TOTP. Check out
wolf for a cli client to help streamline the
checkin process.
An alert defines when and how to use one or more services. Alerts are
configured by yaml files which are stored in the alerts directory.
The name of the yaml file is the name of the directory. An example alert
timeout: 48
services:
- !Email
recipient: [email protected], [email protected]
sender: [email protected]
subject: Ahh-wooooooo!
body: |
Hello World!
<3 Howl
- !Email
recipient: [email protected]
sender: [email protected]
subject: Ahh-wooooooo!
body: |
Another email from the example alert.
<3 HowlSo lets break it down:
timeout:defines how the how long, in hours, to wait since the last check in before the alert is triggered. Iftimeoutis set toNonethen the alert will only be able to be triggered manually.services:is a list of the services to use.!Emailtells Howl what service to use, substitutingEmailwith the service name. This is then followed by service specific configuration.
Docker:
docker run -d \
--name howl \
--restart always \
-p 5000:5000 \
-v /srv/howl/:/howl/alerts/ \
-e "USERNAME=test" \
-e "TOTP_SECRET=base32secret3232" \
registry.gitlab.com/huggles/howlThe main application environment variables for configuration.
| Environment Variable | Description | Default |
|---|---|---|
LOG_LEVEL |
Set the log level. Possible values are DEBUG, INFO, WARNING, ERROR or CRITICAL. | INFO |
USERNAME |
Used in conjunction with PASSWORD to authenticate the user. |
NONE but this must be set or you'll get ugly errors. |
TOTP_SECRET |
A base32 encoded string used to generate the totp password. | Randomly generated. |
CHECK_INTERVAL |
The amount of time in seconds to wait between checking if any alerts should be sounded. | 21600 |
The email service can be configured with the following environment variables.
| Environment Variable | Description | Default |
|---|---|---|
SMTP_HOST |
The url to a SMTP server to use for sending emails. | None |
SMTP_PORT |
The port of the SMTP server used to send emails. | None |
SMTP_USERNAME |
The username of the SMTP server. | None |
SMTP_PASSWORD |
The password of the SMTP server. | None |
Same as every other docker image:
docker build -t howl .Go for it!
Howl is distributed under the GNU General Public License Version 3.