diff --git a/roles/dooris/README.md b/roles/dooris/README.md new file mode 100644 index 0000000..7aaa9a9 --- /dev/null +++ b/roles/dooris/README.md @@ -0,0 +1,14 @@ +# dooris + +Deployment configuration of [dooris](https://git.hamburg.ccc.de/CCCHH/dooris) on our host. +For an exact description of host requirements, see the README of dooris itself. + +## Required Arguments + +- `dooris__hostname`: The hostname on which the dooris server is reachable +- `dooris__ccujack_user`: Username for authentication against homematic ccujack +- `dooris__ccujack_password` Password for authentication against homematic ccujack +- `dooris__openid_client_id`: Client-ID in CCCHH ID for dooris +- `dooris__openid_client_secret`: Client-Secret in CCCHH ID for dooris +- `dooris__static_api_token`: A static token that is valid on the servers API and can operate locks +