mirror of
https://github.com/iptv-org/epg
synced 2025-12-15 09:56:42 -05:00
240 lines
8.7 KiB
Markdown
240 lines
8.7 KiB
Markdown
# EPG [](https://github.com/iptv-org/epg/actions/workflows/update.yml)
|
|
|
|
Tools for downloading the EPG (Electronic Program Guide) for thousands of TV channels from hundreds of sources.
|
|
|
|
## Table of contents
|
|
|
|
- ✨ [Installation](#installation)
|
|
- 🚀 [Usage](#usage)
|
|
- 💫 [Update](#update)
|
|
- 🐋 [Docker](#docker)
|
|
- 📺 [Playlists](#playlists)
|
|
- 🗄 [Database](#database)
|
|
- 👨💻 [API](#api)
|
|
- 📚 [Resources](#resources)
|
|
- 💬 [Discussions](#discussions)
|
|
- 🛠 [Contribution](#contribution)
|
|
- 📄 [License](#license)
|
|
|
|
## Installation
|
|
|
|
First, you need to install [Node.js](https://nodejs.org/en) on your computer. You will also need to install [Git](https://git-scm.com/downloads) to follow these instructions.
|
|
|
|
After that open the [Console](https://en.wikipedia.org/wiki/Windows_Console) (or [Terminal](<https://en.wikipedia.org/wiki/Terminal_(macOS)>) if you have macOS) and type the following command:
|
|
|
|
```sh
|
|
git clone --depth 1 -b master https://github.com/iptv-org/epg.git
|
|
```
|
|
|
|
This will copy all the code from the repository to your computer into the `epg` folder. After that, we just need to go to the folder we created:
|
|
|
|
```sh
|
|
cd epg
|
|
```
|
|
|
|
And install all the dependencies:
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
## Usage
|
|
|
|
To start the download of the guide, select one of the supported sites from [SITES.md](SITES.md) file and paste its name into the command below:
|
|
|
|
```sh
|
|
npm run grab --- --site=example.com
|
|
```
|
|
|
|
Then run it and wait for the guide to finish downloading. When finished, a new `guide.xml` file will appear in the current directory.
|
|
|
|
You can also customize the behavior of the script using this options:
|
|
|
|
```sh
|
|
Usage: npm run grab --- [options]
|
|
|
|
Options:
|
|
-s, --site <name> Name of the site to parse
|
|
-c, --channels <path> Path to *.channels.xml file (required if the "--site" attribute is
|
|
not specified)
|
|
-o, --output <path> Path to output file (default: "guide.xml")
|
|
-l, --lang <codes> Allows you to restrict downloading to channels in specified languages only (example: "en,id")
|
|
-t, --timeout <milliseconds> Timeout for each request in milliseconds (default: 30000)
|
|
-d, --delay <milliseconds> Delay between request in milliseconds (default: 0)
|
|
-x, --proxy <url> Use the specified proxy (example: "socks5://username:password@127.0.0.1:1234")
|
|
--days <days> Number of days for which the program will be loaded (defaults to the value from the site config)
|
|
--maxConnections <number> Number of concurrent requests (default: 1)
|
|
--gzip Specifies whether or not to create a compressed version of the guide (default: false)
|
|
--curl Display each request as CURL (default: false)
|
|
```
|
|
|
|
### Parallel downloading
|
|
|
|
By default, the guide for each channel is downloaded one by one, but you can change this behavior by increasing the number of simultaneous requests using the `--maxConnections` attribute:
|
|
|
|
```sh
|
|
npm run grab --- --site=example.com --maxConnections=10
|
|
```
|
|
|
|
But be aware that under heavy load some sites may start return an error or completely block your access.
|
|
|
|
### Use custom channel list
|
|
|
|
Create an XML file and copy the descriptions of all the channels you need from the [/sites](sites) into it:
|
|
|
|
```xml
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<channels>
|
|
<channel site="arirang.com" lang="en" xmltv_id="ArirangTV.kr" site_id="CH_K">Arirang TV</channel>
|
|
...
|
|
</channels>
|
|
```
|
|
|
|
And then specify the path to that file via the `--channels` attribute:
|
|
|
|
```sh
|
|
npm run grab --- --channels=path/to/custom.channels.xml
|
|
```
|
|
|
|
### Run on schedule
|
|
|
|
If you want to download guides on a schedule, you can use [cron](https://en.wikipedia.org/wiki/Cron) or any other task scheduler. Currently, we use a tool called [chronos](https://github.com/freearhey/chronos) for this purpose.
|
|
|
|
To start it, you only need to specify the necessary `grab` command and [cron expression](https://crontab.guru/):
|
|
|
|
```sh
|
|
npx chronos --execute="npm run grab --- --site=example.com" --pattern="0 0,12 * * *" --log
|
|
```
|
|
|
|
For more info go to [chronos](https://github.com/freearhey/chronos) documentation.
|
|
|
|
### Access the guide by URL
|
|
|
|
You can make the guide available via URL by running your own server. The easiest way to do this is to run this command:
|
|
|
|
```sh
|
|
npx serve
|
|
```
|
|
|
|
After that, the guide will be available at the link:
|
|
|
|
```
|
|
http://localhost:3000/guide.xml
|
|
```
|
|
|
|
In addition it will be available to other devices on the same local network at the address:
|
|
|
|
```
|
|
http://<your_local_ip_address>:3000/guide.xml
|
|
```
|
|
|
|
For more info go to [serve](https://github.com/vercel/serve) documentation.
|
|
|
|
## Update
|
|
|
|
If you have downloaded the repository code according to the instructions above, then to update it will be enough to run the command:
|
|
|
|
```sh
|
|
git pull
|
|
```
|
|
|
|
And then update all the dependencies:
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
## Docker
|
|
|
|
### Pull an image
|
|
|
|
```sh
|
|
docker pull ghcr.io/iptv-org/epg:master
|
|
```
|
|
|
|
### Create and run container
|
|
|
|
```sh
|
|
docker run -p 3000:3000 -v /path/to/channels.xml:/epg/channels.xml ghcr.io/iptv-org/epg:master
|
|
```
|
|
|
|
By default, the guide will be downloaded every day at 00:00 UTC and saved to the `/epg/public/guide.xml` file inside the container.
|
|
|
|
From the outside, it will be available at this link:
|
|
|
|
```
|
|
http://localhost:3000/guide.xml
|
|
```
|
|
|
|
or
|
|
|
|
```
|
|
http://<your_local_ip_address>:3000/guide.xml
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
To fine-tune the execution, you can pass environment variables to the container as follows:
|
|
|
|
```sh
|
|
docker run \
|
|
-p 5000:3000 \
|
|
-v /path/to/channels.xml:/epg/channels.xml \
|
|
-e CRON_SCHEDULE="0 0,12 * * *" \
|
|
-e MAX_CONNECTIONS=10 \
|
|
-e GZIP=true \
|
|
-e CURL=true \
|
|
-e PROXY="socks5://127.0.0.1:1234" \
|
|
-e DAYS=14 \
|
|
-e TIMEOUT=5 \
|
|
-e DELAY=2 \
|
|
ghcr.io/iptv-org/epg:master
|
|
```
|
|
|
|
| Variable | Description |
|
|
| --------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
| CRON_SCHEDULE | A [cron expression](https://crontab.guru/) describing the schedule of the guide loadings (default: "0 0 \* \* \*") |
|
|
| MAX_CONNECTIONS | Limit on the number of concurrent requests (default: 1) |
|
|
| GZIP | Boolean value indicating whether to create a compressed version of the guide (default: false) |
|
|
| CURL | Display each request as CURL (default: false) |
|
|
| PROXY | Use the specified proxy |
|
|
| DAYS | Number of days for which the guide will be loaded (defaults to the value from the site config) |
|
|
| TIMEOUT | Timeout for each request in milliseconds (default: 30000) |
|
|
| DELAY | Delay between request in milliseconds (default: 0) |
|
|
| RUN_AT_STARTUP | Run grab on container startup (default: true) |
|
|
|
|
## Database
|
|
|
|
All channel data is taken from the [iptv-org/database](https://github.com/iptv-org/database) repository. If you find any errors please open a new [issue](https://github.com/iptv-org/database/issues) there.
|
|
|
|
## API
|
|
|
|
The API documentation can be found in the [iptv-org/api](https://github.com/iptv-org/api) repository.
|
|
|
|
## Resources
|
|
|
|
Links to other useful IPTV-related resources can be found in the [iptv-org/awesome-iptv](https://github.com/iptv-org/awesome-iptv) repository.
|
|
|
|
## Discussions
|
|
|
|
If you have a question or an idea, you can post it in the [Discussions](https://github.com/orgs/iptv-org/discussions) tab.
|
|
|
|
## Contribution
|
|
|
|
Please make sure to read the [Contributing Guide](https://github.com/iptv-org/epg/blob/master/CONTRIBUTING.md) before sending [issue](https://github.com/iptv-org/epg/issues) or a [pull request](https://github.com/iptv-org/epg/pulls).
|
|
|
|
And thank you to everyone who has already contributed!
|
|
|
|
### Backers
|
|
|
|
<a href="https://opencollective.com/iptv-org"><img src="https://opencollective.com/iptv-org/backers.svg?width=890" /></a>
|
|
|
|
### Contributors
|
|
|
|
<a href="https://github.com/iptv-org/epg/graphs/contributors"><img src="https://opencollective.com/iptv-org/contributors.svg?width=890" /></a>
|
|
|
|
## License
|
|
|
|
[](LICENSE)
|
|
|