From 20e3f22f3f7f4178cc20953159d3a17beaa4c8a5 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Fri, 5 Jun 2026 19:55:14 +0000 Subject: [PATCH] docs(azuracast): Add clearer guidance on station configuration and access --- .../docs/configuration/sources/azuracast.mdx | 68 ++++++++++++++++++- 1 file changed, 65 insertions(+), 3 deletions(-) diff --git a/docsite/docs/configuration/sources/azuracast.mdx b/docsite/docs/configuration/sources/azuracast.mdx index 199d6d10..1a09bb19 100644 --- a/docsite/docs/configuration/sources/azuracast.mdx +++ b/docsite/docs/configuration/sources/azuracast.mdx @@ -16,9 +16,9 @@ Azuracast may not correctly report track length or position. If this is the case ::: -The Azuracast server should have **Use High-Performance Now Playing Updates** enabled in _Administration -> System Settings_ +The Azuracast server should have **Use [High-Performance Now Playing Updates](https://www.azuracast.com/docs/developers/now-playing-data/#high-performance-updates)** enabled in _Administration -> System Settings_ -#### URL +### URL The URL used by MS to connect to Azuracast has the syntax: @@ -47,6 +47,68 @@ If either is configured then MS will automatically scrobble based on when these If neither is configured automatic scrobble defaults to **off** and you should either manually initiate it or explicitly set the default behavior. +### Station + +#### Station Identifier + +The station identifier multi-scrobbler uses (ENV `AZURA_STATION` or `station` in File/AIO config) needs to be the **URL Stub** or **shortcode** of the Azuracast station, **not** its display name. Use of the methods below to find an apprioriate station identifier. + + + +The **URL Stub** is the value used in the URL to access the station EX + +``` +https://azura.mydomain.com/public/my-cool-station + ^^^^ url stub ^^ +``` + +Use `my-cool-station` as the station identifier. + + +The **shortcode** can be found in the raw JSON response for your station. Navigate to this URL in your browser: + +``` +https://azura.mydomain.com/api/stations +``` + +Find your station in the returned data (by `name`) and then locate the value of the `shortcode` property in that object. + +
+ +Example + +```json +[ + { + "id": 1, + "name": "My Cool Station", + "shortcode": "my-cool-station", + "description": "Re-broadcasts of my cool music", + "frontend": "icecast", + "backend": "liquidsoap", + ... +``` + +Use `my-cool-station` as the station identifier. +
+
+
+ +#### Station Access + +Multi-Scrobbler does not use authentication to communicate with Azuracast. Your station will likely need some form of **Public Pages** in order for you to monitor it. + +In your station's **Edit Station Settings** -> **Public Pages** make sure that at least one of these is enabled: + +* Enable Public Pages +* Enable Public APIs + +:::note + +For users who aren't administrators of Azuracast: if you can access the station using `https://azura.mydomain.com/public/xxxxxx` then it is public. + +::: + ## Configuration @@ -54,7 +116,7 @@ If neither is configured automatic scrobble defaults to **off** and you should e | :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- | | `AZURA_ID` | Yes | | A unique ID | | `AZURA_URL` | Yes | | Azuracast URL *without station name* | - | `AZURA_STATION` | Yes | | The station name shown on the public page | + | `AZURA_STATION` | Yes | | The station URL Stub or shortcode | | `AZURA_LIVE` | No | Yes | Only scrobble when station status is ONLINE | | `AZURA_LISTENERS_NUM` | No | `true` | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` | | `AZURA_NAME` | No | | A vanity name different than ID | -- 2.51.2