PDF Redaction
PDF Redaction Studio

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.

Studio na własnym serwerze działa jako cztery kontenery Docker. Dokumenty i ich tekst przetwarzają te kontenery; nic nie jest wysyłane do pdf-redaction.com w celu wykrywania.

Wymagania

  • Linux, macOS lub Windows (WSL 2) z Dockerem i Docker Compose v2.
  • Około 6 GB miejsca na dysku na obrazy oraz miejsce na bazę danych i modele wykrywania.
  • Klucz licencyjny. Darmową 14-dniową licencję próbną lub licencję komercyjną uzyskasz na pdf-redaction.com/licenses. Zobacz Licencja.

Opcja 1: instalator jednym poleceniem

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/install.sh)"

Nie masz curl? Użyj wget:

/bin/bash -c "$(wget -qO- https://raw.githubusercontent.com/StabRise/pdf-redaction-studio/main/install.sh)"

Instalator:

  1. Tworzy folder pdf-redaction-studio w bieżącym katalogu i pobiera do niego docker-compose.yaml oraz .env.example.
  2. Kopiuje .env.example do .env.
  3. Prosi o klucz licencyjny, jeśli .env go nie zawiera, i otwiera stronę licencji w przeglądarce.
  4. Pobiera obrazy i uruchamia kontenery.
  5. Otwiera Studio pod adresem http://localhost:3000, gdy zacznie odpowiadać.

Opcja 2: instalacja ręczna

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

Otwórz .env, ustaw w PDF_REDACTION_LICENSE swój klucz licencyjny, a następnie uruchom Studio:

docker compose up -d

Otwórz http://localhost:3000.

Zmień domyślne sekrety

.env.example zawiera przykładowe wartości DATABASE_PASSWORD, SIGNING_KEY i NEXTAUTH_SECRET. Zastąp je własnymi, długimi losowymi wartościami, zanim umieścisz w Studio prawdziwe dokumenty, np. za pomocą openssl rand -base64 32. Zobacz Konfiguracja.

Co jest uruchamiane

KontenerObrazPortRola
studiostabrise/pdf-redaction-studio-frontend3000Aplikacja webowa Studio
backendstabrise/pdf-redaction-studio-backend8000Konta, przestrzenie robocze, zsynchronizowane dokumenty; sprawdza licencję
apistabrise/pdf-redaction-api8002Wykrywanie PII. Modele są przechowywane w ~/.cache/huggingface na hoście
dbpostgres5432Baza danych, zapisywana w ./data

Pierwsze logowanie

  1. Otwórz http://localhost:3000 i wybierz Utwórz konto. Domyślny .env używa logowania nazwą użytkownika i hasłem, a konta są przechowywane na Twoim serwerze.
  2. Każde nowe konto otrzymuje przestrzeń roboczą Personal z projektem Default, tak samo jak w Studio w chmurze. Zobacz Konto i przestrzenie robocze.

Przy pierwszym uruchomieniu backend tworzy też konto administracyjne Django admin z hasłem admin pod adresem http://localhost:8000/admin/. Zaloguj się tam i od razu zmień to hasło albo usuń konto, jeśli go nie potrzebujesz.

Przydatne polecenia

PolecenieCo robi
docker compose psPokazuje kontenery i ich stan
docker compose logs -fŚledzi logi wszystkich kontenerów
docker compose logs -f backendŚledzi logi jednego kontenera, np. sprawdzanie licencji
docker compose restartRestartuje wszystkie kontenery, np. po edycji .env
docker compose downZatrzymuje i usuwa kontenery. Twoje dane w ./data zostają zachowane

Następne kroki