Skip to content
This repository has been archived by the owner on May 13, 2024. It is now read-only.

Commit

Permalink
Add description of important files not in VCS
Browse files Browse the repository at this point in the history
  • Loading branch information
lfir committed Mar 22, 2021
1 parent 0e5b40c commit e8edbbe
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
### mail_error_notifs.py
Script that can be used as a scheduled task to send email notifications when certain websites aren't available.

Emails are sent using Sendgrid's service.
Emails are sent using [Sendgrid](https://sendgrid.com)'s service.

**Additional files used not in VCS:**
- .env

Specific or sensitive information is read from this file, such as Sendgrid's API key and the URL of target websites.

- mail_error_notifs.log

Where exceptions that occur during the execution of the script are logged to.
The directory where the file should be stored is read from the environment variable LOGDIR, that can be set in the first file.

0 comments on commit e8edbbe

Please sign in to comment.