Skip to content

Installation

cli_debrid runs as a Docker container and is the recommended installation method for all platforms. A Windows executable is also available for users who prefer not to use Docker.

Choose your platform

  • Docker

    Recommended. Works on any Linux, macOS, or Windows host with Docker installed. The most reliable and easiest to update.

    Docker Guide

  • Unraid

    Install via Community Applications or Compose Manager.

    Unraid Guide

  • Portainer / Dockge / Dockhand

    Install using any Docker compose GUI — works on any platform.

    Portainer / Dockge / Dockhand Guide

  • Ubuntu / Debian

    Bare-metal or VM install using Docker Engine on Ubuntu or Debian.

    Ubuntu / Debian Guide

  • Proxmox

    Run inside a Debian/Ubuntu LXC container or VM with Docker.

    Proxmox Guide

  • TrueNAS

    Deploy via Custom App (SCALE) or inside a Linux VM (CORE).

    TrueNAS Guide

  • Windows

    Native Windows executable — no Docker required. Best for users running directly on Windows without a NAS or server.

    Windows Guide

Before you begin

Regardless of platform, you will need the following before setting up cli_debrid:

Requirement Notes
Debrid account Real-Debrid, AllDebrid, Premiumize, Torbox, or Debrid-Link
Plex, Jellyfin, or Emby For library management and media scanning
Mount tool Zurg + rclone or Decypharr to mount your debrid storage as a local filesystem

Set up your mount first

cli_debrid needs your debrid storage mounted as a local filesystem before it can manage your library. Set up Zurg + rclone or Decypharr before installing cli_debrid.

Community quick-install script

For experienced Linux users who want to get a full stack running in one go, there is a community-maintained setup script that automates the entire process.

Review before running

This script is not officially maintained by the cli_debrid project — it is a community contribution. It runs as root and installs Docker, rclone, and multiple containers automatically. Review the script before running it on any system you care about.

The script handles:

  • Docker and rclone installation
  • OS and architecture detection
  • Interactive selection of media server, request manager, and optional components
  • Full docker-compose.yml generation
  • Backup, restore, update, and repair utilities
sudo curl -sO https://raw.githubusercontent.com/delete2020/cli_debrid-setup-/main/setup.sh && sudo chmod +x setup.sh && sudo ./setup.sh

Updating

Once installed, see the Updating guide to keep cli_debrid current.