Files
bibreminder/README.md
T
matthias 61c37d6700
continuous-integration/drone/push Build is passing
minor improvements on configuration
Some explanations added and options implemented
2020-01-19 04:39:43 +01:00

28 lines
1.2 KiB
Markdown

# Bib Reminder for Munich public library
This automatically sending pushover messages when a lent item is about to be returned, while also extending the period of the lending if possible.
Configure the docker container with the following variables.
## Docker Config
### Required
- `PUSHOVER_KEY` Your pushover API Key
- `PUSHOVER_CLIENTS` A comma seperated list of pushover client ids. All the notifications will be sent to this ids
- `NOTIFY_USERS` A coma separated list of <USER>:<pushover client id> tulles to send pushover messages selectivly
- `HEALTHCHECK_URL` OPTIONAL url for performing a healthcheck (see healthckeck.io for details)
- `BIB_USERS` A comma seperated list of combinations of <USER>:<PWD> combinations to check and extend lent items.
- `LIBRARY_URL` The url of the OPAC entry page of your library, defaults to the one of Stadtbibliothek München
- `RUN_AT_HOUR` Check at hour, default 6
- `RUN_AT_MINUTE` Check at minute, default 0
Example:
```
PUSHOVER_KEY=abcdef1234567890abcdef12345678
HEALTHCHECK_URL=https://healthcheck.io/ping/0000000-0000-0000-0000-000000000000
BIB_USERS=400001234567:password,40000987654:drowssap
NOTIFY_USERS= 400001234567:12345678abcdef1234567890abcdef,40000987654:12345678abcdef1234567890abcdef
```