🎬 Debrid Media Bridge 🎬

📜 Description

Debrid Media Bridge (DMB) is an All-In-One (AIO) docker image for the unified deployment of Riven Media's, yowmamasita's, iPromKnight's, and ncw's projects -- Riven, zurg, zilean, and rclone.

⚠️ IMPORTANT: Docker Desktop CANNOT be used to run DMB. Docker Desktop does not support the mount propagation required for rclone mounts.

See the wiki for alternative solutions to run DMB on Windows through WSL2.

🌟 Features

See the DMB Wiki for a full list of features and settings.

🐳 Docker Hub

A prebuilt image is hosted on Docker Hub.

🏷️ GitHub Container Registry

A prebuilt image is hosted on GitHub Container Registry.

🛠️ Docker-compose

[!NOTE] The below examples are not exhaustive and are intended to provide a starting point for deployment. Additionally, the host directories used in the examples are based on Define the directory structure and provided for illustrative purposes and can be changed to suit your needs.

version: "3.8"

services:
  DMB:
    container_name: DMB
    image: iampuid0/dmb:latest
    ## Optionally, specify a specific version of DMB
    # image: iampuid0/dmb:2.0.0 #etc...
    stop_grace_period: 60s
    stdin_open: true # docker run -i
    tty: true        # docker run -t    
    volumes:
      ## Location of configuration files. If a Zurg config.yml and/or Zurg app is placed here, it will be used to override the default configuration and/or app used at startup. 
      - /home/username/docker/DMB/config:/config
      ## Location for logs
      - /home/username/docker/DMB/log:/log
      ## Location for Zurg RealDebrid active configuration
      - /home/username/docker/DMB/Zurg/RD:/zurg/RD
      ## Location for Zurg AllDebrid active configuration - Riven does not currently support AllDebrid   
      - /home/username/docker/DMB/Zurg/AD:/zurg/AD   
      ## Location for rclone mount to host
      - /home/username/docker/DMB/Zurg/mnt:/data:shared  
      ## Location for Riven backend data
      - /home/username/docker/DMB/Riven/data:/riven/backend/data
      ## Location for Riven symlinks
      - /home/username/docker/DMB/Riven/mnt:/mnt
      ## Location for PostgreSQL database if using Riven
      - /home/username/docker/DMB/PostgreSQL/data:/postgres_data
      ## Location for Zilean data if using Riven
      - /home/username/docker/DMB/Zilean/data:/zilean/app/data
    environment:
      - TZ=
      - PUID=
      - PGID=
      ## Zurg Required Settings
      - ZURG_ENABLED=true      
      - RD_API_KEY=
      ## Zurg Optional Settings
     # - ZURG_LOG_LEVEL=DEBUG
     # - GITHUB_TOKEN=       #Use with private Zurg repo
     # - ZURG_VERSION=v0.9.2-hotfix.4
     # - ZURG_UPDATE=true
     # - ZURG_USER=
     # - ZURG_PASS=
     # - ZURG_PORT=8800
      ## Rclone Required Settings
      - RCLONE_MOUNT_NAME=DMB
      ## Rclone Optional Settings - See rclone docs for full list
     # - NFS_ENABLED=true
     # - NFS_PORT=8000
     # - RCLONE_LOG_LEVEL=DEBUG
     # - RCLONE_LOGS=OFF
     # - RCLONE_CACHE_DIR=/cache
     # - RCLONE_DIR_CACHE_TIME=10s
     # - RCLONE_VFS_CACHE_MODE=full
     # - RCLONE_VFS_CACHE_MAX_SIZE=100G
     # - RCLONE_BUFFER_SIZE=32M
     # - RCLONE_VFS_CACHE_MAX_AGE=4h
      ## PostgreSQL Optional Settings
     # - POSTGRES_DATA=/postgres_data
     # - POSTGRES_USER=postgres
     # - POSTGRES_PASSWORD=postgres
     # - POSTGRES_DB=riven
      ## Zilean Required Settings
     # - ZILEAN_ENABLED=true
      ## Zilean Optional Settings
     # - ZILEAN_VERSION=v1.5.3
     # - ZILEAN_BRANCH=main
     # - ZILEAN_UPDATE=true
     # - ZILEAN_LOGS=OFF
      ## Riven Backend Required Settings
      - RIVEN_BACKEND_ENABLED=true
      ## Riven Frontend Required Settings
      - RIVEN_FRONTEND_ENABLED=true
      - ORIGIN=http://0.0.0.0:3000 # See Riven documentation for more details
      ## Riven Optional Settings
     # - RIVEN_ENABLED=true
     # - RIVEN_BACKEND_BRANCH=main
     # - RIVEN_FRONTEND_BRANCH=main
     # - RIVEN_BACKEND_VERSION=v0.8.4
     # - RIVEN_FRONTEND_VERSION=v0.2.5
     # - RIVEN_BACKEND_UPDATE=true
     # - RIVEN_FRONTEND_UPDATE=true
     # - RIVEN_LOG_LEVEL=DEBUG
     # - FRONTEND_LOGS=OFF
     # - BACKEND_LOGS=OFF
     # - HARD_RESET=true
     # - RIVEN_BACKEND_URL=
     # - RIVEN_DATABASE_HOST=
     # - RIVEN_DATABASE_URL= 
     # - RIVEN_FRONTEND_DIALECT=
     # - PLEX_TOKEN=
     # - PLEX_ADDRESS=
     # - SEERR_API_KEY=
     # - SEERR_ADDRESS=
      ## Special Features
     # - AUTO_UPDATE_INTERVAL=12
     # - DUPLICATE_CLEANUP=true
     # - CLEANUP_INTERVAL=1
     # - DMB_LOG_LEVEL=DEBUG  # Master log level for all program logs in DMB
     # - DMB_LOG_COUNT=2
     # - DMB_LOG_SIZE=10M
     # - COLOR_LOG_ENABLED=true
    # Example to attach to gluetun vpn container if realdebrid blocks IP address 
    # network_mode: container:gluetun  
    ports:
      - "3000:3000"
    devices:
      - /dev/fuse:/dev/fuse:rwm
    cap_add:
      - SYS_ADMIN     
    security_opt:
      - apparmor:unconfined    
      - no-new-privileges

