Add more hacking docs
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
decentral1se 2021-05-24 12:52:43 +02:00
parent df66e3116a
commit 9e15ffecef
Signed by: decentral1se
GPG Key ID: 92DAD76BD9567B8A

View File

@ -16,18 +16,22 @@ Just send commits and the [Drone CI/CD configuration](./.drone.yml) will take ca
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:
Then run a local Keycloak instance and mount the theme into the container with the following ([makefile source](./makefile)):
```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
```
$ make
```
Then you can log into [localhost:8080](http://localhost:8080) with username: `admin` and password: `admin`.
An example workflow for customising the login theme would be:
- Log into [localhost:8080](http://localhost:8080) with username: `admin` and password: `admin`
- Go to [Realm Settings > Themes](http://localhost:8080/auth/admin/master/console/#/realms/master/theme-settings)
- Choose a custom login theme via Login Theme > lumbung.space and click Save
- Sign out and you'll be redirected to the login page
- Now, test you can make an edit and it is reflected on reload, change the "Username or email" string in [mesages_en.properties](./lumbung.space/login/messages/messages_en.properties)
- Reload the page, your change should be live
Once you're finished theming, `git push` and the [Drone CI config](.drone.yml) will deploy this live to [login.lumbung.space](https://login.lumbung.space).
See related documentation and tutorials for the hacking: