iptv-org-mirror/epg
1
0
Fork 0
mirror of https://github.com/iptv-org/epg.git synced 2025-05-09 08:30:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
freearhey 2025-01-19 00:44:06 +03:00
parent 03ee512427
commit 74ce38b66c
1 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -58,7 +58,7 @@ Options:
-c, --channels <path> Path to *.channels.xml file (required if the "--site" attribute is -c, --channels <path> Path to *.channels.xml file (required if the "--site" attribute is
not specified) not specified)
-o, --output <path> Path to output file (default: "guide.xml") -o, --output <path> Path to output file (default: "guide.xml")
-l, --lang <code> Allows to limit the download to channels in the specified language only (ISO 639-2 code) -l, --lang <code> Allows to limit the download to channels in the specified language only (ISO 639-1 code)
-t, --timeout <milliseconds> Timeout for each request in milliseconds (default: 0) -t, --timeout <milliseconds> Timeout for each request in milliseconds (default: 0)
-d, --delay <milliseconds> Delay between request in milliseconds (default: 0) -d, --delay <milliseconds> Delay between request in milliseconds (default: 0)
--days <days> Number of days for which the program will be loaded (defaults to the value from the site config) --days <days> Number of days for which the program will be loaded (defaults to the value from the site config)
@ -156,6 +156,12 @@ docker build -t iptv-org/epg --no-cache .
### Create and run container ### Create and run container
```sh
docker run -p 3000:3000 -e SITE=example.com iptv-org/epg
```
To use your [custom channel list](#use-custom-channel-list) pass the path to it via the [--volume](https://docs.docker.com/engine/storage/volumes/#options-for---volume) option:
```sh ```sh
docker run -p 3000:3000 -v /path/to/channels.xml:/epg/channels.xml iptv-org/epg docker run -p 3000:3000 -v /path/to/channels.xml:/epg/channels.xml iptv-org/epg
``` ```
@ -174,14 +180,15 @@ or
http://<your_local_ip_address>:3000/guide.xml http://<your_local_ip_address>:3000/guide.xml
``` ```
### Environment Variables ### Configuration
To fine-tune the execution, you can pass environment variables to the container as follows: To fine-tune the execution, you can pass environment variables to the container as follows:
```sh ```sh
docker run \ docker run \
-p 5000:3000 \ -p 5000:3000 \
-v /path/to/channels.xml:/epg/channels.xml \ -e SITE=example.com \
-e CLANG=fr \
-e CRON="0 0,12 * * *" \ -e CRON="0 0,12 * * *" \
-e MAX_CONNECTIONS=10 \ -e MAX_CONNECTIONS=10 \
-e GZIP=true \ -e GZIP=true \
@ -191,14 +198,18 @@ docker run \
iptv-org/epg iptv-org/epg
``` ```
| Variable | Description | | Variable | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------- | | --------------- | ------------------------------------------------------------------------------------------------------------------------- |
| CRON | A [cron expression](https://crontab.guru/) describing the schedule of the guide loadings (by default will run once) | | SITE | Name of the site to parse |
| MAX_CONNECTIONS | Limit on the number of concurrent requests (default: 1) | | CLANG | Limit the download to channels in the specified language only ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) code) |
| GZIP | Boolean value indicating whether to create a compressed version of the guide (default: false) | | CRON | A [cron expression](https://crontab.guru/) describing the schedule of the guide loadings (by default will run once) |
| DAYS | Number of days for which the guide will be loaded (defaults to the value from the site config) | | MAX_CONNECTIONS | Limit on the number of concurrent requests (default: 1) |
| TIMEOUT | Timeout for each request in milliseconds (default: 0) | | GZIP | Boolean value indicating whether to create a compressed version of the guide (default: false) |
| DELAY | Delay between request in milliseconds (default: 0) | | 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: 0) |
| DELAY | Delay between request in milliseconds (default: 0) |
For more info go to [Docker](https://docs.docker.com/get-started/) documentation.
## Playlists ## Playlists