Skip to content

rohan-flutterint/telly

Repository files navigation

telly

IPTV proxy for Plex Live written in Golang

Please refer to the Wiki for the most current documentation.

Seriously, if you have problems the first thing we're going to ask is, "Have you gone through the walkthrough in the wiki?"

Setup

This readme refers to version #0eaf29 1.0.x #0eaf29. It does not apply to versions other than that.

Most users should use version 1.1 from the dev branch.

If you are looking for information about the new config-file based #f03c15 PRERELEASE BETA 1.1 #f03c15, go to the dev branch

If you are looking for information about the web-based #f03c15 UNSUPPORTED ALPHA 1.5 #f03c15, go to the telly Discord; there is no 1.5 documentation on github as yet.

See end of setup section for an important note about channel filtering

The Wiki includes walkthroughs for most platforms that go into more detail than listed below:

Go to the Wiki.

Quickstart:

Please read through to the end before trying to run telly. With 1.0, you will need at minimum two parameters, a playlist and a filter.

  1. Go to the Wiki.

  2. Go to the releases page and download the correct version for your operating system

  3. Mark the file as executable for non-windows platforms chmod a+x <FILENAME>

  4. Rename the file to "telly" if desired; note that from here this readme will refer to "telly"; the file you downloaded is probably called "telly-linux-amd64.dms" or something like that. If you do not rename the file, then substitute references here to "telly" with the name of the file you've downloaded. Under Windows, don't forget the .exe; i.e. telly.exe.

  5. Have the .m3u file on hand from your IPTV provider of choice Any command arguments can also be supplied as environment variables, for example --iptv.playlist can also be provided as the TELLY_IPTV_PLAYLIST environment variable

  6. Run telly with the --iptv.playlist commandline argument pointing to your .m3u file. (This can be a local file or a URL) For example: ./telly --iptv.playlist=/home/github/myiptv.m3u

  7. If you would like multiple streams/tuners use the --iptv.streams commandline option. Default is 1. When setting or changing this option, plexmediaserver will need to be completely restarted.

  8. If you would like telly to attempt to the filter the m3u a bit, add the --filter.regex commandline option. If you would like to use your own regex, run telly with --filter.regex="<regex>", for example --filter.regex=".*UK.*" Regex behavior is by default a blacklist; telly will EXCLUDE channels that match your regex [and if unspecified the filter matches ALL channels]; to reverse this and INCLUDE channels that match your regex, add --filter.regex-inclusive to the command line.

  9. If telly tells you [telly] [info] listening on ... - great! Your .m3u file was successfully parsed and telly is running. Check below for how to add it into Plex.

  10. If telly fails to run, check the error. If it's self explanatory, great. If you don't understand, feel free to open an issue and we'll help you out.

  11. For your IPTV provider m3u, try using option type=m3u_plus and output=ts.

Regex handling changed in 1.0. filter.regex has become a blacklist which defaults to blocking everything. If you are not using a regex to filter your M3U file, you will need to add at a minimum --filter.regex-inclusive to the command line. If you do not add this, telly will by default EXCLUDE everything in your M3U. The symptom here is typically telly seeming to start up just fine but reporting 0 channels.

Adding it into Plex

  1. Once telly is running, you can add it to Plex. Plex Live requires Plex Pass at the time of writing
  2. Navigate to app.plex.tv and make sure you're logged in. Go to Settings -> Server -> Live TV & DVR
  3. Click 'Setup' or 'Add'. The Telly virtual DVR should show up automatically. If it doesn't, press the text to add it manually - input THE_IP_WHERE_TELLY_IS:6077 (or whatever port you're using - you can change it using the -listen commandline argument, i.e. -listen THE_IP_WHERE_TELLY_IS:12345)
  4. Plex will find your device (in some cases it continues to load but the continue button becomes orange, i.e. clickable. Click it) - select the country in the bottom left and ensure Plex has found the channels. Proceed.
  5. Once you get to the channel listing, telly currently doesn't have any idea of EPG data so it starts the channel numbers at 10000 to avoid complications with selecting channels at this stage. EPG APIs will come in the future, but for now you'll have to manually match up what telly is telling Plex to the actual channel numbers. For UK folk, Sky HD is the best option I've found.
  6. Once you've matched up all the channels, hit next and Plex will start downloading necessary EPG data.
  7. Once that is done, you might need to restart Plex so the telly tuner is not marked as dead.
  8. You're done! Enjoy using telly. :-)

Docker

Go to the Wiki.

docker run

docker run -d \
  --name='telly' \
  --net='bridge' \
  -e TZ="Europe/Amsterdam" \
  -e 'TELLY_IPTV_PLAYLIST'='/home/github/myiptv.m3u' \
  -e TELLY_IPTV_STREAMS=1 \
  -e TELLY_FILTER_REGEX='.*UK.*' \
  -p '6077:6077/tcp' \
  -v '/tmp/telly':'/tmp':'rw' \
  tellytv/telly --web.base-address=localhost:6077

docker-compose

telly:
  image: tellytv/telly
  ports:
    - "6077:6077"
  environment:
    - TZ=Europe/Amsterdam
    - TELLY_IPTV_PLAYLIST=/home/github/myiptv.m3u
    - TELLY_FILTER_REGEX='.*UK.*'
    - TELLY_WEB_LISTEN_ADDRESS=telly:6077
    - TELLY_IPTV_STREAMS=1
    - TELLY_DISCOVERY_FRIENDLYNAME=Tuner1
    - TELLY_DISCOVERY_DEVICEID=12345678
  command: -base=telly:6077
  restart: unless-stopped

Troubleshooting

Please free to open an issue if you run into any issues at all, I'll be more than happy to help.

Social

We have a Discord server you can join!