PDF Redaction
PDF Redaction Studio

Install with Docker

Install self-hosted PDF Redaction Studio with Docker Compose: one-line installer or manual setup, license key, first sign-in and the containers it runs.

Self-hosted Studio runs as four Docker containers on your own server. Documents and their text are processed by these containers; nothing is sent to pdf-redaction.com for detection.

Requirements

  • Linux, macOS or Windows (WSL 2) with Docker and Docker Compose v2.
  • About 6 GB of disk space for the images, plus space for the database and the detection models.
  • A license key. Get a free 14-day trial or a commercial license at pdf-redaction.com/licenses. See License.

Option 1: one-line installer

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

No curl? Use wget:

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

The installer:

  1. Creates a pdf-redaction-studio folder in the current directory and downloads docker-compose.yaml and .env.example into it.
  2. Copies .env.example to .env.
  3. Asks for your license key if .env doesn't have one, and opens the license page in your browser.
  4. Pulls the images and starts the containers.
  5. Opens Studio at http://localhost:3000 when it responds.

Option 2: manual setup

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

Open .env, set PDF_REDACTION_LICENSE to your license key, then start Studio:

docker compose up -d

Open http://localhost:3000.

Change the default secrets

.env.example ships with sample values for DATABASE_PASSWORD, SIGNING_KEY and NEXTAUTH_SECRET. Replace them with your own long random values before you put any real documents into Studio, for example with openssl rand -base64 32. See Configuration.

What runs

ContainerImagePortRole
studiostabrise/pdf-redaction-studio-frontend3000The Studio web app
backendstabrise/pdf-redaction-studio-backend8000Accounts, workspaces, synced documents; checks the license
apistabrise/pdf-redaction-api8002PII detection. Models are cached in ~/.cache/huggingface on the host
dbpostgres5432Database, stored in ./data

First sign-in

  1. Open http://localhost:3000 and choose Create your account. The default .env uses username and password sign-in, with accounts stored on your server.
  2. Each new account gets a Personal workspace with a Default project, the same as in the hosted Studio. See Account and workspaces.

The backend also creates a Django administration account on first start, admin with the password admin, at http://localhost:8000/admin/. Sign in there and change that password immediately, or remove the account if you don't need it.

Useful commands

CommandWhat it does
docker compose psShow the containers and their state
docker compose logs -fFollow the logs of all containers
docker compose logs -f backendFollow one container's logs, for example the license check
docker compose restartRestart all containers, for example after editing .env
docker compose downStop and remove the containers. Your data in ./data is kept

Next steps