Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
m0ngr31 committed Oct 4, 2021
1 parent e1f2018 commit 08d06e7
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# EPlusTV

<p align="center">
<img src="https://i.imgur.com/FIGZdR3.png">
</p>

Current version: **0.9.0**

## About
This takes ESPN+ and transforms it into a "live TV" experience. It will discover what is on, create a schedule of channels and give you an m3u and xmltv file that you can import into things like Jellyfin, Channels DVR, or just maybe Jellyfin through Channels DVR!
This takes ESPN+ and transforms it into a "live TV" experience with virtual linear channels. It will discover what is on, and generate a schedule of channels that will give you M3U and XMLTV files that you can import into something like Jellyfin or VLC.

#### Notes
* This was not made for pirating streams. This is made for using your own credentials and have a different presentation than the ESPN+ app currently gives.
* Currently this software is in a very beta state. It hasn't been fully tested and relies on some lame workarounds to get the data needed to start a stream. There are some questions about how boundies work when a scheduled entry ends or when a new entry starts if it will pick it up automatically.
* The Mouse might not like it and it could be taken down at any minute. Enjoy it while it lasts. ¯\\_(ツ)_

## Using
The server exposes 2 main endpoints:
Expand All @@ -19,19 +28,19 @@ The recommended way of running is to pull the image from [Docker Hub](https://hu
### Docker Setup

#### Environement Variables
| Environment Variable | Description |
|---|---|
| ACCESS_URI | What accessable URL your clients will be connecting from. For example: `http://192.168.0.1:8000` |
| ESPN_USER | Your ESPN+ Username |
| ESPN_PASS | Your ESPN+ Password |
| START_CHANNEL | What the first channel number should be. Keep in mind this generates 100 channels to keep a healthy buffer. |
| Environment Variable | Description | Required? |
|---|---|---|
| ACCESS_URI | What accessable URL your clients will be connecting from. For example: `http://192.168.0.1:8000` | Yes |
| ESPN_USER | Your ESPN+ Username | Yes |
| ESPN_PASS | Your ESPN+ Password | Yes |
| START_CHANNEL | What the first channel number should be. Keep in mind this generates 100 channels to keep a healthy buffer. | No. If not set, the start channel will default to 1. |


#### Volumes
| Volume Name | Description |
|---|---|
| /app/config | Used to store DB and application state. |
| /app/tmp | Used to store temporary segments generated by the streams. Recommended to use something like `/dev/shm`. |
| Volume Name | Description | Required? |
|---|---|---|
| /app/config | Used to store DB and application state. | No. But channel schedules will not be persisted. |
| /app/tmp | Used to store temporary segments generated by the streams. Recommended to use something like `/dev/shm`. | No |


#### Docker Run
Expand Down

0 comments on commit 08d06e7

Please sign in to comment.