diff --git a/README.md b/README.md index 2f49bf37a475d751587f8b931bf1b2a8cd5bd8e7..28320dfa2821acb94e29fa16358a39a5c945af2d 100644 --- a/README.md +++ b/README.md @@ -65,56 +65,53 @@ Nach erfolgreicher Anmeldung erscheint die Meldung: Login Succeeded ``` +### Erstellung von privaten/öffentlichen Schlüsseln und .env-Datei -### Create private/public keys and .env - -Please change all passwords in the configuration file and leave the passphrase empty. +Zuerst müssen wir ein neues Schlüsselpaar für die Authentifizierung erstellen. Die Passphrase wird leer gelassen, und alle Passwörter in der Konfigurationsdatei müssen geändert werden. +Dies wird genutzt, um Token zu signieren (JWT). ```bash ssh-keygen -b 4096 -f id_rsa cp .env.sample .env ``` -### Start containers +Wichtig: Ändern Sie alle Passwörter in der .env-Datei, um die Sicherheit zu gewährleisten. + +### Container starten +Um die Anwendung zu starten, verwenden Sie Docker Compose, das alle benötigten Dienste im Hintergrund hochfährt: ```bash docker compose up -d ``` -Please check whether all services started successfully. +#### Überprüfung des Container-Status +Nach dem Start der Container sollten Sie überprüfen, ob alle Dienste erfolgreich ausgeführt werden: + ```bash docker compose ps ``` +Wenn alle Container erfolgreich gestartet wurden, können Sie die Anwendung im Browser aufrufen: + +URL: http://localhost:8004/ + +Hier sollte die Rights Engine sichtbar sein. -After that you should be able to visit http://localhost:8004/ and see the rights engine. - -### Infrastructure overview - - -```mermaid -graph TD; -subgraph Polaris -Z[Docker Build] -end -Z[Docker Build] --> A(Ingress); -Z[Docker Build] --> B(Ingress); -subgraph GitLab -B[Container Registry] --> H(Images); -end -subgraph Server -A[Docker Pull] --> D(Traefik); -D[Traefik] --> E(Deployment:Analytics-Engine); -D[Traefik] --> F(Deployment:Rights-Engine); -D[Traefik] --> I(Deployment:Dashboard-SDK); -E(Deployment:Analytics-Engine)---id1[(MongoDB)] -F(Deployment:Rights-Engine)---id1[(MongoDB)] -I(Deployment:Dashboard-SDK)---id1[(MongoDB)] -end +### Erstellen eines Administrations-Accounts +In der Rights Engine läuft Django, und um sich als Administrator anzumelden, muss ein Superuser erstellt werden. Dies ermöglicht Zugriff auf das Django-Admin-Interface. +Dafür nutzen wir docker compose exec: + +```bash +docker compose exec rights_engine bash ``` +Nachdem Sie sich im Django-Container befinden, führen Sie den folgenden Befehl aus, um einen Superuser zu erstellen: + +```bash +python3 manage.py createsuperuser +``` -## Update Polaris to a newer version +## Aktualisieren von Polaris Falls Sie eine neuere Version von Polaris installieren möchten, folgen Sie diesen Schritten. Stellen Sie sicher, dass Sie sich im Verzeichnis befinden, in dem sich Ihre docker-compose.yml-Datei befindet. ```bash