Radio-API web interface - how to know own GUI code for login to Radio-API Web interface?

[ysha0]

Hi, I've set up the necessary DNS redirection with LAN router, configured and started the Radio-API Docker container based on image from https://github.com/KIMB-technologies/Radio-API.

• Version of Radio-API: 2.9.4
• Installation mode: Docker
• DNS redirect via: LAN router configurations
• Radio vendor: Sangean WFT-2D
• Usage of reverse proxy: using Docker container only
• Does another radio use your installation of Radio-API: no

Now I'm on login page that looks like the image below https://github.com/KIMB-technologies/Radio-API/blob/master/screenshots/login.png.

How can I find or generate the GUI code needed to log in to the Radio-API web interface?

[ysha0]

Tests the Radio-API with browser listed below passed Ok.

http://radio.example.com/setupapp/iden/asp/BrowseXML/loginXML.asp?token=0

http://radio.example.com/setupapp/iden/asp/BrowseXML/loginXML.asp?gofile=&mac=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&dlang=eng&fver=4&ven=iden00

It looks like the router isn't accessing the Radio-API IP server. The Sangean receiver is still accessing to the wifiradiofrontiers servers (IP 192.248.188.143) because it has its own DNS address cache, which is located within the receiver itself (non-volatile memory). I'm not sure how to flush DNS cache of receiver. For now, I don't want to perform a full reset of the receiver. It might help to configure router for redirect the receiver to the Radio-API server's IP address when attempting to access wifiradiofrontier servers.

[kimbtech]

Hi,
I never had any issues with DNS caches in the Radio itself. Normally, they should clear within the time to live values of DNS and if I look correctly on the ones of Wifiradiofrontier, then they are only a couple of hours.

Is there a way to test if the DNS redirect based on "LAN router configurations" works? When connecting my radio via WiFi there is a status web page (available on local network), which also lists the DNS settings of the radio.

[ysha0]

Is there a way to test if the DNS redirect based on "LAN router configurations" works? When connecting my radio via WiFi there is a status web page (available on local network), which also lists the DNS settings of the radio.

I have so far come to the conclusion that it is necessary to use such a redirect for Sangean device but for now I wanted to limit myself to Prology only device and make it work successfully. Now I'm have problem "File not found" when select "Station" on Prology but .json file records is added on Radio-API server and listed on Radio-API file file system. At now special router configuration is currently postponed until the successful completion work with Prology device.

[ysha0]

Hi,
Meanwhile I tested two devices: the Progoly WR-100 and the Sangean WFT-2D with same configuration of the router and Radio-API server. All request from interenet receivers to the wifiradiofrontier and internetradiofrontier domains redirect to local Radio-API server. This redirect tested and worked Ok.

Radio-API serve container run with "docker run -d -p 0.0.0.0:80:80 -e "CONF_ALLOWED_DOMAIN=all" -e "CONF_USE_JSON_CACHE=true" kimbtechnologies/radio_a"

I'm have access to Radio-API GUI web interface with http://192.168.1.11/gui/ and http://radio.example.com/gui/ (via local DNS record radio.excample.com 192.168.1.11)

But at the same time Prology succesfully connected to Radio-API web interface, I'm got GUI code authorization to the web interface, login to web and succesfully add 1st own station. When Prology display Radio-API interface on own display when I'm select "Station" Prology display error "File not found". But this is already progress and we can deal with it further.

Sangean under the same conditions do not connect to to Radio-API local server. Diagnostics detected a direct connect to the server 192.248.188.143. It's very strange, but Sangean connects to the this address despite the DNS redirect to local Radio-API server. I didn't find any other Sangean DNS queries in the router DNS cache that could lead to the address 192.248.188.143. Based on this, I conclude that there is a local DNS cache in the Sangean. I don't want to do a factory reset just yet and the only way route Sangean to the local Radio-API local server is the additional router configuration when all request to IP 192.248.188.143 should be redirected to the Radio-API local server by the special router configuration.

I also have a question - what could cause the error "File not found" on the Prology device? Сould this be related to the parameter "CONF_USE_JSON_CACHE=true". I don't want to use the in-memory caching infrastructure and only use records based on files.

[kimbtech]

Hi,

for the first radio (Prology), Radio-API expects one more mandatory ENV parameter CONF_DOMAIN. Currently, it will create links like http:/list?tid=3, so with a missing host/ domain.

