Skip to content

Commit

Permalink
Add documentation on necessary Tvheadend user access rights
Browse files Browse the repository at this point in the history
  • Loading branch information
taligentx committed Jul 12, 2018
1 parent 5c7353b commit 654aa50
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# LiveTVH.bundle
LiveTVH provides live TV streaming for [Plex](https://plex.tv) via [Tvheadend](https://tvheadend.org), including metadata from Tvheadend's EPG, [theTVDB](https://thetvdb.com), and [The Movie DB](https://www.themoviedb.org).

## Features
* Playback of Tvheadend video channels, audio channels, and recordings.
* EPG displayed as a simple list within each channel description.
* Metadata and artwork lookup from theTVDB (using EPG zap2it IDs if available) and The Movie DB.
* Direct streaming (experimental, primarily tested with Plex Web and iOS).

## Release notes

* 2018.07.08 - [LiveTVH 1.3](https://github.com/taligentx/LiveTVH.bundle/releases/tag/v1.3)
This pushes the pre-existing changes in the develop branch to master as a release.
* This pushes the pre-existing changes in the develop branch to master as a release.
* Updated: Tvheadend channel tags support additional codecs, resolutions, and radio (audio-only) channels
* Updated: Changed image filenames to match Plex channel guidelines.
* Updated: Changed image filenames to match Plex channel guidelines
* Updated: Replaced deprecated string substitution per [#18](https://github.com/taligentx/LiveTVH.bundle/pull/18)

* 2017.05.22 - [LiveTVH 1.2](https://github.com/taligentx/LiveTVH.bundle/releases/tag/v1.2)
* New: Paginated channel lists with configurable # of items per page - this helps with longer channel lists (a necessity for IPTV providers with thousands of channels).
Expand All @@ -26,12 +34,6 @@ LiveTVH provides live TV streaming for [Plex](https://plex.tv) via [Tvheadend](h

* 2017.05.10 - Initial release 1.0

## Features
* Playback of Tvheadend video channels, audio channels, and recordings.
* EPG displayed as a simple list within each channel description.
* Metadata and artwork lookup from theTVDB (using EPG zap2it IDs if available) and The Movie DB.
* Direct streaming (experimental, primarily tested with Plex Web and iOS).

## Screenshots
![Plex Web Posters Screenshot](https://cloud.githubusercontent.com/assets/12835671/26337954/21753de4-3f42-11e7-895d-005c4da6b0a5.jpg)
![Plex Web Screenshot](https://cloud.githubusercontent.com/assets/12835671/25927053/c6212fda-35b8-11e7-98ca-ad636e62076e.jpg)
Expand All @@ -42,15 +44,18 @@ LiveTVH provides live TV streaming for [Plex](https://plex.tv) via [Tvheadend](h

## Setup
1. [Download LiveTVH.bundle](https://github.com/taligentx/LiveTVH.bundle/releases/) and unzip to the [Plex Media Server/Plug-ins](https://support.plex.tv/hc/en-us/articles/201106098-How-do-I-find-the-Plug-Ins-folder-) directory.
2. Set the LiveTVH preferences with the Tvheadend LAN IP address/hostname (or WAN for remote access), username, and password.
2. From the Tvheadend web interface, navigate to Configuration > Users > Passwords and create a user and password.
3. Navigate to Configuration > Users > Access Entries and create a new access entry.
4. Select "Web interface", Streaming > "Basic", and Video recorder > "Basic".

![Tvheadend Access Entry screenshot](https://user-images.githubusercontent.com/12835671/42663549-95fdfd76-85fb-11e8-8b02-b2022d8c6cff.png)
5. Set the LiveTVH preferences with the Tvheadend LAN IP address/hostname (or WAN for remote access), username, and password.

![Prefs Screenshot](https://cloud.githubusercontent.com/assets/12835671/26337942/0a4d9724-3f42-11e7-9654-7c8e82e4877a.jpg)
3. Watch!
6. Watch!

## Notes
* Channels will take a bit of time to load initially while metadata is fetched and speed up over time as the cache is built up (up to 30 days). 20-30 channels per page works reasonably well.

* While Tvheadend recordings can be played, managing new recordings will need to be handled outside of Plex, or by using [Plex DVR](https://www.plex.tv/features/dvr) and [tvhProxy](https://github.com/jkaberg/tvhProxy)).
* Channels will take a bit of time to load initially while metadata is fetched and speed up over time as the cache is built up and stored for 30 days. Up to 30 channels per page works reasonably well.

* Direct streaming of channels on Plex Web, iOS, and Roku requires identifying the channel's codecs and resolution using Tvheadend channel tags. Create and set channel tags in Tvheadend as appropriate for each channel (Tvheadend supports editing multiple selections to make this a quick update):
* Video tags: `H264`, `MPEG2`, `HEVC`, `VP8`, `VP9`
Expand All @@ -62,6 +67,8 @@ LiveTVH provides live TV streaming for [Plex](https://plex.tv) via [Tvheadend](h

* Radio (audio-only) channels are also identified using Tvheadend channel tags - create and set a `Radio` tag in Tvheadend on the appropriate channels for audio-only playback, as well as audio tags (for example, `AAC`) for direct streaming.

* While Tvheadend recordings can be played, managing new recordings will need to be handled outside of Plex, or by using [Plex DVR](https://www.plex.tv/features/dvr) and [tvhProxy](https://github.com/jkaberg/tvhProxy)).

* Watching remotely may require Tvheadend to have a public-facing address, as some clients will attempt to directly play the Tvheadend stream instead of running through the Plex transcoder.

In this case, putting Tvheadend behind a [reverse proxy with SSL](https://www.nginx.com/resources/admin-guide/reverse-proxy/) is highly recommended, as the Tvheadend username and password is sent using HTTP Basic Authentication and is not secure over plain HTTP.
Expand Down

0 comments on commit 654aa50

Please sign in to comment.