diff --git a/README.md b/README.md index 09775ee..0c8b5f9 100644 --- a/README.md +++ b/README.md @@ -61,14 +61,6 @@ in whatever XML-TV consumer you are using. This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. -### Prerequisites - -This is an example of how to list things you need to use the software and how to install them. -* npm - ```sh - npm install npm@latest -g - ``` - ### Installation 1. Build compose.yaml @@ -78,17 +70,39 @@ This is an example of how to list things you need to use the software and how to docker-epg: image: git.donnymims.com/dnny44/docker-epg:latest container_name: docker-epg + volumes: + - /mnt/data/docker-epg/guides:/epg/guides + - /mnt/data/docker-epg/channels:/epg/channels restart: unless-stopped + docker-epg-caddy: + image: caddy:latest + container_name: docker-epg-caddy + restart: unless-stopped + cap_add: + - NET_ADMIN ports: - - 8080:80 - networks: {} + - 9880:80 + command: caddy file-server --root /guides/ + volumes: + - /mnt/data/docker-epg/guides:/guides + networks: + - caddy_net ``` -2. Install NPM packages + +2. Replace /mnt/data/docker-epg/guides with the path on your host where you want to save your guide.xml. + This MUST be the same folder on the host for both the EPG and Caddy containers -3. Enter your API in `config.js` - ```js - const API_KEY = 'ENTER YOUR API'; - ``` +3. Replace /mnt/data/docker-epg/guides with the path on your host where you want to save your channels.xml file and make sure that your channels.xml file is located there and formatted as follows: + ```xml + + + Arirang TV + ... + + ``` + You can populate his file with the channels from this sites page https://github.com/iptv-org/epg/tree/master/sites + +4. When you start the docker stack the EPG container will do a first run to pull your channels and guide information and then it will stay running according to the default Cron scedule "0 3 * * *"

(back to top)