Installation mit Docker
Selbst gehostetes PDF Redaction Studio mit Docker Compose installieren: Installer mit einem Befehl oder manuell, Lizenzschlüssel, erste Anmeldung, Container.
Selbst gehostetes Studio läuft als vier Docker-Container auf Ihrem eigenen Server. Dokumente und ihr Text werden von diesen Containern verarbeitet; für die Erkennung wird nichts an pdf-redaction.com gesendet.
Voraussetzungen
- Linux, macOS oder Windows (WSL 2) mit Docker und Docker Compose v2.
- Etwa 6 GB Speicherplatz für die Images, dazu Platz für die Datenbank und die Erkennungsmodelle.
- Ein Lizenzschlüssel. Holen Sie sich eine kostenlose 14-Tage-Testversion oder eine kommerzielle Lizenz unter pdf-redaction.com/licenses. Siehe Lizenz.
Option 1: Installer mit einem Befehl
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/install.sh)"Kein curl? Verwenden Sie wget:
/bin/bash -c "$(wget -qO- https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/install.sh)"Der Installer:
- Legt im aktuellen Verzeichnis einen Ordner
pdf-redaction-studioan und lädtdocker-compose.yamlund.env.examplehinein. - Kopiert
.env.examplenach.env. - Fragt nach Ihrem Lizenzschlüssel, falls
.envnoch keinen enthält, und öffnet die Lizenzseite in Ihrem Browser. - Lädt die Images herunter und startet die Container.
- Öffnet Studio unter
http://localhost:3000, sobald es antwortet.
Option 2: Manuelle Einrichtung
mkdir pdf-redaction-studio && cd pdf-redaction-studio
curl -O https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/docker-compose.yaml
curl -O https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/.env.example
cp .env.example .envÖffnen Sie .env, setzen Sie PDF_REDACTION_LICENSE auf Ihren Lizenzschlüssel und starten Sie Studio:
docker compose up -dÖffnen Sie http://localhost:3000.
Ändern Sie die Standard-Secrets
.env.example enthält Beispielwerte für DATABASE_PASSWORD, SIGNING_KEY und NEXTAUTH_SECRET. Ersetzen Sie sie durch eigene lange Zufallswerte, bevor Sie echte Dokumente in Studio laden, zum Beispiel mit openssl rand -base64 32. Siehe Konfiguration.
Was läuft
| Container | Image | Port | Aufgabe |
|---|---|---|---|
studio | stabrise/pdf-redaction-studio-frontend | 3000 | Die Studio-Web-App |
backend | stabrise/pdf-redaction-studio-backend | 8000 | Konten, Workspaces, synchronisierte Dokumente; prüft die Lizenz |
api | stabrise/pdf-redaction-api | 8002 | PII-Erkennung. Modelle werden auf dem Host in ~/.cache/huggingface zwischengespeichert |
db | postgres | 5432 | Datenbank, gespeichert in ./data |
Erste Anmeldung
- Öffnen Sie
http://localhost:3000und wählen Sie Erstellen Sie Ihr Konto. Die Standard-.envverwendet die Anmeldung mit Benutzername und Passwort; die Konten werden auf Ihrem Server gespeichert. - Jedes neue Konto erhält einen Workspace Personal mit einem Projekt Default, wie im gehosteten Studio. Siehe Konto und Workspaces.
Das Backend legt beim ersten Start außerdem ein Django-Administrationskonto an, admin mit dem Passwort admin, unter http://localhost:8000/admin/. Melden Sie sich dort an und ändern Sie dieses Passwort sofort, oder entfernen Sie das Konto, wenn Sie es nicht brauchen.
Nützliche Befehle
| Befehl | Was er tut |
|---|---|
docker compose ps | Die Container und ihren Zustand anzeigen |
docker compose logs -f | Die Logs aller Container verfolgen |
docker compose logs -f backend | Die Logs eines Containers verfolgen, zum Beispiel die Lizenzprüfung |
docker compose restart | Alle Container neu starten, zum Beispiel nach einer Änderung an .env |
docker compose down | Die Container stoppen und entfernen. Ihre Daten in ./data bleiben erhalten |
Nächste Schritte
Dokumentbibliothek
So funktioniert die Dokumentbibliothek in Studio: Verarbeitungsstatus, Hintergrundverarbeitung, Speichern, Cloud-Synchronisierung und Lösen von Konflikten.
Konfiguration
Selbst gehostetes PDF Redaction Studio über .env konfigurieren: Lizenz, Secrets, Datenbank, öffentliche URLs Ihrer Domain, Anmeldemethoden und Erkennungs-API.