Skip to content

Commit

Permalink
add docker-compose.yaml with docs
Browse files Browse the repository at this point in the history
* keycloak with dev-stage via h2-file
  • Loading branch information
Mankianer committed Sep 28, 2024
1 parent 84cbcad commit 56ce4e4
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ out/
/.nb-gradle/

### VS Code ###
.vscode/
.vscode/
14 changes: 14 additions & 0 deletions dev-env-data/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions dev-env-data/keycloak/h2/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
keycloakdb.trace.db
Binary file added dev-env-data/keycloak/h2/keycloakdb.mv.db
Binary file not shown.
11 changes: 11 additions & 0 deletions docs/dev-env/dev-env.md
Original file line number Diff line number Diff line change
@@ -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)
43 changes: 43 additions & 0 deletions docs/dev-env/keycloak-docs.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 56ce4e4

Please sign in to comment.