A minimal command would be:

docker run -d -p 0.0.0.0:80:80 -e "CONF_ALLOWED_DOMAIN=all" -e "CONF_USE_JSON_CACHE=true" -e "CONF_DOMAIN=http://radio.example.com/" kimbtechnologies/radio_api

You may also set CONF_DOMAIN=http://192.168.1.11/ to your local IP address.

In addition, I would recommend to add a mounted folder or a volume for the path /php-code/data/ in the container, as the radio stations are stored there, e.g., -v "./radio-data:/php-code/data/".

---

For the other radio (Sangean):
As you setup and DNS redirect works for Prology, I do not have any idea where the problem could be. Do you have the possibility to log/ capture the full HTTP traffic between the radio and the server at 192.248.188.143?

There is another user who got a Sangean to work, see #49.

Does the radio show network connection settings somewhere? Maybe the DNS server is not set to the local router, but some external server?

---

I assume the "File not found" was cause by the links without domain (http:/list?tid=3), setting CONF_DOMAIN= hopefully fixes it.

[ysha0]

For the other radio (Sangean):
As you setup and DNS redirect works for Prology, I do not have any idea where the problem could be. Do you have the possibility to log/ capture the full HTTP traffic between the radio and the server at 192.248.188.143?

It would be interesting to know how to intercept HTTP traffic between the radio module and the server at 192.248.188.143 when using a Wi-Fi connection?

[kimbtech]

Some home routers allow to capture all connections and provide a file for download.

If you use WiFi and have a compatible WiFi card in your computer, capturing is possible using Whireshark: https://wiki.wireshark.org/CaptureSetup/WLAN — but the setup is a bit fiddly.

Side note: This way I captured the requests between radio and API while developing Radio-API.

[ysha0]

Some home routers allow to capture all connections and provide a file for download.

If you use WiFi and have a compatible WiFi card in your computer, capturing is possible using Whireshark: https://wiki.wireshark.org/CaptureSetup/WLAN — but the setup is a bit fiddly.

Side note: This way I captured the requests between radio and API while developing Radio-API.

Thanks, the general principle is clear, it may be useful in the future.

[ysha0]

I made some progress in work with Sangean receiver. I found two more DNS requests "sangean.wifiradiofrontier.com" and "sangean2.wifiradiofrontier.com" that for some reason weren't redirected local Radio-API server. I have made the necessary changes in DNS to the router configuration to redirect the specified domains. Docker now run with 'docker run --restart unless-stopped -d -p 0.0.0.0:80:80 -e "CONF_ALLOWED_DOMAIN=all" -e "CONF_USE_JSON_CACHE=true" -e "CONF_DOMAIN=http://192.168.1.11/" -v "./radio-data:/php-code/data/" kimbtechnologies/radio_api'

Now both receivers connect to local Radio-API server succesfully.

What file format is required for the station logo? How looks like example record in Radio-API server GUI Web interface for my case "http://192.168.1.11/radios_1.png"? We are talking about "logo" field at screenshot https://github.com/KIMB-technologies/Radio-API/raw/master/screenshots/edit-radio.png when add station.

In the file system of the Radio-API server container at /php-code/data/ folder, I currently see two files, "radios_1.json" and "radios_2.json", with identical contents inside. These are identical recordings from the same station, but for each receiver.
Is it possible to create a single list of stations for both receivers so as not to duplicate the local Radio API server record files for each GUI code since the same set of radio stations is used? Or maybe there is some common GUI code for all devices?

[kimbtech]

Hi,
happy to hear that both radios connect now!

The logo can be mostly any URL to the logo of the radio station. It can be left blank and a default image will be used.
If the logo file is big in terms of resolution, served via SSL, or is an SVG file, the radio may not be able to directly show the file. To support such cases, Radio-API provides a logo cache including a converter, it needs to be enabled by setting CONF_USE_LOGO_CACHE=true to the Docker container. Then, it would be recommended to also map the logo cache folder outside of the container: -v "./media/:/php-code/media/".

