README En

⚡️ IPTV live-source automatic update platform — 🤖 fully automated collection, filtering, speed-testing, and generation 🚀. Supports extensive personalized configuration; paste the resulting address into a player to watch.

<a href="https://trendshift.io/repositories/12327" target="_blank"></a>

中文 | English

• ✅ Core Features
• ⚙️ Config parameter
• 🚀 Quick Start
  • Configuration and Results Directory
  • Workflow
  • Command Line
  • GUI Software
  • Docker
• 📖 Detailed Tutorial
• 🗓️ Changelog
• ❤️ Donations
• 👀 Follow
• ⭐️ Star History
• ⚠️ Disclaimer
• ⚖️ License

[!IMPORTANT]

1. Go to the Govin WeChat public account and reply with cdn to get an acceleration address to improve access speed for subscription sources and channel logos.
2. This project does not provide data sources. Please add your own before generating results. (How to add data sources?)
3. The quality of generated results depends on the data sources and network conditions; please adjust the configuration accordingly to obtain results that better meet your needs.

Core Features

Config

[!NOTE]
The following configuration items are located in config/config.ini and can be modified via the configuration file or environment variables. Save changes and restart to apply.

Quick Start

Configuration and Results Directory

iptv-api/                  # Project root directory
├── config                 # Configuration files directory, includes config files, templates, etc.
│   └── hls                # Local HLS streaming files directory, used to store video files named after channel names
│   └── local              # Local source files directory; used to store multiple local source files; supports txt/m3u formats
│   └── config.ini         # Configuration parameters file
│   └── demo.txt           # Channel template
│   └── alias.txt          # Channel aliases
│   └── blacklist.txt      # Interface blacklist
│   └── whitelist.txt      # Interface whitelist
│   └── subscribe.txt      # Channel subscription sources list
│   └── local.txt          # Local source file
│   └── epg.txt            # EPG subscription sources list
└── output                 # Output files directory, includes generated result files, etc.
    └── data               # Result data cache directory
    └── epg                # EPG result directory
    └── ipv4               # IPv4 result directory
    └── ipv6               # IPv6 result directory
    └── result.m3u/txt     # m3u/txt result
    └── hls.m3u/txt        # RTMP hls stream result
    └── log                # Log files directory
        └── result.log     # Valid result log
        └── speed_test.log # Speed test log
        └── statistic.log  # Statistics result log
        └── unmatch.log    # Unmatched channel records

Workflow

Fork this project and initiate workflow updates, detailed steps are available at Detailed Tutorial

Command Line

pip install pipenv

pipenv install --dev

Start update:

pipenv run dev

Start service:

pipenv run service

GUI Software

1. Download the IPTV-API Update Software, open the software, and click Start to perform the update

2. Or run the following command in the project directory to open the GUI software:

pipenv run ui

Docker

1. Deployment with Compose (recommended)

Download the docker-compose.yml or create one by copying the content (internal parameters can be changed as needed), then run the following command in the path where the file is located:

docker compose up -d

2. Manual deployment with commands

(1) Pull the image

docker pull guovern/iptv-api:latest

🚀 Proxy acceleration (use this command if pulling fails, but it may download an older version):

docker pull docker.1ms.run/guovern/iptv-api:latest

(2) Run the container

docker run -d -p 80:8080 guovern/iptv-api

Environment variables:

If you need to modify environment variables, add the following parameters after the above run command:

# Modify public domain
-e PUBLIC_DOMAIN=your.domain.com
# Modify public port
-e PUBLIC_PORT=80

In addition to the environment variables listed above, you can also override the configuration items in the configuration file via environment variables.

Mounts: used to synchronize files between the host and the container. You can edit templates, configs, and access generated result files directly on the host. Append the following options to the run command above:

# Mount config directory
-v /iptv-api/config:/iptv-api/config
# Mount output directory
-v /iptv-api/output:/iptv-api/output

3. Update Results

RTMP Streaming:

[!NOTE]

1. If deploying on a server, be sure to set the PUBLIC_DOMAIN environment variable to the server's domain name or IP address and the PUBLIC_PORT environment variable to the public port; otherwise the streaming addresses will not be accessible.
2. When streaming is enabled, obtained interfaces (e.g., subscription sources) will be streamed by default; only use this for content you own, are explicitly authorized to redistribute, or need for closed/internal testing.
3. To stream local video sources, create an hls folder under the config directory and place video files named after the channel; the program will automatically stream them to the corresponding channels.
4. When using this project in Mainland China, make sure the content authorization, copyright, network-audiovisual, and broadcasting-related compliance requirements are satisfied. Do not use it to distribute, relay, or publicly expose unauthorized live streams or program sources.

How to use streaming?

Changelog

Changelog

Follow

GitHub

Follow my GitHub account Guovin to find more useful projects

WeChat public account

WeChat public account search for Govin, or scan the code to receive updates and learn more tips:

Need more help?

Contact via email: [email protected]

Star History

Donations

Disclaimer

• This project is provided as a tool/framework only; it does not include, host, cache, or guarantee any live streams, copyrighted programs, or other third-party content. Users must add their own data sources and ensure that the data sources used and their use comply with applicable laws and regulations in their jurisdiction.
• Users are solely responsible for any content obtained, distributed, relayed, or played through this project. Do not use it to distribute, share, relay, or watch copyrighted content without authorization, especially in Mainland China where content authorization, licensing, filing/permit, and other regulatory requirements may apply.
• The RTMP/HLS push features are intended only for owned content, explicitly authorized content, or closed-environment technical testing. If you cannot verify authorization, disable open_rtmp and do not expose the related endpoints to the public internet.
• When using this project, comply with local laws, regulations, and supervisory requirements. The author is not liable for any legal responsibility arising from users' use of this project.
• For commercial, corporate, or production use, consult compliance/legal counsel and complete a review.

License

AGPL-3.0 License © 2024-PRESENT Govin