hmdooris/README.md
2025-05-21 14:44:29 +02:00

32 lines
No EOL
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# hmdooris - Dooris via HomeMatic
## Local Development Setup with Docker Compose
The included docker-compose.yaml will bring up a local Keycloak instance with a preconfigured realm that includes a
client that can be used to test the application locally. You can log in to the admin console
at http://localhost:8080/admin/master/console/ using "admin"/"admin".
### Realm `Keycloak`: Client `hmdooris` and User `hmdooris`
In order for ID Invite to create users, it needs to access the Keycloak REST API with suitable credentials. This is
implemented through a client `hmdooris` in the `Keycloak` realm, with the client secret `XXX`, and a username
of `hmdooris` and password `geheim`.
### Realm `testing`: Client `hmdooris` and User `tony`
Keycloak will import the realm export from [`local-dev/import/testing.json`](local-dev/import/testing.json) and create a
realm `testing`, including a client and a user.
The client ID is `hmdooris` and the secret is ´8p21riiYPDEhpgRh2rgRDNu9uWVZ9KRj`.
You can log in to the realm and the application with user `tony` and password `tester`.
### Updating the testing realm
If you'd like to make changes to the configuration of the testing realm, and have it persist across restarts, you can
export the realm. Run this command:
```shell
docker compose exec -it keycloak /opt/keycloak/data/import/export.sh
```