fix README.md

2023-11-27 08:17:23 +08:00
parent dd5b8219a1
commit 83c8d619d0
2 changed files with 182 additions and 184 deletions
--- a/config/app.env
+++ b/config/app.env
@ -3,9 +3,9 @@
 #######################################################################

 ####################################
-#  基础设置                         #
+#  系统设置                         #
 ####################################
-# 【*】API监听地址
+# 【*】API监听地址（注意不是前端访问地址）
 HOST=0.0.0.0
 # 是否调试模式，打开后将输出更多日志
 DEBUG=false
@ -15,6 +15,88 @@ DEV=false
 SUPERUSER=admin
 # 【*】超级管理员初始密码，设置后一但重启将固化到数据库中，修改将无效
 SUPERUSER_PASSWORD=password
+# 大内存模式，开启后会增加缓存数量，但会占用更多内存
+BIG_MEMORY_MODE=false
+# 自动检查和更新站点资源包（索引、认证等）
+AUTO_UPDATE_RESOURCE=true
+
+####################################
+#   消息通知渠道（按需配置）          #
+####################################
+# WeChat企业ID
+WECHAT_CORPID=
+# WeChat应用Secret
+WECHAT_APP_SECRET=
+# WeChat应用ID
+WECHAT_APP_ID=
+# WeChat代理服务器，无需代理需保留默认值
+WECHAT_PROXY=https://qyapi.weixin.qq.com
+# WeChat Token
+WECHAT_TOKEN=
+# WeChat EncodingAESKey
+WECHAT_ENCODING_AESKEY=
+# WeChat 管理员
+WECHAT_ADMINS=
+# Telegram Bot Token
+TELEGRAM_TOKEN=
+# Telegram Chat ID
+TELEGRAM_CHAT_ID=
+# Telegram 用户ID，使用,分隔
+TELEGRAM_USERS=
+# Telegram 管理员ID，使用,分隔
+TELEGRAM_ADMINS=
+# Slack Bot User OAuth Token
+SLACK_OAUTH_TOKEN=
+# Slack App-Level Token
+SLACK_APP_TOKEN=
+# Slack 频道名称
+SLACK_CHANNEL=
+# SynologyChat Webhook
+SYNOLOGYCHAT_WEBHOOK=
+# SynologyChat Token
+SYNOLOGYCHAT_TOKEN=
+
+####################################
+#   下载器（按需配置）               #
+####################################
+# Qbittorrent地址，IP:PORT
+QB_HOST=
+# Qbittorrent用户名
+QB_USER=
+# Qbittorrent密码
+QB_PASSWORD=
+# Qbittorrent分类自动管理
+QB_CATEGORY=false
+# Qbittorrent按顺序下载
+QB_SEQUENTIAL=true
+# Qbittorrent忽略队列限制，强制继续
+QB_FORCE_RESUME=false
+# Transmission地址，IP:PORT
+TR_HOST=
+# Transmission用户名
+TR_USER=
+# Transmission密码
+TR_PASSWORD=
+
+####################################
+#   媒体服务器（按需配置）            #
+####################################
+# EMBY服务器地址，IP:PORT
+EMBY_HOST=
+# EMBY Api Key
+EMBY_API_KEY=
+# Jellyfin服务器地址，IP:PORT
+JELLYFIN_HOST=
+# Jellyfin Api Key
+JELLYFIN_API_KEY=
+# Plex服务器地址，IP:PORT
+PLEX_HOST=
+# Plex Token
+PLEX_TOKEN=
+
+####################################
+#  基础设置                         #
+####################################
 # 【*】API密钥，建议更换复杂字符串，有Jellyseerr/Overseerr、媒体服务器Webhook等配置以及部分支持API_TOKEN的API中使用
 API_TOKEN=moviepilot
 # 登录页面电影海报，tmdb/bing，tmdb要求能正常连接api.themoviedb.org
@ -25,10 +107,18 @@ TMDB_IMAGE_DOMAIN=image.tmdb.org
 TMDB_API_DOMAIN=api.themoviedb.org
 # 媒体识别来源 themoviedb/douban，使用themoviedb时需要确保能正常连接api.themoviedb.org，使用douban时不支持二级分类
 RECOGNIZE_SOURCE=themoviedb
-# 大内存模式，开启后会增加缓存数量，但会占用更多内存
-BIG_MEMORY_MODE=false
-# 自动检查和更新站点资源包（索引、认证等）
-AUTO_UPDATE_RESOURCE=true
+# 【*】消息通知渠道 telegram/wechat/slack，多个通知渠道用,分隔，需要在上面配置对应消息通知渠道的参数
+MESSAGER=telegram
+# 【*】下载器 qbittorrent/transmission，仅支持单个下载器，做为主下载器使用，需要在上面配置对应消下载器的参数
+DOWNLOADER=qbittorrent
+# 下载器监控开关
+DOWNLOADER_MONITOR=true
+# 【*】媒体服务器 emby/jellyfin/plex，多个媒体服务器,分割
+MEDIASERVER=emby
+# 媒体服务器同步间隔（小时）
+MEDIASERVER_SYNC_INTERVAL=6
+# 媒体服务器同步黑名单，多个媒体库名称,分割
+MEDIASERVER_SYNC_BLACKLIST=

 ####################################
 #  媒体识别&刮削                     #
