nas-tools/config/config.yaml
2023-02-15 16:40:01 +08:00

287 lines
17 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 【配置注意要符合yaml语法:号后有1个空格不能使用全角标点符号】
# 【最新版本已经可以通过WEB页面对所有配置项进行配置推荐使用WEB页面进行配置】
# 【文件转移方式的说明】
# 目前支持的文件转移方式link、copy、softlink、move、rclone、rclonecopylink即硬链接、softlink为软链接、copy为复制、move为移动、rclone针对rclone网盘挂载rclone为移动、rclonecopy为复制
# link要求源目录和目的目录或媒体库目录在一个磁盘分区或者存储空间Docker运行时link模式需要直接映射源目录和目的目录或媒体库目录的上级目录否则docker可能仍然会认为是跨盘
# softlink模式注意宿主机的源目录映射到docker容器中后要路径要一致否则可能软链接成功但无法在宿主机使用
# copy模式会直接复制一份文件数据
# move会直接移动原文件会影响做种请谨慎使用
# rclone需要自行映射rclone配置目录到容器中或在容器内完成rclone配置
app:
# 【日志记录类型】server、file、console
# 如果是使用Docker安装建议设置为console通过Docker管理器查看日志
# 如果是使用群晖套件建议配置为 server可将日志输出到群晖的日志中心便于查看
# 其它情况可以设置为file将日志写入文件
logtype: console
# 【日志文件的路径】logtype为file时生效
logpath:
# 【群晖日志中心IP和端口】logtype为SERVER时生效。端口一般是514只需要改动IP为群晖的IP示例127.0.0.1:514
logserver: 127.0.0.1:514
# 【日志级别】info、debug、error
loglevel: info
# 【WEB管理界面监听地址】如需支持ipv6需设置为::,如::无法访问可改为0.0.0.0
web_host: "::"
# 【WEB管理界面端口】默认3000
web_port: 3000
# 【WEB管理页面登录用户】默认admin
login_user: admin
# 【WEB管理页面登录密码】默认password如果是全数字密码要用''括起来
login_password: password
# 【WEB管理界面使用的HTTPS的证书和KEY的路径】留空则不启用HTTPS
ssl_cert:
ssl_key:
# 【TMDB API KEY】需要在https://www.themoviedb.org/申请,必须配置,否则无法识别媒体资源和重命名
# 以下地址需要网络能够正常访问api.themoviedb.org、webservice.fanart.tv
rmt_tmdbkey:
# 【使用TMDB服务器域名】api.themoviedb.org、api.tmdb.org如api.themoviedb.org无法访问可偿试使用api.tmdb.org
tmdb_domain: api.tmdb.org
# 【TMDB匹配模式】normal、strictnormal模式下如使用文件名/种子名中的年份无法匹配到媒体信息会去掉年份再匹配一次strict模式则严格按文件中年份匹配
# normal模式下会提升识别成功率但也可能会导致误识别率增加strict模式可以降低误识别率但可能导致很多文件名/种子名中年份不正确的无法被识别(特别是剧集,需要是首播年份)
rmt_match_mode: normal
# 【设置代理】themoviedb、fanart、telegram等将使用代理访问http和https均需配置可以是http也可以是socks5、socks5h(remote DNS) 但需要带http或socks5前缀两项可以配置为一样留空则不启用
# 示例:'http://127.0.0.1:7890' 'socks5://127.0.0.1:8018' 'socks5h://127.0.0.1:8018'
proxies:
http:
https:
# 【本系统的WEB的外网地址】需要是外网IP或者域名需要包含端口用于微信/Telegram信息点击跳转如不需要可配空
# 示例http://IP:3000
domain: ""
# 【UserAgent】可适当修改用于站点签到、豆瓣数据抓取等
user_agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
# 【登录界面壁纸】themoviedb、bing设置为themoviedb时需要配置TMDB API Key时才生效
wallpaper: bing
# Debug mode
debug: true
# 开启后只有Releases更新才会有更新提示
releases_update_only: false
# 【配置媒体库信息】
media:
# 【媒体库管理软件】emby、jellyfin、plex需要在emby或jellyfin或plex区配置详细信息用于下载检查控重、媒体库展示等建议配置
media_server: emby
# 【媒体库数据同步周期】:定时同步媒体服务器数据到本地,单位小时
mediasync_interval: 12
# 【媒体库电影文件存放目录】:支持配置多个目录,不同的硬盘需映射为不同的根目录,以更于程序区分
movie_path:
# 【媒体库电视剧文件存放目录】:支持配置多个目录,不同的硬盘需映射为不同的根目录,以更于程序区分
tv_path:
# 【媒体库动漫文件单独存放目录】:支持配置多个目录,不同的硬盘需映射为不同的根目录,以更于程序区分
# 如果设置了该目录,则所有动漫电视剧都会识别为动漫并存放在该目录下,否则动漫电视剧会识别为电视剧并存放在电视剧目录分类下;动漫电影仍然在电影目录分类下
anime_path:
# 【无法识别时转移存放的目录】:如有多个磁盘,需要对应配置多个目录,否则跨盘无法硬链接
# 注意如果你在sync区域配置了未识别目录由会优先转移到对应未识别目录下只有下载文件转移及sync未配置未识别目录时才会使用该目录
# 未识别的记录同时会在媒体整理->手动识别下面出现unknown_path只是硬链接一份用于备份同时手工识别处理后程序也不会主动删除如果不想要多硬链接一份可以不配置该目录
unknown_path:
# 【二级分类开关】:电影/电视剧/动漫是否需要二级分类,启用二级分类后会在电影/电视剧/动漫目录下按二级分类名建立子目录
# 此处配置分类的策略名,配置文件目录中需要有与策略名同名的.yaml配置文件
# 默认策略default-category分类设置可参考"default-category.yaml"分类参见README.MD说明
# 如不需要启动分类,则该项配置为空
category: "default-category"
# 【转移到媒体库的最小文件大小】:避免预告片/MV等影响识别单位M
min_filesize: 150
# 【文件名转移忽略词】:文件名包含忽略词,忽略转移
ignored_files:
# 【文件路径转移忽略词】:文件路径包含忽略词,忽略转移
ignored_paths:
# 【洗版开关】:如开启则则新下载了更大的文件会覆盖媒体库目录中已有的文件
filesize_cover: true
# 【电影命名定义】:程序会按定义的命名格式对电影进行重命名;/代表上下级目录,{}内为占位符;占位符会使用文件识别出来的实际值替换;占位符外的字符会当成普通字符,直接体现在名称上
# 电影占位符有:{title}:标题,{en_title}:英文标题,{original_title}:原语种标题,{original_name}:原文件名,{year}:年份,{edition}:版本(Bluray/WEB-DL等){videoFormat}:分辨率(1080p/4k等){videoCodec}:视频编码,{audioCodec}:音频编码及声道,{effect}: 视频特效(DV,HDR等), {tmdbid}TMDB的ID{part}part1/disc1/dvd1{releaseGroup}:制作组/字幕组等
movie_name_format: "{title} ({year})/{title}-{part} ({year}) - {videoFormat}"
# 【电视剧命名定义】:程序会按定义的命名格式对电视剧进行重命名;/代表上下级目录,{}内为占位符;占位符会使用文件识别出来的实际值替换,占位符外的字符会当成普通字符,直接体现在名称上
# 电视剧占位符有:{title}:标题,{en_title}:英文标题,{original_title}:原语种标题,{original_name}:原文件名,{year}:年份,{edition}:版本(Bluray/WEB-DL等){videoFormat}:分辨率(1080p/4k等){videoCodec}:视频编码,{audioCodec}:音频编码及声道,{effect}: 视频特效(DV,HDR等), {tmdbid}TMDB的ID{season}:季数,{episode}:集数,{season_episode}剧集SxxExx{part}part1/disc1/dvd1{releaseGroup}:制作组/字幕组等
tv_name_format: "{title} ({year})/Season {season}/{title}-{part} - {season_episode} - 第{episode}集"
# 【刮削元数据及图片】开启后文件转移完成时会自动生成nfo描述文件及poster海报协助媒体服务器识别和搜刮
nfo_poster: false
# 【实时刷新媒体库】开启后文件转移完成时会实时刷新媒体服务器Emby/Jellyfin/Plex的媒体库
refresh_mediaserver: true
# 配置Emby服务器信息
emby:
# 【Emby服务器IP地址和端口】注意区分http和httpshttp时可以不加http://https时必须加https://
host: http://127.0.0.1:8096
# 【Emby ApiKey】在Emby设置->高级->API密钥处生成注意不要复制到了应用名称
api_key:
# 配置Jellyfin服务器信息
jellyfin:
# 【Jellyfin服务器IP地址和端口】注意区分http和httpshttp时可以不加http://https时必须加https://
host: http://127.0.0.1:8096
# 【Jellyfin ApiKey】在Jellyfin设置->高级->API密钥处生成
api_key:
# 配置Plex服务器信息
plex:
# 【Plex服务器IP地址和端口】注意区分http和httpshttp时可以不加http://https时必须加https://
host: http://127.0.0.1:32400
# 【X-Plex-Token】Plex页面Cookie中的X-Plex-Token如填写token则无需填写servername、username、password
token:
# 【Plex服务器的名称】
servername:
# 【Plex用户名】
username:
# 【Plex用户密码】
password:
# 【配置nfo刮削信息】
scraper_nfo:
# 电影
movie:
basic: true
credits: true
credits_chinese: true
# 电视剧
tv:
basic: true
credits: true
credits_chinese: true
# 季
season_basic: true
# 集
episode_basic: true
episode_credits: true
# 【配置图片刮削信息】
scraper_pic:
# 电影
movie:
poster: true
backdrop: true
background: true
logo: true
disc: true
banner: true
thumb: true
# 电视剧
tv:
poster: true
backdrop: true
background: true
logo: true
clearart: true
banner: true
thumb: true
# 季
season_poster: true
season_banner: true
season_thumb: true
# 集
episode_thumb: false
# 开启后,读取视频文件生成缩略图
episode_thumb_ffmpeg: false
# 【配置文件夹监控】:文件夹内容发生变化时自动识别转移
sync:
# 监控目录配置已转移至数据库
# 【监控目录操作系统类型】windows、linux。如果是windows目录同步功能性能会比较差会导致NAS不能休眠除非是挂载的windows的远程共享目录或者是windows的docker否则建议设置为linux
nas_sys: linux
# 【配置站点检索信息】
pt:
# 【下载使用的客户端软件】qbittorrent、transmission
pt_client: qbittorrent
# 【下载软件监控开关】是否监控下载软件true、false如为true则下载完成会自动转移和重命名如为false则不会处理
# 下载软件监控与Sync下载目录同步不要同时开启否则功能存在重复
pt_monitor: false
# 【只监控NASTool添加的下载】启用后只有NASTool添加的下载才会被自动转移和显示关闭则下载软件中所有的任务都会转移和显示
pt_monitor_only: true
# 【下载完成后转移到媒体库的转移模式】link、copy、softlink、move、rclone、rclonecopy、minio、miniocopy详情参考顶部说明
rmt_mode: link
#【聚合检索使用的检索器】builtin
search_indexer: builtin
# 【内建索引器使用的站点】:只有在该站点列表中内建索引器搜索时才会使用
indexer_sites:
# 【远程搜索自动择优下载开关】如开启则微信等渠道搜索后会自动择优选择一项下载如不开启则需要手工点击进入WEB页面选择下载
# 如没有配置app.domain或无公网环境建议开启否则无法跳转WEB页面手工选择
search_auto: true
# 【远程下载不完整自动订阅】如开启远程搜索下载不完整时会自动添加RSS订阅
search_no_result_rss: false
# 【站点每日签到时间】
# 两种配置方法1、配置间隔单位小时建议不要设置为24小时的整数倍避免每天的签到时间一样。2、配置固定时间如'08:00'注意要加引号和冒号。3、配置时间范围如08:00-09:00表示在该时间范围内随机执行一次
ptsignin_cron: "08:01"
# 【RSS订阅开关】此处配置RSS订阅检查时间间隔即每隔多长时间检查一下各站点是否有资源更新建议不要少于30分钟单位时间为秒
# 配置为空或者0则不启用RSS订阅功能
pt_check_interval: 1800
# 【定量搜索RSS开关】打开后每隔设置时间会通过站点资源检索的方式查询和下载订阅单位小时配置小于6小时时强制为6小时不配置则为关
search_rss_interval: 6
# 【下载优先规则】订阅及远程搜索下载将按此优先规则选择下载资源字典site 站点优先、seeder做种数优先
download_order: site
# 【搜索结果数量限制】:每个站点返回搜索结果的最大数量
site_search_result_num: 100
# 【配置qBittorrent下载软件】pt区的pt_client如配置为qbittorrent则需要同步配置该项
qbittorrent:
# 【qBittorrent IP地址和端口】注意如果qb启动了HTTPS证书则需要配置为https://IP
qbhost:
qbport:
# qBittorrent 登录用户名和密码
qbusername:
qbpassword:
# 转移完成后是否自动强制作种,按需要设置
force_upload: true
# 是否开始自动管理模式
auto_management: false
# 【配置transmission下载软件】pt区的pt_client如配置为transmission则需要同步配置该项需要3.0以上版本,否则可能会报错
transmission:
# 【transmission IP地址和端口】注意如果tr启用了HTTPS证书则需要配置为https://IP
trhost:
trport:
# transmission 登录用户名和密码
trusername:
trpassword:
# 【下载目录】:配置下载目录,自按分类下载到指定目录
downloaddir:
# 【配置豆瓣账号信息】:配置后会自动同步豆瓣收藏,豆瓣标记想看内容后,后台自动下载
douban:
# 【用户ID列表】豆瓣电影点个我主页people后面的那一串数字或者使用豆瓣App个人信息中查看。可以配置多个注意要加引号
# 这里可以是自己的也可以是别人的比如填写几个大V的账号ID实现热门影视自动下载
users:
- ""
# 【豆瓣Cookie】选配嫌麻烦的可以不用配置可能影响个别电影的同步
cookie:
# 【同步天数】:同步多少天内加入的数据
days: 30
# 【同步间隔】:多久同步一次数据,单位小时,建议不要太频繁,避免被检测到后封号
interval:
# 【同步数据类型】同步哪些类型的收藏数据do 在看wish 想看collect 看过,用逗号分隔配置
types: "wish"
# 【自动开载开关】:同步到豆瓣的数据后是否自动检索站点并下载
auto_search: true
# 【自动添加RSS开关】站点检索找不到的记录是否自动添加RSS订阅可实现未搜索到的自动追更
auto_rss: true
# 【配置安全】
security:
# 【媒体服务器webhook允许ip范围】即只有如下范围的IP才允许调用webhook
media_server_webhook_allow_ip:
ipv4: 0.0.0.0/0
ipv6: ::/0
# 【Telegram webhook允许ip范围】即只有如下范围的IP才允许调用webhook
telegram_webhook_allow_ip:
ipv4: 127.0.0.1
ipv6: ::/0
# 【Synology Chat webhook允许ip范围】即只有如下范围的IP才允许调用webhook
synology_webhook_allow_ip:
ipv4: 127.0.0.1
ipv6: ::/0
# 【API认证密钥】用于Jellyseerr、Overseerr中Authorization认证以及非客户端类的API调用
api_key:
# 【实验室】
laboratory:
# 【识别增强】关键字猜想
search_keyword: false
# 【识别增强】通过TMDB WEB检索
search_tmdbweb: false
# 【TMDB缓存过期策略】是否开启TMDB缓存过期策略默认7天过期过期缓存将被删除, 7天内访问过期时间可以被刷新
tmdb_cache_expire: true
# 【使用豆瓣名称联想】开启将使用豆瓣进行电影电视剧的名称联想否则使用TMDB的数据
use_douban_titles: false
# 【精确搜索使用英文名称】:开启后对于精确搜索场景(远程搜索、订阅搜索等)将会使用英文名检索站点资源以提升匹配度,但对有些站点资源标题全是中文的则需要关闭,否则匹配不到
search_en_title: true
# 【使用TMDB代理】
tmdb_proxy: false