Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat #683

Merged
merged 10 commits into from
Dec 13, 2024
Merged

feat #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2fb0f55
fix:sort log
Guovin Dec 13, 2024
5dd60de
fix:get speed of m3u8 playlist timeout(#621)
Guovin Dec 13, 2024
1a8da9f
chore:speed config
Guovin Dec 13, 2024
7a6d01e
feat:jsdelivr cdn(#639)
Guovin Dec 13, 2024
3990693
chore:config
Guovin Dec 13, 2024
19b12d2
Merge pull request #680 from Guovin/dev
Guovin Dec 13, 2024
e3ec321
feat:subscribe file
Guovin Dec 13, 2024
fea4557
feat:get_real_path
Guovin Dec 13, 2024
5a9b409
update:readme
Guovin Dec 13, 2024
5acd651
Merge pull request #682 from Guovin/dev
Guovin Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 79 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,16 @@

- [✅ 特点](#特点)
- [🔗 最新结果](#最新结果)
- [⚙️ 配置参数](./docs/config.md)
- [⚙️ 配置参数](#配置)
- [🚀 快速上手](#快速上手)
- [工作流](#工作流)
- [命令行](#命令行)
- [GUI软件](#GUI-软件)
- [Docker](#Docker)
- [📖 详细教程](./docs/tutorial.md)
- [🗓️ 更新日志](./CHANGELOG.md)
- [❤️ 赞赏](#赞赏)
- [👀 关注](#关注)
- [👀 关注(更新订阅+答疑交流)](#关注)
- [📣 免责声明](#免责声明)
- [⚖️ 许可证](#许可证)

Expand All @@ -100,7 +104,7 @@
- ✅ 偏好设置：IPv6、接口来源排序优先级与数量配置、接口白名单
- ✅ 定时执行，北京时间每日 6:00 与 18:00 执行更新
- ✅ 支持多种运行方式：工作流、命令行、GUI 软件、Docker(amd64/arm64/arm v7)
- ✨ 更多功能请见[配置参数](./docs/config.md)
- ✨ 更多功能请见[配置参数](#配置)

## 最新结果

Expand All @@ -114,23 +118,90 @@ https://ghp.ci/raw.githubusercontent.com/Guovin/iptv-api/gd/output/result.m3u
https://ghp.ci/raw.githubusercontent.com/Guovin/iptv-api/gd/output/result.txt
```

或

```bash
https://cdn.jsdelivr.net/gh/Guovin/iptv-api@gd/output/result.m3u
```

```bash
https://cdn.jsdelivr.net/gh/Guovin/iptv-api@gd/output/result.txt
```

- 数据源：

```bash
https://ghp.ci/raw.githubusercontent.com/Guovin/iptv-api/gd/source.json
```

或

```bash
https://cdn.jsdelivr.net/gh/Guovin/iptv-api@gd/source.json
```

## 配置

[配置参数](./docs/config.md)
| 配置项 | 描述 | 默认值 |
|:-----------------------|:------------------------------------------------------------------------------------------|:----------------------------------------|
| open_driver | 开启浏览器运行，若更新无数据可开启此模式，较消耗性能 | True |
| open_empty_category | 开启无结果频道分类，自动归类至底部 | False |
| open_ffmpeg | 开启使用 FFmpeg 进行测速，获取更准确的速度与分辨率信息，需要提前手动安装 | True |
| open_filter_resolution | 开启分辨率过滤，低于最小分辨率（min_resolution）的接口将会被过滤 | True |
| open_filter_speed | 开启速率过滤，低于最小速率（min_speed）的接口将会被过滤 | True |
| open_hotel | 开启酒店源功能，关闭后所有酒店源工作模式都将关闭 | True |
| open_hotel_foodie | 开启 Foodie 酒店源工作模式 | True |
| open_hotel_fofa | 开启 FOFA、ZoomEye 酒店源工作模式 | True |
| open_keep_all | 开启保留所有检索结果，会保留非模板频道名称的结果，推荐手动维护时开启 | False |
| open_m3u_result | 开启转换生成 m3u 文件类型结果链接，支持显示频道图标 | True |
| open_multicast | 开启组播源功能，关闭后所有组播源工作模式都将关闭 | True |
| open_multicast_foodie | 开启 Foodie 组播源工作模式 | True |
| open_multicast_fofa | 开启 FOFA 组播源工作模式 | True |
| open_online_search | 开启关键字搜索源功能 | False |
| open_proxy | 开启代理，自动获取免费可用代理，若更新无数据可开启此模式 | False |
| open_request | 开启查询请求，数据来源于网络 | False |
| open_service | 开启页面服务，用于控制是否启动结果页面服务；如果使用青龙等平台部署，有专门设定的定时任务，需要更新完成后停止运行，可以关闭该功能 | True |
| open_sort | 开启排序功能（响应速度、日期、分辨率） | True |
| open_subscribe | 开启订阅源功能 | False |
| open_update | 开启更新，用于控制是否更新接口，若关闭则所有工作模式（获取接口和测速）均停止 | True |
| open_update_time | 开启显示更新时间 | True |
| open_url_info | 开启显示接口说明信息，用于控制是否显示分辨率、接口协议类型等信息，为$符号后的内容，播放软件使用该信息对接口进行描述 | True |
| open_use_cache | 开启使用本地缓存数据，适用于查询请求失败场景 | True |
| open_use_old_result | 开启使用历史更新结果（包含模板与结果文件的接口），合并至本次更新中 | True |
| delay_weight | 响应时间权重值（所有权重值总和应为 1） | 0.25 |
| final_file | 生成结果文件路径 | output/result.txt |
| hotel_num | 结果中偏好的酒店源接口数量 | 4 |
| hotel_page_num | 酒店地区获取分页数量 | 1 |
| hotel_region_list | 酒店源地区列表，"全部"表示所有地区 | 全部 |
| ipv4_num | 结果中偏好的 IPv4 接口数量 | 5 |
| ipv6_num | 结果中偏好的 IPv6 接口数量 | 5 |
| ipv_type | 生成结果中接口的协议类型，可选值：ipv4、ipv6、全部、all | 全部 |
| ipv_type_prefer | 接口协议类型偏好，优先将该类型的接口排在结果前面，可选值：IPv4、IPv6、自动、auto | 自动 |
| min_resolution | 接口最小分辨率，需要开启 open_filter_resolution 才能生效 | 1920x1080 |
| min_speed | 接口最小速率（单位M/s），需要开启 open_filter_speed 才能生效 | 0.2 |
| multicast_num | 结果中偏好的组播源接口数量 | 3 |
| multicast_page_num | 组播地区获取分页数量 | 1 |
| multicast_region_list | 组播源地区列表，"全部"表示所有地区 | 全部 |
| online_search_num | 结果中偏好的关键字搜索接口数量 | 0 |
| online_search_page_num | 关键字搜索频道获取分页数量 | 1 |
| origin_type_prefer | 结果偏好的接口来源，结果优先按该顺序进行排序，hotel：酒店源，multicast：组播源，subscribe：订阅源，online_search：关键字搜索 | hotel,multicast,subscribe,online_search |
| recent_days | 获取最近时间范围内更新的接口（单位天），适当减小可避免出现匹配问题 | 30 |
| request_timeout | 查询请求超时时长，单位秒(s)，用于控制查询接口文本链接的超时时长以及重试时长，调整此值能优化更新时间 | 10 |
| resolution_weight | 分辨率权重值 （所有权重值总和应为 1） | 0.25 |
| sort_timeout | 单个接口测速超时时长，单位秒(s)；数值越大测速所属时间越长，能提高获取接口数量，但质量会有所下降；数值越小测速所需时间越短，能获取低延时的接口，质量较好；调整此值能优化更新时间 | 10 |
| source_file | 模板文件路径 | config/demo.txt |
| speed_weight | 速率权重值（所有权重值总和应为 1） | 0.5 |
| subscribe_num | 结果中偏好的订阅源接口数量 | 3 |
| url_keywords_blacklist | 接口关键字黑名单，用于过滤含特定字符的接口 | |
| urls_limit | 单个频道接口数量 | 10 |

## 快速上手

### 方式一：工作流
### 工作流

Fork 本项目并开启工作流更新，具体步骤请见[详细教程](./docs/tutorial.md)

### 方式二：命令行
### 命令行

```shell
pip install pipenv
Expand All @@ -152,7 +223,7 @@ pipenv run dev
pipenv run service
```

### 方式三：GUI 软件
### GUI 软件

1. 下载[IPTV-API 更新软件](https://github.com/Guovin/iptv-api/releases)，打开软件，点击更新，即可完成更新

Expand All @@ -164,7 +235,7 @@ pipenv run ui

<img src="./docs/images/ui.png" alt="IPTV-API更新软件" title="IPTV-API更新软件" style="height:600px" />

### 方式四：Docker
### Docker

- iptv-api（完整版本）：性能要求较高，更新速度较慢，稳定性、成功率高；修改配置 open_driver = False 可切换到 Lite
版本运行模式（推荐酒店源、组播源、关键字搜索使用此版本）
Expand Down
Loading