@ -41,7 +131,7 @@ SCRAP_FOLLOW_TMDB=true
 SCRAP_SOURCE=themoviedb

 ####################################
-#   媒体库                          #
+#   文件整理 & 媒体库                #
 ####################################
 # 【*】转移方式 link/copy/move/softlink/rclone_copy/rclone_move
 TRANSFER_TYPE=copy
@ -88,69 +178,9 @@ SUBSCRIBE_SEARCH=false
 # 交互搜索自动下载用户ID（消息通知渠道的用户ID），使用,分割，未设置需要用户手动选择资源或者回复`0`
 AUTO_DOWNLOAD_USER=

-####################################
-#   消息通知                        #
-####################################
-# 【*】消息通知渠道 telegram/wechat/slack，多个通知渠道用,分隔
-MESSAGER=telegram
-# WeChat企业ID
-WECHAT_CORPID=
-# WeChat应用Secret
-WECHAT_APP_SECRET=
-# WeChat应用ID
-WECHAT_APP_ID=
-# WeChat代理服务器，无需代理需保留默认值
-WECHAT_PROXY=https://qyapi.weixin.qq.com
-# WeChat Token
-WECHAT_TOKEN=
-# WeChat EncodingAESKey
-WECHAT_ENCODING_AESKEY=
-# WeChat 管理员
-WECHAT_ADMINS=
-# Telegram Bot Token
-TELEGRAM_TOKEN=
-# Telegram Chat ID
-TELEGRAM_CHAT_ID=
-# Telegram 用户ID，使用,分隔
-TELEGRAM_USERS=
-# Telegram 管理员ID，使用,分隔
-TELEGRAM_ADMINS=
-# Slack Bot User OAuth Token
-SLACK_OAUTH_TOKEN=
-# Slack App-Level Token
-SLACK_APP_TOKEN=
-# Slack 频道名称
-SLACK_CHANNEL=
-# SynologyChat Webhook
-SYNOLOGYCHAT_WEBHOOK=
-# SynologyChat Token
-SYNOLOGYCHAT_TOKEN=
-
 ####################################
 #   下载                           #
 ####################################
-# 【*】下载器 qbittorrent/transmission，仅支持单个下载器，做为主下载器使用，非主下载器只要配置了参数仍可在插件等使用
-DOWNLOADER=qbittorrent
-# 下载器监控开关
-DOWNLOADER_MONITOR=true
-# Qbittorrent地址，IP:PORT
-QB_HOST=
-# Qbittorrent用户名
-QB_USER=
-# Qbittorrent密码
-QB_PASSWORD=
-# Qbittorrent分类自动管理
-QB_CATEGORY=false
-# Qbittorrent按顺序下载
-QB_SEQUENTIAL=true
-# Qbittorrent忽略队列限制，强制继续
-QB_FORCE_RESUME=false
-# Transmission地址，IP:PORT
-TR_HOST=
-# Transmission用户名
-TR_USER=
-# Transmission密码
-TR_PASSWORD=
 # 种子标签
 TORRENT_TAG=MOVIEPILOT
 # 【*】下载保存目录，容器内映射路径需要一致，支持不同类型设置不同的下载目录（跨盘）
@ -163,36 +193,14 @@ DOWNLOAD_TV_PATH=
 DOWNLOAD_ANIME_PATH=
 # 下载目录二级分类，开启后会根据配置 [category.yaml](https://github.com/jxxghp/MoviePilot/raw/main/config/category.yaml) 自动在下载目录下建立二级目录分类
 DOWNLOAD_CATEGORY=false
-# 下载站点字幕
+# 自动下载站点字幕（如有）
 DOWNLOAD_SUBTITLE=true

 ####################################
-#   媒体服务器                      #
-####################################
-# 【*】媒体服务器 emby/jellyfin/plex，多个媒体服务器,分割
-MEDIASERVER=emby
-# 媒体服务器同步间隔（小时）
-MEDIASERVER_SYNC_INTERVAL=6
-# 媒体服务器同步黑名单，多个媒体库名称,分割
-MEDIASERVER_SYNC_BLACKLIST=
-# EMBY服务器地址，IP:PORT
-EMBY_HOST=
-# EMBY Api Key
-EMBY_API_KEY=
-# Jellyfin服务器地址，IP:PORT
-JELLYFIN_HOST=
-# Jellyfin Api Key
-JELLYFIN_API_KEY=
-# Plex服务器地址，IP:PORT
-PLEX_HOST=
-# Plex Token
-PLEX_TOKEN=
-
-####################################
-#   第三方服务                      #
+#   扩展                           #
 ####################################
 # OCR服务器地址
 OCR_HOST=https://movie-pilot.org
 # 插件市场仓库地址，多个地址使用`,`分隔，保留最后的/
-PLUGIN_MARKET=https://github.com/jxxghp/MoviePilot-Plugins/
+PLUGIN_MARKET=https://github.com/jxxghp/MoviePilot-Plugins