shayaantx/botdarr

botdarr Docker镜像文档

镜像概述

botdarr是一款专注于自动化媒体管理的工具，旨在通过集成Plex、Sonarr、Radarr等主流媒体服务，实现媒体内容的自动化获取、整理与管理。该工具支持通过或聊天机器人接口接收用户的媒体请求，自动完成内容搜索、下载队列添加及媒体库更新等操作，有效降低个人媒体库的维护成本。

核心功能与特性

媒体服务集成

• 多平台兼容：无缝对接Plex媒体服务器、Sonarr（电视剧管理）、Radarr（电影管理）及下载工具（如Transmission、qBittorrent）。
• 状态同步：实时同步媒体库状态，确保Plex、Sonarr/Radarr中的媒体信息一致。

聊天机器人交互

• 多渠道支持：提供***、***聊天机器人接口，用户可直接通过聊天工具发送媒体请求（如“添加电影《盗梦空间》”）。
• 智能响应：自动解析用户请求，返回搜索结果、下载进度及入库状态。

自动化媒体管理

• 自动搜索：对接索引器（如Jackett、***）搜索媒体资源，支持自定义搜索规则。
• 下载调度：自动将符合条件的媒体添加至Sonarr/Radarr下载队列，支持优先级设置。
• 内容整理：按预设规则（如文件名、分类）自动整理下载后的媒体文件，确保Plex媒体库结构规范。

使用场景与适用范围

适用场景

• 个人媒体库维护：适合拥有Plex服务器的用户，简化电影、电视剧的下载与管理流程。
• 家庭媒体共享：支持多用户通过聊天工具提交请求，满足家庭成员的媒体需求。
• 小型媒体服务团队：为小型社区或团队提供统一的媒体请求与管理入口。

适用人群

• Plex/Sonarr/Radarr用户
• 需要自动化管理媒体库的个人或家庭用户
• 希望通过聊天工具便捷获取媒体内容的用户

使用方法与配置说明

环境要求

• Docker Engine 20.10+
• 网络可访问Plex、Sonarr、Radarr服务及外部索引器
• 已配置或机器人（获取API Token）

配置参数（环境变量）

Docker Run示例

bash
docker run -d \
  --name botdarr \
  -e PLEX_URL="http://plex:32400" \
  -e PLEX_TOKEN="abc123def456" \
  -e SONARR_URL="http://sonarr:8989" \
  -e SONARR_API_KEY="xyz789uvw012" \
  -e RADARR_URL="http://radarr:7878" \
  -e RADARR_API_KEY="pqr345stu678" \
  -e DISCORD_BOT_TOKEN="MTExMjIyMzM0NDU1NjY3ODg5Ng.Ghijk.lmnop" \
  -e INDEXER_URL="http://jackett:9117" \
  -e INDEXER_API_KEY="jkl456mno789" \
  -v /path/to/botdarr/config:/app/config \
  shayaantx/botdarr:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  botdarr:
    image: shayaantx/botdarr:latest
    container_name: botdarr
    environment:
      - PLEX_URL=http://plex:32400
      - PLEX_TOKEN=abc123def456
      - SONARR_URL=http://sonarr:8989
      - SONARR_API_KEY=xyz789uvw012
      - RADARR_URL=http://radarr:7878
      - RADARR_API_KEY=pqr345stu678
      - DISCORD_BOT_TOKEN=MTExMjIyMzM0NDU1NjY3ODg5Ng.Ghijk.lmnop
      - INDEXER_URL=http://jackett:9117
      - INDEXER_API_KEY=jkl456mno789
    volumes:
      - /path/to/botdarr/config:/app/config
    restart: unless-stopped
    depends_on:
      - sonarr
      - radarr
      - jackett

  # 关联服务示例（需单独配置）
  sonarr:
    image: linuxserver/sonarr:latest
    # 省略Sonarr配置...
  
  radarr:
    image: linuxserver/radarr:latest
    # 省略Radarr配置...
  
  jackett:
    image: linuxserver/jackett:latest
    # 省略Jackett配置...

配置文件说明

容器内/app/config目录下可存放自定义配置文件（如config.yaml），用于精细化设置搜索规则、响应模板、用户权限等。具体配置项可参考https://github.com/shayaantx/botdarr%E3%80%82

注意事项

• 首次启动需确保所有关联服务（Plex、Sonarr等）已正常运行并可访问。
• ***/***机器人需完成权限配置，确保能接收用户消息并发送回复。
• 索引器需预先配置媒体资源站点，以确保搜索功能正常工作。