CCCHH/hmdooris
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

Fix certificate path env name
All checks were successful
docker-image / docker (push) Successful in 1m17s
Details

Browse source
This commit is contained in:
Stefan Bethke 2025-05-29 16:48:29 +02:00
commit dca9b58e4f
2 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -4,21 +4,21 @@
All configuration is handled through environment variables.
| Name | Default | Description |
|---------------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| `HMDOORIS_ALLOWED_IPS` | - | List of IP addresses in CIDR notation that are allowed to control the locks. |
| `HMDOORIS_DISCOVERY_URL` | `http://localhost:8080/realms/testing/.well-known/openid-configuration` | OIDC configuration discovery URL. |
| `HMDOORIS_CCUJACK_URL` | `https://raspberrymatic:2122` | URL of the CCU Jack server. |
| `HMDOORIS_CCU_CERTIFICATE_PATH` | - | File of a private certificate, or `false`. |
| `HMDOORIS_CCUJACK_USERNAME` | - | Username in CCU Jack. |
| `HMDOORIS_CCUJACK_PASSWORD` | - | Password in CCU Jack. |
| `HMDOORIS_CLIENT_ID` | `hmdooris` | OIDC client ID. |
| `HMDOORIS_CLIENT_SECRET` | - | ODIC client secret for the confidential flow. |
| `HMDOORIS_LISTEN` | `127.0.0.1:3000` | Which IP and port to listen on. |
| `IDINVITE_OIDC_SCOPE` | `["openid", "email", "profile"]` | JSON list of OIDC scopes to request. The OIDC IDP will need to send the group attribute. |
| `IDINVITE_OIDC_USER_ATTR` | `email` | The attribute to use as the user ID. |
| `HMDOORIS_REQUIRES_GROUP` | - | Set to require users to be a member of this groups. |
| `HMDOORIS_URL` | `http://localhost:3000` | URL of the application, used to construct links to itself. |
| Name | Default | Description |
|-------------------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| `HMDOORIS_ALLOWED_IPS` | - | List of IP addresses in CIDR notation that are allowed to control the locks. |
| `HMDOORIS_DISCOVERY_URL` | `http://localhost:8080/realms/testing/.well-known/openid-configuration` | OIDC configuration discovery URL. |
| `HMDOORIS_CCUJACK_CERTIFICATE_PATH` | - | File of a private certificate, or `false`. |
| `HMDOORIS_CCUJACK_PASSWORD` | - | Password in CCU Jack. |
| `HMDOORIS_CCUJACK_URL` | `https://raspberrymatic:2122` | URL of the CCU Jack server. |
| `HMDOORIS_CCUJACK_USERNAME` | - | Username in CCU Jack. |
| `HMDOORIS_CLIENT_ID` | `hmdooris` | OIDC client ID. |
| `HMDOORIS_CLIENT_SECRET` | - | ODIC client secret for the confidential flow. |
| `HMDOORIS_LISTEN` | `127.0.0.1:3000` | Which IP and port to listen on. |
| `IDINVITE_OIDC_SCOPE` | `["openid", "email", "profile"]` | JSON list of OIDC scopes to request. The OIDC IDP will need to send the group attribute. |
| `IDINVITE_OIDC_USER_ATTR` | `email` | The attribute to use as the user ID. |
| `HMDOORIS_REQUIRES_GROUP` | - | Set to require users to be a member of this groups. |
| `HMDOORIS_URL` | `http://localhost:3000` | URL of the application, used to construct links to itself. |
### Required Group