Plex Autoscan 安装与配置指南
项目简介
Plex Autoscan 是一个辅助工具,专为 Sonarr、Radarr 用户设计,用于优化 Plex 媒体服务器的扫描流程。当新媒体导入特定文件夹时,该脚本仅扫描该导入的文件夹而非整个库区,提高效率。此项目基于 Python 编写,适用于多种操作系统环境。
1. 项目目录结构及介绍
plex_autoscan/
│
├── config/ # 配置文件夹,包含默认和自定义配置文件。
│ └── config.json # 主配置文件,用户需按需调整设置。
│
├── system/ # 系统相关文件,如服务管理脚本。
│ └── plex_autoscan.service # systemd 服务文件,用于自动化启动。
│
├── requirements.txt # Python 包依赖列表,安装脚本将依据此文件安装依赖。
└── plex.py # 核心脚本,实现了与 Plex 的交互逻辑,包括扫描触发等关键功能。
2. 项目的启动文件介绍
plex.py: 此文件是项目的主程序,负责执行媒体扫描操作。它能够自动检测媒体变更并通知 Plex 进行局部扫描。通过命令行参数调用它可以实现不同的功能,例如手动触发扫描或管理配置。对于日常使用,您可能不需要直接编辑此文件,而是通过配置文件来定制其行为,并利用提供的系统服务或脚本来启动它。
3. 项目的配置文件介绍
config.json: 这是项目的核心配置文件,包含了 Plex 服务器的信息、扫描行为设定、以及第三方服务(如 Rclone)的配置等。用户需要对这个文件进行个性化调整以符合自己的需求:
- PLEX_SUPPORT_DIR: 指定 Plex 媒体支持目录路径,通常无需更改除非您的安装位置非标准。
- PLEX_TOKEN: Plex API 访问令牌,用于无密码交互。
- RCLONE: 若使用 Rclone,此处配置 Rclone 相关参数,包括二进制路径、配置文件路径和加密映射等。
- SERVER_IGNORE_LIST: 忽略特定文件或文件夹,避免不必要的扫描。
- SERVER_FILE_EXIST_PATH_MAPPINGS: 文件存在路径映射,用于处理挂载点或网络存储的不同路径表示。
配置修改提示
- 修改前确保备份原配置文件。
- 根据项目说明调整配置项,特别是在使用 Rclone 或特定服务器设置时需仔细阅读注释。
- 配置更改后需重启
plex_autoscan
服务以应用新设置。
通过上述步骤,您可以顺利部署并配置 Plex Autoscan,从而提升您的媒体管理效率。记得在执行任何系统级操作(如复制服务文件或启用服务)之前,确保具备相应权限,并遵循项目文档中的安全最佳实践。