diff --git a/.gitignore b/.gitignore index c2065bc..e48b6be 100644 --- a/.gitignore +++ b/.gitignore @@ -34,4 +34,4 @@ out/ /.nb-gradle/ ### VS Code ### -.vscode/ +.vscode/ \ No newline at end of file diff --git a/dev-env-data/docker-compose.yaml b/dev-env-data/docker-compose.yaml new file mode 100644 index 0000000..18ce402 --- /dev/null +++ b/dev-env-data/docker-compose.yaml @@ -0,0 +1,14 @@ +name: dartvader-dev-env + +services: + keycloak: + image: quay.io/keycloak/keycloak:latest + environment: + KEYCLOAK_ADMIN: admin + KEYCLOAK_ADMIN_PASSWORD: admin + command: + - start-dev + ports: + - "8081:8080" + volumes: + - ./keycloak/h2:/opt/keycloak/data/h2 \ No newline at end of file diff --git a/dev-env-data/keycloak/h2/.gitignore b/dev-env-data/keycloak/h2/.gitignore new file mode 100644 index 0000000..4e7daf3 --- /dev/null +++ b/dev-env-data/keycloak/h2/.gitignore @@ -0,0 +1 @@ +keycloakdb.trace.db \ No newline at end of file diff --git a/dev-env-data/keycloak/h2/keycloakdb.mv.db b/dev-env-data/keycloak/h2/keycloakdb.mv.db new file mode 100644 index 0000000..8f68e86 Binary files /dev/null and b/dev-env-data/keycloak/h2/keycloakdb.mv.db differ diff --git a/docs/dev-env/dev-env.md b/docs/dev-env/dev-env.md new file mode 100644 index 0000000..d954091 --- /dev/null +++ b/docs/dev-env/dev-env.md @@ -0,0 +1,11 @@ +# Development Environment + +_This document describes how to set up a development environment for the project._ + +## Docker-Compose + +_Run [`docker-compose.yaml`](..%2F..%2Fdev-env-data%2Fdocker-compose.yaml) to start dev-stage._ + +The project uses Docker-Compose to start the development environment. The following services are started: + +* [Keycloak](keycloak-docs.md) diff --git a/docs/dev-env/keycloak-docs.md b/docs/dev-env/keycloak-docs.md new file mode 100644 index 0000000..de61c6e --- /dev/null +++ b/docs/dev-env/keycloak-docs.md @@ -0,0 +1,43 @@ +# Keycloak Docs + +_Hilfe für den Umgang mit dem Dev-Keycloak._ + +Der Keycloak ist unter [http://localhost:8081](http://localhost:8081) erreichbar. + +## Standard Realm + +_Beschreibung der standard Einstellung für den dev-keycloak._ + +## Master Realm + +Standard admin: admin/admin + +## DartVader Realm + +### Dev-DartVader - Client + +_Für Dev-Stage für die DartVader App._ + +Client-ID: Dev-DartVader +Erlaubte Adressen: +Frontend: http://localhost:4200 + +#### Role: DARTVADER_USER + +_Rolle für Client zugehörigkeit. Als dummy für Rollen-Model._ +Der Nutzer `user` hat diese Rolle. + +### User + +* User: user/user + * Rolle: DARTVADER_USER + +* No-User: nuser/nuser + * ohne DARTVADER_USER + +## Änderungen Speichern + +Die Änderungen am Keycloak werden in der [`keycloakdb.mv.db`](..%2F..%2Fdev-env-data%2Fkeycloak%2Fh2%2Fkeycloakdb.mv.db) +gespeichert. +Diese wird beim Starten des Keycloak-Containers in den Container gemountet. Hierdurch bleiben die Änderungen erhalten +und können mit dem repo synchronisiert werden. Damit kann ein dev-stage des Keycloak einfach geteilt werden. \ No newline at end of file