Skip to content

Notification Settings

f0cker edited this page Jun 25, 2020 · 1 revision

Notification Settings

CrackQ currently supports notifications via email using SMTP. I will add another notification method in the future, but haven't decided which one yet. If you would like to see Slack, Telegram, SMS or some other notification added please let me know and I'll go with the majority.

Add your relevant SMTP mail server settings to the config file:

[notify]
mail_server: mail.crackq.org
mail_port: 465
src: crackq@crackq.org
inactive_time: 20
tls: True

The inactive_time setting is the time to wait since last user activity before sending event notifications in minutes (there's no sense sending email if you're actively looking at the progress).

If you need to provide credentials to the SMTP server you will need them as environment variables, which will be passed to the crackq docker container before you execute docker-compose:

export MAIL_USERNAME=<your-mail-username>
export MAIL_PASSWORD=<your-mail-password>