Quick Start

Quick Start

This is the shortest path from zero to a working Censorarr 1.6.5 install.

1. Download or clone Censorarr

git clone https://github.com/leestow/Censorarr.git
cd Censorarr

On Synology, you can instead download/extract the repository into a Container Manager project folder such as:

/volume1/docker/censorarr

2. Edit docker-compose.yml

At minimum change:

• TZ
• PUID
• PGID
• the left side of the Movies volume
• the left side of the TV Shows volume, if used

Example:

environment:
  TZ: America/Chicago
  PUID: "1026"
  PGID: "100"
  UMASK: "002"
  CENSORARR_SYNOLOGY_COMPAT_MODE: "auto"

volumes:
  - /volume1/Movies:/media:rw
  - /volume1/TV Shows:/tv:rw

The shipped application/config/work mounts are relative to the project folder and normally should not be changed:

- ./app:/app
- ./config:/config
- ./work:/work

3. Start Censorarr

docker compose up -d --build

The shipped browser mapping is:

8087:8787

so the UI is normally:

http://SERVER-IP:8087

4. Complete the Setup Wizard

A fresh install stays idle until the wizard is completed.

Recommended first-pass choices:

• Movies folder: /media
• TV folder: /tv if used
• Dry Run: On
• Transcription: local CPU
• Plex: Skip
• Radarr/Sonarr: Skip
• Bazarr: Skip

This validates the standalone core before adding integrations.

5. Watch the logs

docker compose logs -f

or:

docker logs -f censorarr

You should see the media preflight pass before Whisper loads.

6. Test a small media set

Dry Run still needs to read the source media, but it does not perform the final media replacement.

Once detection looks correct, enable Apply mode.

7. Optional: add the GPU Worker

See Transcription & GPU Worker.

8. Run the self-test

docker exec -it censorarr python /app/selftest.py

A healthy 1.6.5 install should end with:

Censorarr v1.6.5 self-test: ALL PASS