search

milaq / YCast

Self hosted vTuner internet radio service emulation
Other
249 stars 96 forks source link

readme

YCast

PyPI latest version GitHub latest version Python version License GitHub issues

Get it via PyPI

Download from GitHub

Issue tracker

YCast is a self hosted replacement for the vTuner internet radio service which many AVRs use. It emulates a vTuner backend to provide your AVR with the necessary information to play self defined categorized internet radio stations and listen to Radio stations listed in the Community Radio Browser index.

YCast is for you if:

Supported devices

Theoretically, YCast should work for most AVRs which support vTuner. Most AVRs with network connectivity that were produced between 2011 and 2017 have vTuner support built-in.

Go ahead, test it with yours and kindly report the results back. Any reported device helps the community to see which AVRs work properly and which may have issues.

Confirmed working

Unconfirmed/Experimental

Dependencies:

Python version: 3

Python packages:

Usage

YCast really does not need much computing power nor bandwidth, i.e. you can run it on a low-spec RISC machine like a Raspberry Pi or a home router.

DNS entries

You need to create a manual entry in your DNS server (read 'Router' for most home users). The *.vtuner.com domain should point to the machine YCast is running on. Specifically the following entries may be configured instead of a wildcard entry:

Running the server

With built-in webserver

You can run YCast by using the built-in development server of Flask (not recommended for production use, but should™ be enough for your private home use): python -m ycast

While you can simply run YCast with root permissions listening on all interfaces on port 80, this may not be desired for various reasons.

You can change the listen address and port (via -l and -p respectively) if you are already running a HTTP server on the target machine and/or want to proxy or restrict YCast access.

It is advised to use a proper webserver (e.g. Nginx) in front of YCast if you can. Then, you also don't need to run YCast as root and can proxy the requests to YCast running on a higher port (>1024) listening only on localhost.

You can redirect all traffic destined for the original request URL (e.g. radioyamaha.vtuner.com, onkyo.vtuner.com) or need to redirect the following URLs from your webserver to YCast:

Attention: Do not rewrite the requests transparently. YCast expects the complete URL (i.e. including /ycast or /setupapp). It also need an intact Host header; so if you're proxying YCast you need to pass the original header on. For Nginx, this can be accomplished with proxy_set_header Host $host;.

In case you are using (or plan on using) Nginx to proxy requests, have a look at this example. This can be used together with this systemd service example for a fully functional deployment.

With WSGI

You can also setup a proper WSGI server. See the official Flask documentation.

Custom stations

If you want to use the 'My Stations' feature, create a stations.yml and run YCast with the -c switch to specify the path to it. The config follows a basic YAML structure (see below).

Category one name:
  First awesome station name: first.awesome/station/URL
  Second awesome station name: second.awesome/station/URL

Category two name:
  Third awesome station name: third.awesome/station/URL
  Fourth awesome station name: fourth.awesome/station/URL

You can also have a look at the provided example to better understand the configuration.

Firewall rules

Caveats