基于FastApi + Vue3实现的流媒体自动化工具,同步GitHub，易于扩展和维护

# MoviePilot 基于 [NAStool](https://github.com/NAStool/nas-tools) 部分代码重新设计，聚焦自动化核心需求，减少问题同时更易于扩展和维护。 Docker：https://hub.docker.com/r/jxxghp/moviepilot 发布频道：https://t.me/moviepilot_channel ## 主要特性 - 前后端分离，基于FastApi + Vue3，前端项目地址：[MoviePilot-Frontend](https://github.com/jxxghp/MoviePilot-Frontend) - 聚焦核心需求，简化功能和设置，部分设置项可直接使用默认值。 - 重新设计了用户界面，更加美观易用。 ## 安装 1. **安装CookieCloud插件** 站点信息需要通过CookieCloud同步获取，因此需要安装CookieCloud插件，将浏览器中的站点Cookie数据同步到云端后再同步到MoviePilot使用。 插件下载地址请点击 [这里](https://github.com/easychen/CookieCloud/releases)。 2. **安装CookieCloud服务端（可选）** MoviePilot内置了公共CookieCloud服务器，如果需要自建服务，可参考 [CookieCloud](https://github.com/easychen/CookieCloud) 项目进行搭建，docker镜像请点击 [这里](https://hub.docker.com/r/easychen/cookiecloud)。 **声明：** 本项目不会收集用户敏感数据，Cookie同步也是基于CookieCloud项目实现，非本项目提供的能力。技术角度上CookieCloud采用端到端加密，在个人不泄露`用户KEY`和`端对端加密密码`的情况下第三方无法窃取任何用户信息（包括服务器持有者）。如果你不放心，可以不使用公共服务或者不使用本项目，但如果使用后发生了任何信息泄露与本项目无关！ 3. **安装配套管理软件** MoviePilot需要配套下载器和媒体服务器配合使用。 - 下载器支持：qBittorrent、Transmission，QB版本号要求>= 4.3.9，TR版本号要求>= 3.0，推荐使用QB。 - 媒体服务器支持：Jellyfin、Emby、Plex，推荐使用Emby。 4. **安装MoviePilot** 目前仅提供docker镜像，点击 [这里](https://hub.docker.com/r/jxxghp/moviepilot) 或执行命令： ```shell docker pull jxxghp/moviepilot:latest ``` ## 配置 项目的所有配置均通过环境变量进行设置，部分环境建立容器后会自动显示待配置项，如未自动显示配置项则需要手动增加对应环境变量。 配置文件映射路径：`/config` ### 1. **基础设置** - **PUID**：运行程序用户的`uid`，默认`0` - **PGID**：运行程序用户的`gid`，默认`0` - **UMASK**：掩码权限，默认`000`，可以考虑设置为`022` - **MOVIEPILOT_AUTO_UPDATE**：重启更新，`true`/`false`，默认`true` **注意：如果出现网络问题可以配置`PROXY_HOST`，具体看下方`PROXY_HOST`解释** - **NGINX_PORT：** WEB服务端口，默认`3000`，可自行修改，但不能为`3001` - **SUPERUSER：** 超级管理员用户名，默认`admin`，安装后使用该用户登录后台管理界面 - **SUPERUSER_PASSWORD：** 超级管理员初始密码，默认`password`，建议修改为复杂密码 - **API_TOKEN：** API密钥，默认`moviepilot`，在媒体服务器Webhook、微信回调等地址配置中需要加上`?token=`该值，建议修改为复杂字符串 - **PROXY_HOST：** 网络代理（可选），访问themoviedb或者重启更新需要使用代理访问，格式为`http(s)://ip:port` - **TMDB_API_DOMAIN：** TMDB API地址，默认`api.themoviedb.org`，也可配置为`api.tmdb.org`或其它中转代理服务地址，能连通即可 - **DOWNLOAD_PATH：** 下载保存目录，**注意：需要将`moviepilot`及`下载器`的映射路径保持一致**，否则会导致下载文件无法转移 - **DOWNLOAD_MOVIE_PATH：** 电影下载保存目录，**必须是`DOWNLOAD_PATH`的下级路径**，不设置则下载到`DOWNLOAD_PATH` - **DOWNLOAD_TV_PATH：** 电视剧下载保存目录，**必须是`DOWNLOAD_PATH`的下级路径**，不设置则下载到`DOWNLOAD_PATH` - **DOWNLOAD_ANIME_PATH：** 动漫下载保存目录，**必须是`DOWNLOAD_PATH`的下级路径**，不设置则下载到`DOWNLOAD_PATH` - **DOWNLOAD_CATEGORY：** 下载二级分类开关，`true`/`false`，默认`false`，开启后会根据配置`category.yaml`自动在下载目录下建立二级目录分类 - **DOWNLOAD_SUBTITLE：** 下载站点字幕，`true`/`false`，默认`true` - **REFRESH_MEDIASERVER：** 入库刷新媒体库，`true`/`false`，默认`true` - **SCRAP_METADATA：** 刮削入库的媒体文件，`true`/`false`，默认`true` - **SCRAP_FOLLOW_TMDB：** 新增已入库媒体是否跟随TMDB信息变化，`true`/`false`，默认`true` - **TORRENT_TAG：** 种子标签，默认为`MOVIEPILOT`，设置后只有MoviePilot添加的下载才会处理，留空所有下载器中的任务均会处理 - **LIBRARY_PATH：** 媒体库目录，多个目录使用`,`分隔 - **LIBRARY_MOVIE_NAME：** 电影媒体库目录名，默认`电影` - **LIBRARY_TV_NAME：** 电视剧媒体库目录名，默认`电视剧` - **LIBRARY_ANIME_NAME：** 动漫媒体库目录名，默认`电视剧/动漫` - **LIBRARY_CATEGORY：** 媒体库二级分类开关，`true`/`false`，默认`false`，开启后会根据配置`category.yaml`自动在媒体库目录下建立二级目录分类 - **TRANSFER_TYPE：** 转移方式，支持`link`/`copy`/`move`/`softlink` **注意：在`link`和`softlink`转移方式下，转移后的文件会继承源文件的权限掩码，不受`UMASK`影响** - **COOKIECLOUD_HOST：** CookieCloud服务器地址，格式：`http(s)://ip:port`，不配置默认使用内建服务器`https://movie-pilot.org/cookiecloud` - **COOKIECLOUD_KEY：** CookieCloud用户KEY - **COOKIECLOUD_PASSWORD：** CookieCloud端对端加密密码 - **COOKIECLOUD_INTERVAL：** CookieCloud同步间隔（分钟） - **OCR_HOST：** OCR识别服务器地址，格式：`http(s)://ip:port`，用于识别站点二维码实现自动登录获取Cookie等，不配置默认使用内建服务器`https://movie-pilot.org`，可使用 [这个镜像](https://hub.docker.com/r/jxxghp/moviepilot-ocr) 自行搭建。 - **USER_AGENT：** CookieCloud对应的浏览器UA，可选，设置后可增加连接站点的成功率，同步站点后可以在管理界面中修改 - **AUTO_DOWNLOAD_USER：** 交互搜索自动下载用户ID，使用,分割 - **SUBSCRIBE_SEARCH：** 订阅搜索，`true`/`false`，默认`false`，开启后会每隔24小时对所有订阅进行全量搜索，以补齐缺失剧集（一般情况下正常订阅即可，订阅搜索只做为兜底，会增加站点压力，不建议开启）。 - **MESSAGER：** 消息通知渠道，支持 `telegram`/`wechat`/`slack`，开启多个渠道时使用`,`分隔。同时还需要配置对应渠道的环境变量，非对应渠道的变量可删除，推荐使用`telegram` - `wechat`设置项： - **WECHAT_CORPID：** WeChat企业ID - **WECHAT_APP_SECRET：** WeChat应用Secret - **WECHAT_APP_ID：** WeChat应用ID - **WECHAT_TOKEN：** WeChat消息回调的Token - **WECHAT_ENCODING_AESKEY：** WeChat消息回调的EncodingAESKey - **WECHAT_ADMINS：** WeChat管理员列表，多个管理员用英文逗号分隔（可选） - **WECHAT_PROXY：** WeChat代理服务器（后面不要加/） - `telegram`设置项： - **TELEGRAM_TOKEN：** Telegram Bot Token - **TELEGRAM_CHAT_ID：** Telegram Chat ID - **TELEGRAM_USERS：** Telegram 用户ID，多个使用,分隔，只有用户ID在列表中才可以使用Bot，如未设置则均可以使用Bot - **TELEGRAM_ADMINS：** Telegram 管理员ID，多个使用,分隔，只有管理员才可以操作Bot菜单，如未设置则均可以操作菜单 - `slack`设置项： - **SLACK_OAUTH_TOKEN：** Slack Bot User OAuth Token - **SLACK_APP_TOKEN：** Slack App-Level Token - **SLACK_CHANNEL：** Slack 频道名称，默认`全体` - **DOWNLOADER：** 下载器，支持`qbittorrent`/`transmission`，QB版本号要求>= 4.3.9，TR版本号要求>= 3.0，同时还