antennas

!Antennas

A JavaScript port of tvhProxy which is a program that translates the Tvheadend API to emulate a HDHomeRun API. This is particularly useful to connect Plex's DVR feature to Tvheadend.

Getting it running

$3

To be able to stream from Tvheadend through Plex, you need to set up an anonymous user in Tvheadend that has streaming rights. You can do this in the users section, by creating a user *:

!Example configuration

$3

Head over to the release section and download the binary for your platform. It will come with a config/config.yml that you can edit to reflect your setup, and you can simply run antennas in the console and the server will start up and start proxying Tvheadend over to Plex!

$3

Right now, due to Docker networking issues, the best way to get this working is by running it directly through node.

* Set up Node locally
* Clone this repo: git clone https://github.com/jfarseneau/antennas.git or download the source code directly from releases and extract it
* Run yarn install or npm install to install dependencies
* In the directory where it was extracted, run node index.js (Note, Node version must be above 7)

To run it as a daemon:
node index.js >/dev/null 2>&1 &

Run locally using NPX

`` shell
npx antennas --config foo/bar.yml
`

OR

` shell
TVHEADEND_URL=http://admin:test@192.168.0.1:9981 ANTENNAS_URL=http://127.0.0.1:5004 TUNER_COUNT=6 DEVICE_UUID=2f70c0d7-90a3-4429-8275-cbeeee9cd605 npx antennas
``

$3

Another way to get it running is to run it using Docker. Note that some functionality is currently not quite working when hosting this as a Docker container, namely, discovery from Plex. But with that warning, if you so choose to continue using Docker, the instructions are below.

To start a Docker container running Antennas, run the command below. Note you must replace the ANTENNAS_URL and TVHEADEND_URL value to match your setup:

` shell
docker run -p 5004:5004 -e ANTENNAS_URL=http://x.x.x.x:5004 -e TVHEADEND_URL=http://replace:me@x.x.x.x:9981 thejf/antennas
`

To view if the configurations have been passed correctly, you can point your browser to where you are hosting Antennas (in the above example, it would be http://x.x.x.x:5004 but this is a placeholder address that __needs__ to be changed) and you should see a summary of your configurations on the page:

!Example landing page

Alternatively, you can set it with all the available environment variables:

` shell
docker create --name=antennas
-e ANTENNAS_URL=http://x.x.x.x:5004 \
-e TVHEADEND_URL=http://replace:me@x.x.x.x:9981 \
-e TUNER_COUNT=6 \
-p 5004:5004 \
thejf/antennas
`

And then docker start antennas

Or, you can try by mounting a volume, set by yourself in path/to/config, that will need a config.yml to work. Example of a config.yml is available here, or below:

` yml
tvheadend_url: http://replace:me@x.x.x.x:9981
antennas_url: http://x.x.x.x:5004
tuner_count: 6
`

* docker create --name=antennas -v :/antennas/config -p 5004:5004 thejf/antennas
* Set up config.yml (see configuration instructions here) where you pointed the config volume (what you replaced with
* Finally, docker start antennas

Configuration

Antennas can be configured either via the config.yml or environment variables. Environment variables take precedence over the config.yml.

$3

Antennas will look for three values inside a config/config.yml file. They are:

* tvheadend_url: This is the path to your Tvheadend setup, with username, password, and port. Plex doesn't like localhost so it's best to find your own local IP and put this in if Tvheadend and Plex are running on the same network. For example: http://user:pass@192.168.0.1:9981
* tuner_count: This is for the number of tuners in Tvheadend.
* stream_url: Optional field to set a stream URL that is different from the Tvheadend URL, for private Docker networks

$3

If you want to set environment variables instead of modifying the config.yml, you can do so. The environment variable names are the same than the config.yml, except capitalized. So, TVHEADEND_URL and TUNER_COUNT.

Optionally, for private Docker networks that need to expose a different URL for the streams, you can specify a public stream URL using TVHEADEND_STREAM_URL

$3

* --config followed by the config path, i.e. --config foo/bar.yml will allow you to set a custom path for the config file
* --nologo` will disable the big ASCII art logo for a simple text one

Contributing

1. Fork it ( )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request