Scans a list of provided URLs for changes at a set interval.
Requires NodeJS >16.14.2 ( https://nodejs.org/en/download/ )
All commands are ran inside of the src
directory after changing directories.
cd src
npm install
In order to generate an editable config, you have two options. You can either copy the src/config/config.json.default
-> src/config/config.json
OR you may run the application once.
cd src
npm run start
To start the program, you must run the following command in the src
directory after changing directories.
cd src
npm run start
- enabled
- Defines if scanning is enabled
- intervalMs
- The interval used for scanning all URLs, in milliseconds
- ignoreList
- A list of keywords to be used to ignore changes in lines
- urls
- A list of all the URLs to be scanned
- compareLinesOnly
- Decide if you should compare lines or individual characters in a string, this is recommended to be enabled
- email
- enabled
- Defines if email notifications are enabled
- recipients
- A list of all email addresses that will recieve the notification
- subject
- The subject of the email, formats {url} to the updated website URL
- from
- The email address that is sending the emails, will not be used if
useSMTPFrom
is enabled.
- The email address that is sending the emails, will not be used if
- useSMTPFrom
- Defines if the SMTP authentication username should be used instead of the
from
field.
- Defines if the SMTP authentication username should be used instead of the
- smtp
- host
- The main SMTP host address
- port
- The main SMTP host address port
- secure
- If the SMTP system should use TLS
- auth
- useEnv
- Defines if environment variables should be used instead of the
user
andpass
field.
- Defines if environment variables should be used instead of the
- user
- Used for authentication, email username, will not be used if
useEnv
is enabled.
- Used for authentication, email username, will not be used if
- pass
- Used for authentication, email password, will not be used if
useEnv
is enabled.
- Used for authentication, email password, will not be used if
- useEnv
- host
- enabled