ChaoticByte/wid-notifier
1
1
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Added more information to the README

Browse source
This commit is contained in:
ChaoticByte 2023-10-13 20:35:02 +02:00
parent 852a8107ae
commit ca2acc21db
1 changed files with 24 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,22 +1,34 @@
# WID Notifier # WID Notifier
A tool that sends configurable email notifications for The German [BSI](https://www.bsi.bund.de/) and [LSI Bavaria](https://lsi.bayern.de/) each have a page listing current security notices.
- https://wid.cert-bund.de/portal/wid/kurzinformationen - BSI: https://wid.cert-bund.de/portal/wid/kurzinformationen
- https://wid.lsi.bayern.de/portal/wid/warnmeldungen - LSI: https://wid.lsi.bayern.de/portal/wid/warnmeldungen
This software queries the APIs of these services for new security notices and sends configurable email notifications.
## Supported Platforms ## Supported Platforms
This Software only supports Linux. This Software only supports Linux.
## Supported API Endpoints ## API Endpoints
| ID | Portal URL | | | ID | Portal URL |
|--------|-------------------------------------------------------| |-----|--------|-------------------------------------------------------|
| `bund` | https://wid.cert-bund.de/portal/wid/kurzinformationen | | BSI | `bund` | https://wid.cert-bund.de/portal/wid/kurzinformationen |
| `bay` | https://wid.lsi.bayern.de/portal/wid/warnmeldungen | | LSI | `bay` | https://wid.lsi.bayern.de/portal/wid/warnmeldungen |
# Config # Usage
After building the application using `go build`, run
```bash
./wid-notifier <configfile>
```
where `<configfile>` is the path of your configuration file. If you don't have a config file yet, the software will create an initial config at the given location. See [Configuration](#configuration) for more info.
# Configuration
Example: Example:
@ -145,10 +157,12 @@ If set to `""`, this criteria will be ignored.
### api_endpoint ### api_endpoint
Includes notices from the given [API Endpoint](#supported-api-endpoints). Includes notices from the given [API Endpoint](#api-endpoints).
## Templates ## Templates
If you don't like the default appearance of the notification mails, you can write your own templates for the mail subject and body.
The syntax for the mail templates is described [here](https://pkg.go.dev/text/template). The syntax for the mail templates is described [here](https://pkg.go.dev/text/template).
All fields from the WidNotice struct can be used. All fields from the WidNotice struct can be used.