From 6a4404b6639ae261d054d2c7e1ecd0170e21157f Mon Sep 17 00:00:00 2001 From: freearhey <7253922+freearhey@users.noreply.github.com> Date: Mon, 31 Mar 2025 09:38:32 +0300 Subject: [PATCH] Update README.md --- README.md | 68 ------------------------------------------------------- 1 file changed, 68 deletions(-) diff --git a/README.md b/README.md index 5fb2794e..7faa59b8 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ Tools for downloading the EPG (Electronic Program Guide) for thousands of TV cha - ✨ [Installation](#installation) - 🚀 [Usage](#usage) - 💫 [Update](#update) -- 🐋 [Docker](#docker) - 📺 [Playlists](#playlists) - 🗄 [Database](#database) - 👨‍💻 [API](#api) @@ -147,73 +146,6 @@ And then update all the dependencies: npm install ``` -## Docker - -### Build an image - -```sh -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 -``` - -By default, the guide will be downloaded only once 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://:3000/guide.xml -``` - -### Configuration - -To fine-tune the execution, you can pass environment variables to the container as follows: - -```sh -docker run \ --p 5000:3000 \ --e SITE=example.com \ --e CLANG=fr \ --e CRON="0 0,12 * * *" \ --e PROXY="socks5://username:password@127.0.0.1:1234" \ --e MAX_CONNECTIONS=10 \ --e GZIP=true \ --e DAYS=14 \ --e TIMEOUT=5 \ --e DELAY=2 \ -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) | -| PROXY | Use the specified proxy | -| 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) | -| 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 with already linked guides can be found in the [iptv-org/iptv](https://github.com/iptv-org/iptv) repository.