Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m0ngr31/ccepg
https://github.com/m0ngr31/ccepg
abc channels-dvr-server custom-channels peacock-tv xmltv xmltv-epg
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/m0ngr31/ccepg
- Owner: m0ngr31
- License: mit
- Created: 2024-10-12T15:16:41.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-22T21:53:49.000Z (3 months ago)
- Last Synced: 2024-10-23T09:38:04.327Z (3 months ago)
- Topics: abc, channels-dvr-server, custom-channels, peacock-tv, xmltv, xmltv-epg
- Language: TypeScript
- Homepage:
- Size: 290 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Current version: **0.1.5**
# About
This allows you to fetch EPG data for linear streaming services such as Peacock and ABC, and transforms them so you can use them with [chrome-capture-for-channels](https://github.com/fancybits/chrome-capture-for-channels).
# Using
The server exposes 2 main endpoints:
| Endpoint | Description |
|---|---|
| /channels.m3u | The channel list you'll import into your client |
| /xmltv.xml | The schedule that you'll import into your client |
# Running
The recommended way of running is to pull the image from [Docker Hub](https://hub.docker.com/r/m0ngr31/ccEPG).
## Environment Variables
| Environment Variable | Description | Required? | Default |
|---|---|---|---|
| PUID | Current user ID. Use if you have permission issues. Needs to be combined with PGID. | No | - |
| PGID | Current group ID. Use if you have permission issues. Needs to be combined with PUID. | No | - |
| PORT | Port the API will be served on. You can set this if it conflicts with another service in your environment. | No | 8787 |
## Volumes
| Volume Name | Description | Required? |
|---|---|---|
| /app/config | Used to store DB and application state | Yes |
## Docker Run
By default, the easiest way to get running is:
```bash
docker run -p 8787:8787 -v config_dir:/app/config m0ngr31/ccepg
```
If you run into permissions issues:
```bash
docker run -p 8787:8787 -v config_dir:/app/config -e PUID=$(id -u $USER) -e PGID=$(id -g $USER) m0ngr31/ccepg
```