docker-epg/README.md

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a id="readme-top"></a>

<!-- PROJECT SHIELDS -->
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]


<!-- PROJECT LOGO -->
<br />


<h3 align="center">Docker-EPG</h3>

  <p align="center">
    Docker wrapper for the IPTV EPG program
  </p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

I had a need to run IPTV's EPG in a docker and did not find any holistic solutions readily available to do so. The goal of this project is simply to 
provide a vessel by which to easily run the EPG with your selected Sites or Channels and expose the guide.xml on an HTTP interface for easy consumption
in whatever XML-TV consumer you are using.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

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.

### Installation

1. Build compose.yaml
   ```yaml
    version: "3.8"
    services:
      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:
          - 9880:80
        command: caddy file-server --root /guides/
        volumes:
          - /mnt/data/docker-epg/guides:/guides
        networks:
          - caddy_net
   ```

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. 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
    <?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>
    ```
    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 * * *"

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ROADMAP -->
## Roadmap

- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
    - [ ] Nested Feature

See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p>


<!-- CONTACT -->
## Contact

Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com

Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

* []()
* []()
* []()

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
[forks-shield]: https://img.shields.io/gitea/forks/Dnny44/docker-epg?gitea_url=https%3A%2F%2Fgit.donnymims.com
[forks-url]: https://git.donnymims.com/Dnny44/docker-epg/forks
[stars-shield]: https://img.shields.io/gitea/stars/Dnny44/docker-epg?gitea_url=https%3A%2F%2Fgit.donnymims.com
[stars-url]: https://git.donnymims.com/Dnny44/docker-epg/stars
[issues-shield]: https://img.shields.io/gitea/issues/open/Dnny44/docker-epg?gitea_url=https%3A%2F%2Fgit.donnymims.com
[issues-url]: https://git.donnymims.com/Dnny44/docker-epg/issues
[Docker.com]: https://img.shields.io/badge/docker-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Docker-url]: https://www.docker.com/