tvbs/docs/tutorial_en.md

Tutorial

中文 | English

Step 1: Fork this Repository

Copy the source code of this repository to your personal account repository

1. Click Fork on the homepage:

2. Fork to create a personal repository:

1. Name your personal repository, you can name it whatever you like (the final live source result link depends on this name), here we use default TV as an example.
2. After confirming the information is correct, click to confirm and create.

Step 2: Update the Source Code

Since this project will continue to iterate and improve, if you want to get the latest updates, you can do the following:

1. Star

Go to https://github.com/Guovin/iptv-api, click on Star to bookmark this project (Your Star is my motivation to keep updating).

2. Watch

Follow this project to be notified by email about the latest updates and release logs through releases.

3. Sync fork

Normal update:

Go back to the homepage of your repository after forking. If there are updates to the project, click on "Sync fork" and then "Update branch" to confirm and update to the latest code.

No Update branch button, update conflict:

This is because some files conflict with the default files in the main repository. Click "Discard commits" to update to the latest code.

Step 3: Modify the Template

When you click to confirm and create in step one, you will be automatically redirected to your personal repository. At this point, your personal repository is created, and you can customize your personal live source channel menu!

1. Click the demo.txt template file inside the config folder:

2. Create a personal template user_demo.txt inside the config folder:

1. Create file
2. Name the template file user_demo.txt
3. The template file needs to be written in the format of (channel category, #genre#), (channel name, channel interface), note that it is an English comma. If you need to set this interface as a whitelist (no speed testing, kept at the front of the results), simply add ! after the address. For example: http://xxx!. Additional information can also be appended afterward, such as: http://xxx$! Whitelist interface.
4. Click Commit changes... to save

Step 4: Modify the Configuration

Similar to editing the template, modify the running configuration

1. Click on the config.ini configuration file inside the config folder:

2. Copy the default configuration file content:

3. Create a personal configuration file user_config.ini inside the config folder:

1. Create file
2. Name the configuration file user_config.ini
3. Paste the default template
4. Modify the template and result file configuration:
   • source_file = config/user_demo.txt
   • final_file = output/user_result.txt
5. Click Commit changes... to save

Adjust the configuration as needed. Below is the default configuration explanation: Config parameter

Step 5: Run Updates

Method 1: Workflow

Warning: Please use the following content with caution. If you have a large number of channels that need to be updated, please use local updates instead of automatic updates. Improper configuration may lead to your account or workflow being banned!

If your template and configuration modifications are correct, you can configure Actions to achieve automatic updates

1. Enter Actions:

2. Enable Actions workflow:

Since the Actions workflow of the forked repository is disabled by default, you need to manually enable it by clicking the button in the red box to confirm.

After successful activation, you can see that there are no workflows running at the moment. Don't worry, let's start running your first update workflow below.

3. Run the update workflow:

(1) Enable update schedule:

1. Click on update schedule under the Workflows category.
2. Since the workflow of the forked repository is disabled by default, click the Enable workflow button to confirm the activation.

(2) Run the Workflow based on branches:

1. Click Run workflow.
2. Here you can switch to the branch you want to run. Since the fork defaults to the master branch, if the template and configuration you modified are also in the master branch, just choose master here, and click Run workflow to confirm the run.

Now you can run the update workflow.

(3) Workflow in progress:

Wait a moment, and you will see that your first update workflow is running! (Note: The running time depends on the number of channels and pages in your template and other configurations, and also largely depends on the current network conditions. Please be patient. The default template and configuration usually take about 25 minutes.)

(4) Cancel the running Workflow:

If you feel that this update is not quite right and you need to modify the template or configuration before running again, you can click Cancel run to cancel this run.

(5) Workflow executed successfully:

If everything is normal, after a short wait, you will see that the workflow has been executed successfully (green check mark).

At this point, you can visit the proxy file link to see if the latest results have been synchronized: https://ghp.ci/raw.githubusercontent.com/your github username/repository name (corresponding to the TV created when forking)/master/user_result.txt

If you can access this link and it returns the updated interface content, then your live source interface link has been successfully created! Simply copy and paste this link into software like TVBox in the configuration field to use~

• Note: Except for the first execution of the workflow, which requires you to manually trigger it, subsequent executions (default: 6:00 AM and 18:00 PM Beijing time daily) will be automatically triggered. If you have modified the template or configuration files and want to execute the update immediately, you can manually trigger (2) Run workflow.

4.Modify Workflow Update Frequency(optional)

If you want to modify the update frequency (default: 6:00 AM and 18:00 PM Beijing time daily), you can modify the on:schedule:- cron field. If you want to perform updates every 2 days, you can modify it like this:

- cron: '0 22 */2 * *'
- cron: '0 10 */2 * *'

1. It is strongly not recommended to modify and update too frequently, because the interface content does not differ within a short period of time, and too high update frequency and time-consuming workflow may be judged as resource abuse, resulting in the risk of warehouse and account being blocked.

2. Please pay attention to the runtime of your workflow. If you find that the execution time is too long, you need to appropriately reduce the number of channels in the template, modify the number of pages and interfaces in the configuration, in order to meet the compliant operation requirements.

Method 2: Command Line

1. Install Python Please download and install Python from the official site. During installation, choose to add Python to the system's environment variables Path.

2. Run Update Open a CMD terminal in the project directory and run the following commands in sequence:

pip install pipenv

pipenv install --dev

Start update:

pipenv run dev

Start service:

pipenv run service

Method 3: GUI Software

1. Download IPTV-API software, open the software, click update to complete the update.

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

pipenv run ui

Method 4: Docker

• iptv-api (Full version): Higher performance requirements, slower update speed, high stability and success rate. Set open_driver = False to switch to the lite running mode (recommended for hotel sources, multicast sources, and online searches)
• iptv-api:lite (Condensed version): Lightweight, low performance requirements, fast update speed, stability uncertain (recommend using this version for the subscription source)

It's recommended to try each one and choose the version that suits you

1. Pull the image:

• iptv-api

docker pull guovern/iptv-api:latest

• iptv-api:lite

docker pull guovern/iptv-api:lite

2. Run the container:

• iptv-api

docker run -d -p 8000:8000 guovern/iptv-api

• iptv-api:lite

docker run -d -p 8000:8000 guovern/iptv-api:lite

Volume Mount Parameter (Optional): This allows synchronization of files between the host machine and the container. Modifying templates, configurations, and retrieving updated result files can be directly operated in the host machine's folder.

Taking the host path /etc/docker as an example:

• iptv-api：

docker run -v /etc/docker/config:/iptv-api/config -v /etc/docker/output:/iptv-api/output -d -p 8000:8000 guovern/iptv-api

• iptv-api:lite：

docker run -v /etc/docker/config:/iptv-api-lite/config -v /etc/docker/output:/iptv-api-lite/output -d -p 8000:8000 guovern/iptv-api:lite

3. Update results:

• API address: ip:8000
• M3u api：ip:8000/m3u
• Txt api：ip:8000/txt
• API content: ip:8000/content
• Speed test log: ip:8000/log

Update the File to the Repository(optional)

If you do not have your own domain address, after the interface update is completed, upload user_result.txt to your personal repository to use it. https://ghp.ci/raw.githubusercontent.com/your github username/repository name (corresponding to the TV created when forking)/master/output/user_result.txt