mirror of
https://github.com/iptv-org/epg.git
synced 2025-05-09 08:30:06 -04:00
Update README.md
This commit is contained in:
parent
03ee512427
commit
74ce38b66c
1 changed files with 22 additions and 11 deletions
19
README.md
19
README.md
|
@ -58,7 +58,7 @@ Options:
|
|||
-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 <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)
|
||||
-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)
|
||||
|
@ -156,6 +156,12 @@ docker build -t iptv-org/epg --no-cache .
|
|||
|
||||
### 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
|
||||
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
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
### Configuration
|
||||
|
||||
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 SITE=example.com \
|
||||
-e CLANG=fr \
|
||||
-e CRON="0 0,12 * * *" \
|
||||
-e MAX_CONNECTIONS=10 \
|
||||
-e GZIP=true \
|
||||
|
@ -192,7 +199,9 @@ iptv-org/epg
|
|||
```
|
||||
|
||||
| Variable | Description |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| SITE | Name of the site to parse |
|
||||
| CLANG | Limit the download to channels in the specified language only ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) code) |
|
||||
| CRON | A [cron expression](https://crontab.guru/) describing the schedule of the guide loadings (by default will run once) |
|
||||
| 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) |
|
||||
|
@ -200,6 +209,8 @@ iptv-org/epg
|
|||
| 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 with already linked guides can be found in the [iptv-org/iptv](https://github.com/iptv-org/iptv) repository.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue