Skip to main content

Quick Start

The fastest way to get started with Cleanuparr:

🐳 Docker (Recommended)​

Option 1: Docker Run

docker run -d --name cleanuparr \
  --restart unless-stopped \
  -p 11011:11011 \
  -v /path/to/config:/config \
  -e PORT=11011 \
  -e BASE_PATH= \
  -e PUID=1000 \
  -e PGID=1000 \
  -e UMASK=022 \
  -e TZ=Etc/UTC \
  ghcr.io/cleanuparr/cleanuparr:latest

Option 2: Docker Compose

services:
  cleanuparr:
    image: ghcr.io/cleanuparr/cleanuparr:latest
    container_name: cleanuparr
    restart: unless-stopped
    ports:
      - "11011:11011"
    volumes:
      - /path/to/config:/config
    environment:
      - PORT=11011
      - BASE_PATH=
      - PUID=1000
      - PGID=1000
      - UMASK=022
      - TZ=Etc/UTC

Unraid​

Use the Unraid template available in the Community Applications plugin. If the template is not yet available, you can manually add using the above Docker Compose configuration or use this guide to create a custom template:

  1. Download the template from here: https://github.com/Cleanuparr/unraid/blob/main/templates/Cleanuparr.xml
  2. Rename the downloaded file to 'my-cleanuparr.xml'
  3. Drop it in the /boot/config/plugins/dockerMan/templates-user/ folder of your Unraid machine
  4. Go to the Docker tab of the Unraid webui
  5. Click on Add Container
  6. From the Template dropdown menu, select cleanuparr
  7. Set the repository to ghcr.io/cleanuparr/cleanuparr:latest
  8. Most other settings can be left at default, with the exception of the downloads folder which should be mapped to where your *arr stack / torrent client downloads its files to

🖥️ Other Installation Methods​

  • Windows: Download the installer from GitHub Releases
  • macOS: Download the .pkg installer for your Mac type (Intel/Apple Silicon)
  • Linux: Download and extract the portable executable
Note

For detailed installation instructions, security notes, troubleshooting, and all platform-specific options, see the Complete Installation Guide.

🚀 After Installation​

  1. Open your browser and go to http://localhost:11011
  2. Configure your download clients and *arr applications
  3. Refer to the Configuration section for detailed setup instructions