dst/README.md

28 lines
788 B
Markdown
Raw Permalink Normal View History

2020-03-14 10:25:27 +00:00
# Docker Status
Simple status page using Docker sdk and healthcheck.
## Options
Environment variable | Description | Default
--- | --- | ---
DOCKER_* | Docker client options | [Doc](https://docker-py.readthedocs.io/en/stable/client.html#docker.client.from_env)
2020-03-14 14:48:59 +00:00
DST_PATH | Files output | `/data`
2020-03-14 10:25:27 +00:00
DST_INTERVAL | Update interval is seconds | `30`
DST_FILTER_LABEL | Filter visible containers with label | `False`
DST_NAME_LABEL | Override container name with label | `False`
2020-03-14 16:38:13 +00:00
DST_GROUP_LABEL | Group containers by label | `False`
2020-03-14 10:25:27 +00:00
DST_URL_LABEL | Provide url with label | `False`
2020-03-14 14:48:59 +00:00
DST_TITLE | Page title | `Docker Status`
DST_CAPTION | Page caption
2020-03-14 10:25:27 +00:00
## TODO
2020-03-14 16:38:13 +00:00
- [x] Json periodic static
- [x] Static Front
- [x] Groups
- [ ] Events
- [ ] Gotify
2020-03-14 10:28:59 +00:00
## Licence
Distributed under the GPL3 license.