update readme
This commit is contained in:
parent
4abff2f56a
commit
4cbba7691e
29
README.md
29
README.md
@ -3,17 +3,28 @@
|
|||||||
This repo builds and Docker image of [iptv-org/epg](https://github.com/iptv-org/epg).
|
This repo builds and Docker image of [iptv-org/epg](https://github.com/iptv-org/epg).
|
||||||
The purpose is to make the deployment easier and more suitable for different environments.
|
The purpose is to make the deployment easier and more suitable for different environments.
|
||||||
|
|
||||||
|
The original repository of this image is hosted on https://git.claeyscloud.com/david/epg-info-docker.
|
||||||
|
A public mirror is available at https://github.com/davidclaeysquinones/epg-info-docker.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
[Node](https://nodejs.org/en)<br>
|
[Node](https://nodejs.org/en)<br>
|
||||||
[pm2](https://www.npmjs.com/package/pm2)<br>
|
[pm2](https://www.npmjs.com/package/pm2)<br>
|
||||||
[serve](https://www.npmjs.com/package/serve)<br>
|
[serve](https://www.npmjs.com/package/serve)<br>
|
||||||
|
|
||||||
|
The image is based on `node:21-alpine` in order to be more lightweight.
|
||||||
|
The `pm2` and `serve` packages are used in order to run the application in the container.
|
||||||
## Docker image
|
## Docker image
|
||||||
|
|
||||||
### Paths
|
### Paths
|
||||||
|
|
||||||
An example `channels.xml` is included by default in the image.<br>
|
An example `channels.xml` is included by default in the image.<br>
|
||||||
|
```xml
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<channels>
|
||||||
|
<channel site="movistarplus.es" lang="es" xmltv_id="24Horas.es" site_id="24H">24 Horas</channel>
|
||||||
|
...
|
||||||
|
</channels>
|
||||||
|
```
|
||||||
However if you want to configure your own channels you need to provide your own configuration file.<br>
|
However if you want to configure your own channels you need to provide your own configuration file.<br>
|
||||||
You can do this by creating a mapping in the `/config` folder.
|
You can do this by creating a mapping in the `/config` folder.
|
||||||
|
|
||||||
@ -25,3 +36,21 @@ You can do this by creating a mapping in the `/config` folder.
|
|||||||
| DAYS | Describes the desired amount of days in the future for for epg retrieval. | 14 |
|
| DAYS | Describes the desired amount of days in the future for for epg retrieval. | 14 |
|
||||||
| MAX_CONNECTIONS | The maximum amount of parallel connections that can be established | 10 |
|
| MAX_CONNECTIONS | The maximum amount of parallel connections that can be established | 10 |
|
||||||
|
|
||||||
|
### Compose file
|
||||||
|
|
||||||
|
```sh
|
||||||
|
version: '3.3'
|
||||||
|
services:
|
||||||
|
epg:
|
||||||
|
image: git.claeyscloud.com/david/epg-info:latest
|
||||||
|
#image: image: git.claeyscloud.com/david/epg-info:latest:latest
|
||||||
|
volumes:
|
||||||
|
# add a mapping in order to add the channels file
|
||||||
|
- /docker/epg:/config
|
||||||
|
ports:
|
||||||
|
- 6060:3000
|
||||||
|
environment:
|
||||||
|
# specify the time zone for the server
|
||||||
|
- TZ=Etc/UTC
|
||||||
|
restart: unless-stopped
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user