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:
- Creates a
pdf-redaction-studiofolder in the current directory and downloadsdocker-compose.yamland.env.exampleinto it. - Copies
.env.exampleto.env. - Asks for your license key if
.envdoesn't have one, and opens the license page in your browser. - Pulls the images and starts the containers.
- Opens Studio at
http://localhost:3000when 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 .envOpen .env, set PDF_REDACTION_LICENSE to your license key, then start Studio:
docker compose up -dOpen 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
| Container | Image | Port | Role |
|---|---|---|---|
studio | stabrise/pdf-redaction-studio-frontend | 3000 | The Studio web app |
backend | stabrise/pdf-redaction-studio-backend | 8000 | Accounts, workspaces, synced documents; checks the license |
api | stabrise/pdf-redaction-api | 8002 | PII detection. Models are cached in ~/.cache/huggingface on the host |
db | postgres | 5432 | Database, stored in ./data |
First sign-in
- Open
http://localhost:3000and choose Create your account. The default.envuses username and password sign-in, with accounts stored on your server. - 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
| Command | What it does |
|---|---|
docker compose ps | Show the containers and their state |
docker compose logs -f | Follow the logs of all containers |
docker compose logs -f backend | Follow one container's logs, for example the license check |
docker compose restart | Restart all containers, for example after editing .env |
docker compose down | Stop and remove the containers. Your data in ./data is kept |
Next steps
Document library
How the Studio document library works: processing statuses, background processing, saving original and redacted PDFs, sync to cloud and resolving sync conflicts.
Configuration
Configure self-hosted PDF Redaction Studio through .env: license, secrets, database, public URLs for your domain, sign-in methods and the detection API endpoint.