Back to Iptv Api

配置参数

docs/config.md

3.0.019.3 KB
Original Source

配置参数

<p align="center"> <a href="../README.md">项目首页</a> · <a href="./README.md">文档中心</a> · <a href="./tutorial.md">使用教程</a> · 中文 | <a href="./config_en.md">English</a> </p>

[!NOTE] 配置项位于 config/config.ini。建议仅在 config/user_config.ini 中保存需要覆盖的配置,并保留 [Settings] 分组;也可以使用同名环境变量覆盖。PUBLIC_URL 未设置或留空时不会覆盖配置文件中的 public_url

配置项描述默认值
open_update开启更新,用于控制是否更新接口,若关闭则所有工作模式(获取接口和测速)均停止True
open_unmatch_category开启未匹配频道分类,未匹配 source_file 的频道会进入该分类并直接写入结果,不参与测速False
open_empty_category开启无结果频道分类,自动归类至底部False
open_update_time开启显示更新时间True
open_url_info开启显示接口说明信息,用于控制是否显示接口来源、分辨率、协议类型等信息,为 $ 符号后的内容,播放软件使用该信息对接口进行描述,若部分播放器(如 PotPlayer)不支持解析导致无法播放可关闭False
open_epg开启 EPG 功能,支持频道显示预告内容True
open_subscribe_epg开启从订阅源 m3u 头部 url-tvg/x-tvg-url 自动提取 EPG 地址,并入 EPG 源一起合并,无需手动维护 config/epg.txt;epg.txt 源优先,订阅源仅补充未覆盖频道;需 open_epg = TrueTrue
open_m3u_result开启转换生成 m3u 文件类型结果链接,支持显示频道图标True
output_urls_limit每个频道最终导出的接口数量;旧版 urls_limit 仍兼容5
speed_test_target快速测速每个频道的有效结果目标;设为 0 跟随 output_urls_limit0
quick_test_targetspeed_test_target 的可读别名;非 0 时优先作为快速测速目标0
update_time_position更新时间显示位置,需要开启 open_update_time 才能生效,可选值: top、bottom;top: 显示于结果顶部,bottom: 显示于结果底部top
language系统语言设置;可选值: zh_CN、enzh_CN
update_mode定时执行更新时间模式,不作用于工作流;可选值: interval、time; interval: 按间隔时间执行,time: 按指定时间点执行interval
update_interval定时执行更新时间间隔,仅在update_mode = interval时生效,单位小时,设置 0 或空则只运行一次12
update_times定时执行更新时间点,仅在update_mode = time时生效,格式 HH:MM,支持多个时间点逗号分隔
update_startup启动时执行更新,用于控制程序启动后是否立即执行一次更新True
time_zone时区,可用于控制定时执行时区或显示更新时间的时区;可选值: Asia/Shanghai 或其它时区编码Asia/Shanghai
source_file模板文件路径config/demo.txt
final_file生成结果文件路径output/result.txt
open_realtime_write开启实时写入结果文件,在测速过程中可以访问并使用更新结果True
open_service开启页面服务,用于控制是否启动结果页面服务;如果使用青龙等平台部署,有专门设定的定时任务,需要更新完成后停止运行,可以关闭该功能True
service_portHTTP 服务访问端口;桌面版启用推流时由 Nginx 监听,新配置通常只需修改此端口8080
public_url推荐的公网完整访问地址,例如 https://iptv.example.comhttp://host:8088;用于统一生成播放列表、EPG、台标和服务链接
app_port高级兼容设置:Flask 内部 API 端口,通常无需修改,也不应作为用户访问端口5180
public_scheme高级兼容设置:旧版公网协议,仅在 public_url 留空时生效;可选值: http、httpshttp
public_domain高级兼容设置:旧版公网 Host,仅在 public_url 留空时生效,默认使用本机 IP127.0.0.1
cdn_urlCDN 代理加速地址,用于订阅源、频道图标等资源的加速访问;支持配置多个(用英文逗号分隔),订阅源与 EPG 按顺序逐个回退拉取,任一镜像成功即停,频道图标使用第一个地址
http_proxyHTTP 代理地址,用于获取订阅源等网络请求
open_local开启本地源功能,将使用模板文件与本地源文件(local.txt)中的数据True
open_subscribe开启订阅源功能True
open_auto_disable_source开启自动停用失效地址,当请求重试后失败、内容为空或没有匹配到符合条件的值时,会自动在 config/subscribe.txtconfig/epg.txt 中对应地址前添加 # 进行停用False
open_history开启使用历史更新结果(包含模板与结果文件的接口),合并至本次更新中True
open_headers开启使用 M3U 内含的请求头验证信息,用于测速等操作,个别播放器可能不支持播放这类含验证信息的接口True
user_agent全局请求 User-Agent,用于拉取订阅源、测速以及写入 m3u 结果(无需开启 open_headers),留空则使用内置默认 UA;优先级:接口自带 UA > 订阅地址 UA > 全局 UA > 内置默认 UA
open_speed_test开启测速功能,获取响应时间、速率、分辨率True
speed_test_mode测速工作模式:quick 达到目标后停止,full 测试全部候选,manual 仅采集并由 GUI 手动测速;旧版 open_speed_test 仍兼容quick
open_stream_screenshot自动为可播放候选接口获取播放截图;会增加 FFmpeg 解码开销和更新时间,关闭时仍可在 GUI 手动获取False
stream_screenshot_timeout单个接口截图超时时长,单位秒(s)5
stream_screenshot_width播放截图最大宽度,按原始宽高比缩放640
open_filter_resolution开启分辨率过滤,低于最小分辨率(min_resolution)的接口将会被过滤,GUI 用户需要手动安装 FFmpeg,程序会自动调用 FFmpeg 获取接口分辨率,推荐开启,虽然会增加测速阶段耗时,但能更有效地区分是否可播放的接口True
open_filter_speed开启速率过滤,低于最小速率(min_speed)的接口将会被过滤True
open_filter_ad开启广告过滤,自动识别并过滤无信号/广告等循环占位源(含 #EXT-X-ENDLIST 的短循环列表,或片段地址包含广告关键字),复用测速阶段已抓取的播放列表进行判断,不增加额外请求与测速耗时True
open_full_speed_test开启全量测速,频道下所有候选接口(白名单除外)都进行测速;关闭时达到 speed_test_target 后停止该频道剩余测速False
open_supply开启补偿机制模式,用于控制当频道接口数量不足时,自动将不满足条件(例如低于最小速率)但可能可用的接口添加至结果中,从而避免结果为空的情况;开启后,不符合 location/isp 归属地或运营商的接口也不再直接丢弃,而是降权排到该频道结果的末尾作为补充False
sort_by结果排序维度,控制每个频道内接口的排序优先级,按从前到后的顺序依次比较,逗号分隔;可选值: speed(速率,高优先)、delay(延迟,低优先)、resolution(分辨率,高优先),例如: resolution,speedspeed
min_resolution接口最小分辨率,需要开启 open_filter_resolution 才能生效1280x720
max_resolution接口最大分辨率,需要开启 open_filter_resolution 才能生效3840x2160
min_speed接口最小速率(单位 MiB/s),需要开启 open_filter_speed 才能生效0.5
resolution_speed_map分辨率与速率映射关系,用于控制不同分辨率接口的最低速率要求,格式为 resolution:speed,多个映射关系逗号分隔1280x720:0.2,1920x1080:0.5,3840x2160:1.0
performance_mode性能模式;auto 根据设备或容器的 CPU、内存自动选择,powersave 优先降低资源消耗,balance 平衡资源与速度,fast 充分利用高性能设备auto
speed_test_limit测速网络并发高级覆盖值;0 表示由性能模式自动决定,大于 0 时覆盖自动测速并发,不影响媒体探测和源抓取并发0
speed_test_timeout单个接口测速超时时长,单位秒(s);数值越大测速所需时间越长,能提高获取接口数量,但质量会有所下降;数值越小测速所需时间越短,能获取低延时的接口,质量较好;调整此值能优化更新时间10
speed_test_filter_host测速阶段使用 Host 地址进行过滤,相同 Host 地址的频道将共用测速数据,开启后可大幅减少测速所需时间,但可能会导致测速结果不准确False
request_timeout查询请求超时时长,单位秒(s),用于控制查询接口文本链接的超时时长以及重试时长,调整此值能优化更新时间10
ipv6_support强制认为当前网络支持 IPv6,跳过检测False
ipv_type生成结果中接口的协议类型;可选值: ipv4、ipv6、allall
ipv_type_prefer接口协议类型偏好,优先将该类型的接口排在结果前面;可选值: ipv4、ipv6、autoauto
location接口归属地,用于控制结果只包含填写的归属地类型,支持关键字过滤,英文逗号分隔,不填写表示不指定归属地,建议使用靠近使用者的归属地,能提升播放体验
isp接口运营商,用于控制结果中只包含填写的运营商类型,支持关键字过滤,英文逗号分隔,不填写表示不指定运营商
origin_type_prefer结果偏好的接口来源,结果优先按该顺序进行排序,逗号分隔,例如: local,subscribe;不填写则表示不指定来源,按照接口速率排序
local_num结果中偏好的本地源接口数量10
subscribe_num结果中偏好的订阅源接口数量10
logo_url频道台标库地址
logo_type频道台标文件类型png
open_subscribe_logo开启优先使用订阅源 m3u 中自带的 tvg-logo 台标地址,仅当订阅源未提供时才回退到台标库True
open_rtmp开启 RTMP 推流功能,仅建议用于自有或已授权内容,需要安装 FFmpeg,利用本地带宽提升接口播放体验True
nginx_http_port高级兼容设置:旧版 HTTP 端口名;新配置请使用 service_port8080
nginx_rtmp_port高级设置:Nginx RTMP 协议端口,仅推流客户端需要1935
rtmp_idle_timeoutRTMP 频道接口空闲停止推流超时时长,单位秒(s),用于控制接口无人观看时超过该时长后停止推流,调整此值能优化服务器资源占用300
rtmp_max_streamsRTMP 推流最大并发数量,用于控制同时推流的频道数量,数值越大服务器压力越大,调整此值能优化服务器资源占用10
rtmp_transcode_mode推流转码模式,copy 则不进行转码,以复制方式输出,可以最大程度节省CPU消耗,auto 则自适应匹配播放器进行转码,会增加CPU消耗但能提升兼容性copy