Back to Iptv Api

IPTV-API 文档中心

docs/README.md

3.0.02.4 KB
Original Source

IPTV-API 文档中心

<p align="center"> <a href="../README.md">项目首页</a> · <a href="#中文">中文</a> | <a href="#english">English</a> </p>

中文

文档内容
项目说明功能概览、快速上手、部署入口、免责声明与许可证
使用教程工作流、命令行、GUI、Docker 与推流的完整操作步骤
配置参数config/config.ini 的全部配置项、说明与默认值
更新日志版本更新、功能变化与问题修复

运行方式速览

方式适用场景入口
GitHub Actions无需自备服务器,适合手动生成结果工作流部署
GUIWindows 或 macOS 桌面使用GUI 软件
命令行本地开发、调试或脚本运行命令行
Docker服务器、NAS 或长期运行Docker

[!IMPORTANT] 本项目不提供数据源。请先阅读添加数据源与更多,并确保数据源及使用方式符合当地法律法规与授权要求。

English

DocumentContents
Project overviewFeature overview, quick start, deployment entry points, disclaimer, and license
TutorialComplete steps for GitHub Actions, command line, GUI, Docker, and streaming
ConfigurationEvery config/config.ini option with its description and default
ChangelogReleases, feature changes, and fixes

Choose a runtime

MethodBest forStart here
GitHub ActionsManual result generation without a dedicated serverWorkflow deployment
GUIDesktop use on Windows or macOSGUI Software
Command lineLocal development, debugging, or scriptsCommand Line
DockerServers, NAS devices, or long-running deploymentsDocker

[!IMPORTANT] This project does not provide data sources. Read Add data sources and more first, and ensure that your sources and usage comply with applicable laws and authorization requirements.