Documentation prod/local dev stuff
continuous-integration/drone/push Build is passing Details

This commit is contained in:
decentral1se 2021-05-05 13:31:10 +02:00
parent 1134b4572b
commit 4e2415e807
Signed by: decentral1se
GPG Key ID: 92DAD76BD9567B8A
1 changed files with 29 additions and 0 deletions

View File

@ -7,3 +7,32 @@
[Custom theming](https://www.keycloak.org/docs/latest/server_development/index.html#_themes) for the Keycloak SSO service.
Please see [default-themes/README.md](./default-themes/README.md) and [lumbung.space/README.md](./lumbung.space/README.md) for more info.
## Deployment
Just send commits and the [Drone CI/CD configuration](./.drone.yml) will take care of the rest.
## Local Hacking
You'll need a local [Docker](https://docs.docker.com/engine/install/debian/) installation.
Then run a local Keycloak and mount the theme into the container with:
```bash
docker run \
-p 8080:8080 \
-v $(pwd)/lumbung.space:/opt/jboss/keycloak/themes/lumbung.space \
-e KEYCLOAK_USER=admin \
-e KEYCLOAK_PASSWORD=admin \
jboss/keycloak:12.0.4
```
Then you can log into [localhost:8080](http://localhost:8080) with username: `admin` and password: `admin`.
See related documentation and tutorials for the hacking:
- [Create a custom theme for Keycloak](https://auscunningham.medium.com/create-a-custom-theme-for-keycloak-8781207be604)
- [Change Login Theme in Keycloak Docker image](https://austincunningham.ddns.net/2020/changekeycloakdockertheme)
- [Keycloak themes documentation](https://www.keycloak.org/docs/latest/server_development/index.html#_themes)
- [Keycloak Github repo for default themes](https://github.com/keycloak/keycloak/tree/master/themes/src/main/resources/theme)
- [Keycloak container documentation](https://github.com/keycloak/keycloak-containers/tree/master/server)