Konfiguration
Selbst gehostetes PDF Redaction Studio über .env konfigurieren: Lizenz, Secrets, Datenbank, öffentliche URLs Ihrer Domain, Anmeldemethoden und Erkennungs-API.
Alle Einstellungen stehen in der Datei .env neben docker-compose.yaml. Jeder Container liest sie. Übernehmen Sie eine Änderung mit:
docker compose up -dVariablen
| Variable | Verwendet von | Standardwert in .env.example | Funktion |
|---|---|---|---|
PDF_REDACTION_LICENSE | backend | leer | Ihr Lizenzschlüssel. Erforderlich, siehe Lizenz |
DATABASE_HOST | backend | db | Datenbank-Host. Behalten Sie db, um den mitgelieferten Postgres-Container zu verwenden |
DATABASE_PASSWORD | db, backend | Beispielwert | Postgres-Passwort. Ändern Sie es vor dem ersten Start |
SIGNING_KEY | backend | Beispielwert | Signiert Anmelde-Tokens. Ändern Sie ihn in einen langen Zufallswert |
ALLOWED_HOSTS | backend | localhost,backend,0.0.0.0,127.0.0.1 | Hostnamen, auf die das Backend antwortet. Fügen Sie die Domain Ihres Backends hinzu |
CORS_ALLOWED_ORIGINS | backend | http://localhost:3000 | Adresse der Studio-Web-App. Setzen Sie sie auf Ihre Studio-URL |
API_URL | studio | http://backend:8000 | Wie der Studio-Server das Backend innerhalb von Docker erreicht. Meist unverändert |
NEXT_PUBLIC_API_URL | studio | http://127.0.0.1:8000 | Wie die Browser der Nutzer das Backend erreichen |
NEXT_PUBLIC_PII_API_URL | studio | http://127.0.0.1:8002/api/deidentify/ner/text | Wie die Browser der Nutzer die Erkennungs-API erreichen |
NEXTAUTH_URL | studio | http://localhost:3000/api/auth | Öffentliche Studio-URL gefolgt von /api/auth |
NEXTAUTH_SECRET | studio | Beispielwert | Verschlüsselt Anmeldesitzungen. Ändern Sie es in einen langen Zufallswert |
NEXT_PUBLIC_AUTH_METHODS | studio | userpass | Anmeldemethoden auf der Anmeldeseite, siehe unten |
PDF_REDACTION_API_LICENSE, PDF_REDACTION_API_OPENMETER_SOURCE | api | vorgegeben | Einstellungen für die Erkennungs-API. Behalten Sie die Werte aus .env.example, sofern der Support nichts anderes sagt |
Zufällige Secrets erzeugen Sie mit:
openssl rand -base64 32Studio auf Ihrer eigenen Domain betreiben
Die Standardwerte funktionieren nur auf dem Rechner, auf dem Docker läuft. Die Studio-Seite im Browser spricht direkt mit dem Backend und mit der Erkennungs-API, daher müssen beide von den Computern Ihrer Nutzer aus erreichbar sein.
Eine typische Einrichtung setzt einen Reverse Proxy mit HTTPS (nginx, Caddy oder Traefik) vor die drei öffentlichen Ports:
| Öffentliche Adresse | Leitet weiter an |
|---|---|
https://studio.example.com | studio:3000 |
https://studio-api.example.com | backend:8000 |
https://studio-pii.example.com | api:8002 |
Setzen Sie dann:
NEXTAUTH_URL=https://studio.example.com/api/auth
CORS_ALLOWED_ORIGINS=https://studio.example.com
NEXT_PUBLIC_API_URL=https://studio-api.example.com
NEXT_PUBLIC_PII_API_URL=https://studio-pii.example.com/api/deidentify/ner/text
ALLOWED_HOSTS=studio-api.example.com,backend,localhostMachen Sie die Datenbank nicht öffentlich zugänglich
docker-compose.yaml veröffentlicht Postgres der Einfachheit halber auf Port 5432. Entfernen Sie auf einem Server diesen ports-Eintrag oder sperren Sie den Port in Ihrer Firewall, damit die Datenbank nur von den anderen Containern aus erreichbar ist.
Anmeldemethoden
NEXT_PUBLIC_AUTH_METHODS ist eine kommagetrennte Liste:
| Wert | Anmeldemethode |
|---|---|
userpass | Benutzername und Passwort, gespeichert auf Ihrem Server (Standard) |
google | Google-Konto. Erfordert Ihren eigenen Google-OAuth-Client |
microsoft | Microsoft-Konto. Erfordert Ihre eigene Microsoft-Entra-ID-App |
Für die Anmeldung mit Google oder Microsoft legen Sie die OAuth-App mit der Weiterleitungs-URL https://studio.example.com/api/auth/callback/google (oder /microsoft) an und wenden sich an den Support, um die hinzuzufügenden Variablen zu erhalten.
Wo die Erkennung läuft
Im selbst gehosteten Studio sendet Cloud-PII in den Erkennungseinstellungen des Editors den Seitentext an den Container api auf Ihrem Server, an die Adresse in NEXT_PUBLIC_PII_API_URL. Lokale NER, regelbasierte Erkennung, OCR und Gesichtserkennung laufen wie in jedem Produkt im Browser des jeweiligen Nutzers.
Nächste Schritte
Installation mit Docker
Selbst gehostetes PDF Redaction Studio mit Docker Compose installieren: Installer mit einem Befehl oder manuell, Lizenzschlüssel, erste Anmeldung, Container.
Lizenz
So funktioniert die Lizenz für selbst gehostetes PDF Redaction Studio: Test- oder kommerziellen Schlüssel holen, in .env eintragen, Ablauf und Ersetzen.