marcel/survBot
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases 1 Wiki Activity

[update] README.md

Browse Source 
- add section on running survBot in a Docker container
- add explaination of mal server settings in parameters.yaml
This commit is contained in:
Kasper D. Fischer 2025-03-21 16:14:21 +01:00
parent b46802a75e
commit aaadff6306
1 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -40,7 +40,38 @@ The GUI can be loaded via
python survBotGui.py
```
### Docker
To run the program in a Docker container, first build the image:
```shell script
docker build -t survbot .
```
Then run the container:
```shell script
docker run -v /path/to/conf-dir:/usr/src/app/conf -v /path/to/output:/usr/src/app/www survbot
```
The directory `/path/to/conf-dir` should contain the `parameters.yaml` file, and the directory `/path/to/output` will contain the output HTML files.
### Configuration of the e-mail server settings
The e-mail server settings can be configured in the `parameters.yaml` file. The following settings are available:
- `mailserver`: the address of the mail server
- `auth_type`: the authentication type for the mail server (`None`, `SSL`, `TLS`)
- `port`: the port of the mail server
- `user`: the username for the mail server (if required)
- `password`: the password for the mail server (if required)
The `user` and `password` fields are optional, and can be left empty if the mail server does not require authentication. The `auth_type` field can be set to `None` if no authentication is required, `SSL` if the mail server requires SSL authentication, or `TLS` if the mail server requires TLS authentication. If the `user` or `password` fileds are set to `Docker` ore `ENV` the program will try to read the values from the docker secrets `mail_user` and `mail_password` or environment variables `MAIL_USER` and `MAIL_PASSWORD` respectively. Docker secrets are only available in Docker Swarm mode, i.e. if the program is run as a service.
## Version Changes
### 0.2
- surveillance of mass, clock and gaps
- individual mailing lists for different stations
- html mail with recent status information
@ -48,8 +79,14 @@ python survBotGui.py
- restructured parameter file
- recognize if PBox is disconnected
### 0.2-docker
- added Dockerfile for easy deployment
- added more settings for connection to a mail server
## Staff
Original author: M.Paffrath (marcel.paffrath@rub.de)
Contributions by: Kasper D. Fischer (kasper.fischer@rub.de)
June 2023
Jan 2025