Skip to content

Commit

Permalink
update documentation with information about keycloak at docker
Browse files Browse the repository at this point in the history
  • Loading branch information
MrSebastian committed Apr 4, 2024
1 parent 5cd7484 commit 266d027
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {defineConfig} from 'vitepress'
import {withMermaid} from "vitepress-plugin-mermaid"

const PATH_TECHNIK = '/technik/';

// https://vitepress.dev/reference/site-config
export default defineConfig({
export default withMermaid({
title: "Wahllokalsystem",
description: "Datenerfassung am Wahltag",
base: '/Wahllokalsystem/',
Expand All @@ -22,12 +22,16 @@ export default defineConfig({
{ text: 'Tools & Frameworks', link: `${PATH_TECHNIK}` },
{
text: 'Getting Started', link: `${PATH_TECHNIK}get_started/`
}
},
{ text: 'Entwicklungsumgebung', link: `${PATH_TECHNIK}development/`}
]
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/it-at-m/Wahllokalsystem/' }
]
},
mermaidPlugin: {
class: "mermaid my-class", // set additional css classes for parent container
}
})
36 changes: 36 additions & 0 deletions docs/src/technik/development/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Entwicklungsumgebung

## Zusammenspiel IDE mit Docker

```mermaid
flowchart LR
subgraph Dev-PC
subgraph IDE
wlsService
end
subgraph Docker
keycloak[Keycloak]
keycloakDB[db-postgres-keycloak]
keycloakInit[init-keycloak]
end
wlsService ---|OAuth2| keycloak
keycloak-->|persisting| keycloakDB
keycloakInit-->|setup of| keycloak
end
```

## Benutzer

| Name | Passwort | Beschreibung |
| --- | --- | --- |
| keycloak_test | test | Ein Benutzer ohne weitere Rechte |
| wls_all | test | Ein Benutzer mit allen Rechten |

## Beispiel-Requests

Im Soap-UI-Projekt (`DockerTest-soapui-project`) und `docker.keycloak.http` sind Beispielrequests vorhanden.
Es kann für den jeweiligen Nutzer ein Token geholt werden. Außerdem ist die Anfrage an den UserInfo-Endpoint hinterlegt.
3 changes: 3 additions & 0 deletions docs/src/technik/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Welche Tools und Framework haben wir zur Entwicklung verwendet.
- Imageregistry
- Zenhub
- Projektmanagement
- Docker
- SoapUI
- Beispielrequests

## Frameworks

Expand Down

0 comments on commit 266d027

Please sign in to comment.