Skip to Content
DocsAuthorityGetting started

Getting started

Über diesen Guide wird eine lokale Instanz der 5Minds Authority aufgesetzt.

Voraussetzungen

Für die ersten Schritte mit der 5Minds Authority müssen drei Voraussetzungen erfüllt sein:

  1. Eine Installation von Docker Desktop .
  2. Lesezugriff auf die DockerHub-Repositories von 5Minds .
  3. Ein Alias für die Serviceadresse authority auf 127.0.0.1 in der hosts-Datei des Betriebssystems.
sudo sh -c 'echo "127.0.0.1 authority" >> /etc/hosts'

Erstellen der Authority-Konfiguration

Die Konfiguration entscheidet über grundlegende Einstellungen für den Betrieb der Authority. Für dieses Beispiel wird eine lokale PostgreSQL-Datenbank und der hauseigene Identitätsprovider Username & Password Extension (UPE) verwendet, der zugleich eine Benutzerverwaltung beinhaltet.

Lege in deinem Arbeitsverzeichnis eine JSON-Datei mit folgendem Inhalt an:

config.json
{
  "issuerUrl": "http://authority:11560",
  "applicationPort": 11560,
  "database": {
    "dialect": "postgres",
    "host": "db",
    "port": 5432,
    "username": "admin",
    "password": "ProcessCubeAdmin1",
    "database": "authority"
  },
  "studio": {
    "enabled": true,
    "scope": "openid profile email engine_read engine_observer engine_write"
  },
  "extensions": {
    "path": "/app/extensions",
    "configs": {
      "username_password": {
        "skipConsentPageForClientIds": ["upe_client", "portal", "studio"],
        "customization": {
          "title": "Test Setup",
          "logoPath": "/etc/authority/assets/5minds_logo.png"
        }
      }
    }
  }
}

Initiale Benutzer definieren

Lege in deinem Arbeitsverzeichnis eine Datei upeSeedingData.json an:

upeSeedingData.json
{
  "users": [
    {
      "username": "admin",
      "password": "admin",
      "scopes": ["openid", "profile", "email", "engine_read", "engine_observer", "engine_write", "upe_admin"]
    }
  ]
}

Mit dieser Datei erstellt die Authority für die UPE ein initiales Set an Benutzern, um zur Administrationsoberfläche zu gelangen.

Starten der Authority

Lege zusätzlich eine Datei docker-compose.yml mit folgendem Inhalt an:

docker-compose.yml
version: '3.8'
services:
  db:
    image: postgres:17.0
    restart: unless-stopped
    environment:
      - POSTGRES_USER=admin
      - POSTGRES_PASSWORD=ProcessCubeAdmin1
      - POSTGRES_DB=authority
    ports:
      - 5432:5432
 
  authority:
    image: 5minds/processcube_authority:2024-2
    ports:
      - 11560:11560
    restart: unless-stopped
    environment:
      CONFIG_PATH: /etc/authority/config/config.json
      UPE_SEED_PATH: /etc/authority/config/upeSeedingData.json
      LOG_LEVEL: info
    volumes:
      - ./.processcube/authority/config.json:/etc/authority/config/config.json
      - ./.processcube/authority/upeSeedingData.json:/etc/authority/config/upeSeedingData.json
      - ./.processcube/authority/assets/5minds_logo.png:/etc/authority/assets/5minds_logo.png

Ohne Seeding-Datei wird ein Benutzer mit den Anmeldedaten admin:admin angelegt. Es wird empfohlen, sich für das explizite Seeding und ein komplexeres Passwort zu entscheiden.

Fahre die Instanz hoch

docker-compose up

Rufe die Authority unter http://authority:11560 auf und logge dich mit den Anmeldedaten des definierten Benutzers admin:admin an. Die Username & Password Extension (UPE) erlaubt eine schnelle Verwaltung der Anmelde- und Autorisierungsrichtlinien.

Nächste Schritte

Nach dieser Einführung hast du erfolgreich eine Authority-Instanz eingerichtet. Die weiteren Artikel bieten Informationen zu den Themen: Konfiguration, Integration und Bedienung.

EinführungExterne Identitätsprovider