Konfiguracja
Konfiguracja PDF Redaction Studio na własnym serwerze w pliku .env: licencja, sekrety, baza danych, adresy dla domeny, metody logowania i adres API wykrywania.
Wszystkie ustawienia znajdują się w pliku .env obok docker-compose.yaml. Czyta go każdy kontener. Po zmianie zastosuj ją poleceniem:
docker compose up -dZmienne
| Zmienna | Używana przez | Wartość domyślna w .env.example | Co robi |
|---|---|---|---|
PDF_REDACTION_LICENSE | backend | pusta | Twój klucz licencyjny. Wymagany, zobacz Licencja |
DATABASE_HOST | backend | db | Host bazy danych. Zostaw db, aby korzystać z dołączonego kontenera Postgres |
DATABASE_PASSWORD | db, backend | wartość przykładowa | Hasło Postgres. Zmień je przed pierwszym uruchomieniem |
SIGNING_KEY | backend | wartość przykładowa | Podpisuje tokeny logowania. Zmień go na długą losową wartość |
ALLOWED_HOSTS | backend | localhost,backend,0.0.0.0,127.0.0.1 | Nazwy hostów, na które odpowiada backend. Dodaj domenę backendu |
CORS_ALLOWED_ORIGINS | backend | http://localhost:3000 | Adres aplikacji webowej Studio. Ustaw adres URL swojego Studio |
API_URL | studio | http://backend:8000 | Jak serwer Studio łączy się z backendem wewnątrz Dockera. Zwykle bez zmian |
NEXT_PUBLIC_API_URL | studio | http://127.0.0.1:8000 | Jak przeglądarki użytkowników łączą się z backendem |
NEXT_PUBLIC_PII_API_URL | studio | http://127.0.0.1:8002/api/deidentify/ner/text | Jak przeglądarki użytkowników łączą się z API wykrywania |
NEXTAUTH_URL | studio | http://localhost:3000/api/auth | Publiczny adres URL Studio z dopiskiem /api/auth |
NEXTAUTH_SECRET | studio | wartość przykładowa | Szyfruje sesje logowania. Zmień go na długą losową wartość |
NEXT_PUBLIC_AUTH_METHODS | studio | userpass | Metody logowania na stronie logowania, zobacz niżej |
PDF_REDACTION_API_LICENSE, PDF_REDACTION_API_OPENMETER_SOURCE | api | podane | Ustawienia API wykrywania. Zachowaj wartości z .env.example, chyba że wsparcie zaleci inaczej |
Losowe sekrety wygenerujesz poleceniem:
openssl rand -base64 32Studio we własnej domenie
Wartości domyślne działają tylko na komputerze, na którym działa Docker. Strona Studio w przeglądarce łączy się bezpośrednio z backendem i z API wykrywania, więc oba muszą być osiągalne z komputerów Twoich użytkowników.
Typowa konfiguracja umieszcza reverse proxy z HTTPS (nginx, Caddy lub Traefik) przed trzema publicznymi portami:
| Adres publiczny | Przekierowuje do |
|---|---|
https://studio.example.com | studio:3000 |
https://studio-api.example.com | backend:8000 |
https://studio-pii.example.com | api:8002 |
Następnie ustaw:
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,localhostNie wystawiaj bazy danych
Dla wygody docker-compose.yaml publikuje Postgres na porcie 5432. Na serwerze usuń ten wpis ports albo zablokuj port w zaporze, aby baza danych była dostępna tylko dla pozostałych kontenerów.
Metody logowania
NEXT_PUBLIC_AUTH_METHODS to lista wartości rozdzielonych przecinkami:
| Wartość | Metoda logowania |
|---|---|
userpass | Nazwa użytkownika i hasło przechowywane na Twoim serwerze (domyślnie) |
google | Konto Google. Wymaga własnego klienta Google OAuth |
microsoft | Konto Microsoft. Wymaga własnej aplikacji Microsoft Entra ID |
Aby włączyć logowanie przez Google lub Microsoft, utwórz aplikację OAuth z adresem przekierowania https://studio.example.com/api/auth/callback/google (lub /microsoft) i skontaktuj się z pomocą techniczną, aby otrzymać zmienne do dodania.
Gdzie działa wykrywanie
W Studio na własnym serwerze tryb PII w chmurze w ustawieniach wykrywania edytora wysyła tekst stron do kontenera api na Twoim serwerze, pod adres z NEXT_PUBLIC_PII_API_URL. Lokalny NER, wykrywanie oparte na regułach, OCR i wykrywanie twarzy działają w przeglądarce każdego użytkownika, jak we wszystkich produktach.
Następne kroki
Instalacja z Dockerem
Zainstaluj PDF Redaction Studio na własnym serwerze z Docker Compose: instalator jednym poleceniem lub ręcznie, klucz licencyjny, pierwsze logowanie, kontenery.
Licencja
Jak działa licencja PDF Redaction Studio na własnym serwerze: klucz próbny lub komercyjny, dodanie go do .env, co się dzieje po wygaśnięciu i jak go wymienić.