Radio-API considers each radio as its own, there is no user and station management combining stations between radios.
The only way to share global stations between all radios of the same Radio-API install is the Own Streams feature (https://github.com/KIMB-technologies/Radio-API/blob/master/Setup.md#own-streams). It would allow you to include a manually created JSON file with stations, but I assume this would be more work than adding the same stations to both radios separately. (If there are many stations, create all of them for one radio. Stop the container, copy the file, e.g., radios_1.json to radios_2.json, clear the cache folder and restart container. This is hacky, but will duplicate all stations.)

[kimbtech]

Besides the hacky way copying files for transfering stations from one radio to another, there is the Im-/Export function (https://github.com/KIMB-technologies/Radio-API/blob/master/Setup.md#im---export). It allows to import an export and thereby overwrite the settings of one radio with the values of another.

[ysha0]

Stop the container, copy the file, e.g., radios_1.json to radios_2.json, clear the cache folder and restart container.

Indeed, this method is simpler. What command is used to clear the cache folder?

[kimbtech]

There is no command to do it. Make sure the container is not running and then remove all files in the /php-code/data/cache (in container folder). On the local disk it may be something like rm ./radio-data/cache/*.json.

[kimbtech]

Yes, this is the folder with the cache files. The mapping -v "./radio-data:/php-code/data/" maps the folder /php-code/data/ inside the container to the folder ./radio-data on your host system. After stopping (and also when running) your container, there will be a folder ./radio-data somewhere on your host system. As we use the relative ./, the folder was created where you ran docker run ....

In case you do not know where this is: Try running pwd (in the same way as docker run ...) and it will show the full path, also you may run ls . and should see something like radio-data. After stopping your container, you then can remove the json files in ./radio-data/cache/.

[kimbtech]

I got an email with a question about where to add the folder mapping, but the question does not show up here. All of these commands belong to Docker, so a more complete docker run command could be:

docker run -d -p 0.0.0.0:80:80 -e "CONF_ALLOWED_DOMAIN=all" -e "CONF_USE_JSON_CACHE=true" -e "CONF_DOMAIN=http://192.168.1.11/" -e "CONF_USE_LOGO_CACHE=true" -v "./radio-data:/php-code/data/" -v "./radio-media/:/php-code/media/" kimbtechnologies/radio_api

[ysha0]

I got an email with a question about where to add the folder mapping, but the question does not show up here. All of these commands belong to Docker, so a more complete docker run command could be:

This question was previously here, but I found the answer in Internet and removed the original question, but thank you for the full docker Radio-API container format run.

[ysha0]

I am using the latest version of the Radio-API container from github. Currently, it is 2.9.4. Should I commit the current version as 2.9.4 when running the container to avoid issues with global changes in the Radio-API server development?
Or do you plan to make changes that are compatible with earlier versions?

We are talking about "kimbtechnologies/radio_api:latest" or "kimbtechnologies/radio_api:2.9,4" in docker run parameters.

[kimbtech]

I normally try to make changes compatible.

There are two types of image updates:

• packages and OS (regular fresh builds of image, no changes in Radio-API, but new libraries, PHP binaries, etc. → Radio-API tag and version will stay the same)
• Radio-API changes (code changes in Radio-API, I will try to make everything compatible and add a release note here → change will get a new version number and tag)

So, in general one may use :latest. It is also possible to use :2 or :2.9 – to only get "small" or "medium" updates. However, right now I do not plan any bigger changes in the future and especially no breaking ones.

In all cases, Radio-API has a new version indicator. It will show a message in the web interface, when a new version is available. This indicator will work independently from the used Docker tag.

[ysha0]

Nuvola Frontier has ended support for these receivers. Currently, support is provided by airable GmbH (https://airable.fm), but they may also end support at any time. In this case, the receiver will lose its functionality. I would like to avoid this issue in the future. Your solution will help extend the life of these receivers which is great! Thank you very much for your Radio-API project!

[kimbtech]

Happy to hear Radio-API is useful!

[ysha0]

Hi. how do I disable ./radio-data/radiobrowser.log? This log is starting to grow.

[kimbtech]

Hi,
it is not directly possible to disable this log. It only logs errors while communicating to the Radio-Browser.info API and thus should normally not grow.

However, it is possible to set the directory where the log file is created. And one may just set it to the null device, i.e., set the environment variable CONF_LOG_DIR=/dev/null. In doing so, all data sent to the log folder (and files) will be never be recorded or written to disk.

[ysha0]

Like additional parameters in string when running docker container -e "CONF_LOG_DIR=/dev/null" ?

[kimbtech]

Yes, exactly.