🎥 Example Plex Docker-compose

[!NOTE] The Plex server must be started after the rclone mount is available. The below example uses the depends_on parameter to delay the start of the Plex server until the rclone mount is available. The rclone mount must be shared to the Plex container. The rclone mount location should not be added to the Plex library. The Riven symlink location must be shared to the Plex container and added to the Plex library.

version: "3.8"

services:
  plex:
    image: plexinc/pms-docker:latest
    container_name: plex
    devices:
      - /dev/dri:/dev/dri    
    volumes:
      - /home/username/docker/plex/library:/config
      - /home/username/docker/plex/transcode:/transcode
      - /home/username/docker/DMB/Zurg/mnt:/data # rclone mount location from DMB must be shared to Plex container. Don't add to plex library
      - /home/username/docker/DMB/Riven/mnt:/mnt  # Riven symlink location from DMB must be shared to Plex container. Add to plex library    
    environment:
      - TZ=${TZ}
    ports:
      - "32400:32400"
    depends_on:  # Used to delay the startup of plex to ensure the rclone mount is available.
      DMB: # set to the name of the container running rclone
        condition: service_healthy 

🔨 Docker Build

Docker CLI

docker build -t your-image-name https://github.com/I-am-PUID-0/DMB.git

🌐 Environment Variables

To customize some properties of the container, the following environment variables can be passed via the -e parameter (one for each variable), or via the docker-compose file within the environment: section, or with a .env file saved to the config directory -- See the wiki for more info on using the .env. Value of this parameter has the format <VARIABLE_NAME>=<VALUE>.

📂 Data Volumes

The following table describes the data volumes used by the container. The mappings are set via the -v parameter or via the docker-compose file within the volumes: section. Each mapping is specified with the following format: <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS].

🗝️ Docker Secrets

DMB supports the use of docker secrets for the following environment variables:

To utilize docker secrets, remove the associated environment variables from the docker-compose, create a file with the case-sensitive naming convention identified and secret value, then reference the file in the docker-compose file as shown below:

version: '3.8'

services:
  DMB:
    image: iampuid0/DMB:latest
    secrets:
      - github_token
      - rd_api_key
      - ad_api_key
      - plex_token
      - plex_address
      - seerr_api_key
      - seerr_address

secrets:
  github_token:
    file: ./path/to/github_token.txt
  rd_api_key:
    file: ./path/to/rd_api_key.txt
  ad_api_key:
    file: ./path/to/ad_api_key.txt
  plex_token:
    file: ./path/to/plex_token.txt
  plex_address:
    file: ./path/to/plex_address.txt
  seerr_api_key:
    file: ./path/to/seerr_api_key.txt
  seerr_address:
    file: ./path/to/seerr_address.txt

📝 TODO

See the DMB roadmap for a list of planned features and enhancements.

🚀 Deployment

DMB allows for the simultaneous or individual deployment of Riven and/or Zurg w/ rclone

For additional details on deployment, see the DMB Wiki

🌍 Community

DMB

• For questions related to DMB, see the GitHub discussions
• or create a new issue if you find a bug or have an idea for an improvement.
• or join the DMB discord server

Riven Media

• For questions related to Riven, see the GitHub discussions
• or create a new issue if you find a bug or have an idea for an improvement.
• or join the Riven discord server

🍻 Buy Riven Media a beer/coffee? :)

If you enjoy the underlying projects and want to buy Riven Media a beer/coffee, feel free to use the GitHub sponsor link

🍻 Buy yowmamasita a beer/coffee? :)

If you enjoy the underlying projects and want to buy yowmamasita a beer/coffee, feel free to use the GitHub sponsor link

🍻 Buy ncw a beer/coffee? :)

If you enjoy the underlying projects and want to buy Nick Craig-Wood a beer/coffee, feel free to use the website's sponsor links

✅ GitHub Workflow Status