Merge pull request #101 from mdrxy/main

Fixes broken links, expand sections

src/content/docs/docs/administration/advanced-features.md

@@ -28,3 +28,11 @@ Advanced features hidden by default include:
 These features can be re-enabled via the `Administration` -> `System Settings` page in the `Settings` tab.
 
 By checking the `Enable Advanced Features` checkbox and saving your settings you can enable the advanced features of AzuraCast.
+
+### Broadcasting
+
+#### Custom Configuration
+
+A common use case of the station-wide Icecast config is to publish your station's mount points to [YellowPage directories](/docs/user-guide/promoting-your-station/#yellowpages-directories).
+
+Additionally, you can overwrite some values such as `<location>` and the `<admin>` email address.

src/content/docs/docs/administration/command-line-interface.md

@@ -219,8 +219,8 @@ These tasks can also be invoked directly from the web interface via the Administ
 
 The AzuraCast CLI interface also exposes a number of other advanced commands. These commands are intended for developers to use when building the application, and often should not be run by station owners on production installations.
 
-For a full list of AzuraCast CLI commands, view them [here](https://github.com/AzuraCast/AzuraCast/blob/main/config/cli.php).
+For a full list of AzuraCast CLI commands, view them [here](https://github.com/AzuraCast/AzuraCast/blob/main/backend/config/cli.php).
 
 For more information about the additional command line tools available, see their respective documentation pages below:
-- [Doctrine Command Line Reference](https://www.doctrine-project.org/projects/doctrine-orm/docs/2.6/reference/tools.html#command-overview)
-- [Doctrine Migrations](https://www.doctrine-project.org/projects/doctrine-migrations/docs/latest/reference/introduction.html#introduction)
+- [Doctrine Command Line Reference](https://www.doctrine-project.org/projects/doctrine-orm/en/3.2/reference/tools.html)
+- [Doctrine Migrations](https://www.doctrine-project.org/projects/doctrine-migrations/en/3.8/reference/introduction.html)

src/content/docs/docs/administration/customization.md

@@ -15,7 +15,7 @@ There you can add your own JavaScripts to the public pages with the editor for `
 
 You can attach to events of the public player like this:
 
-```
+```javascript
 $(document).on('now-playing', function(np_new) {
     // custom code with np_new
 });

src/content/docs/docs/administration/docker.md

@@ -288,7 +288,7 @@ Return to the AzuraCast web interface, visit the "Mount Points" page for your st
 <intro>/intro.mp3</intro>
 ```
 
-For more information, see the [IceCast documentation.](https://www.icecast.org/docs/)
+For more information, see the [Icecast documentation.](https://www.icecast.org/docs/)
 
 ### Custom Favicon
 
@@ -298,16 +298,18 @@ In newer versions of AzuraCast, you can manage this via the web UI.
 
 To override the favicon and other browser icons used by AzuraCast, you should follow these steps:
 
-1. - Upload your icon to favicon-generator.org. Be sure to leave "Generate icons for Web, Android, Microsoft, and iOS (iPhone and iPad) Apps" checked.
-1. - Once your icon set is downloaded, it will be in a .zip file format; extract that file and copy it to the host server where AzuraCast is hosted.
-1. - Inside the AzuraCast directory on your host (by default, /var/azuracast), create a file named docker-compose.override.yml with the following contents:
+1. Upload your icon to favicon-generator.org. Be sure to leave "Generate icons for Web, Android, Microsoft, and iOS (iPhone and iPad) Apps" checked.
+2. Once your icon set is downloaded, it will be in a .zip file format; extract that file and copy it to the host server where AzuraCast is hosted.
+3. Inside the AzuraCast directory on your host (by default, /var/azuracast), create a file named docker-compose.override.yml with the following contents:
+
 ```yaml
 services:
     web:
         volumes:
             - /path/to/your/favicon/folder:/var/azuracast/www/static/icons/production
 ```
-Restart AzuraCast via `docker-compose down && docker-compose up -d`.
+
+4. Restart AzuraCast via `docker-compose down && docker-compose up -d`.
 
 ### Increase PHP Allowed Memory
 

src/content/docs/docs/getting-started/requirements.md

@@ -66,9 +66,9 @@ We strongly recommend one of the following distributions and versions for your A
 
 On the Administration page you can find a basic `Server Status` section that shows you the `CPU Load`, `Memory` and `Disk Space` usage of your server.
 
-### IceCast
+### Icecast
 
-For IceCast you can find some benchmarks for the following topics at https://icecast.org/loadtest/
+For Icecast you can find some benchmarks for the following topics at https://icecast.org/loadtest/
 
 - [Testing the maximum numbers of connected listeners](https://icecast.org/loadtest/1/)
 - [Testing the maximum numbers of connected sources](https://icecast.org/loadtest/2/)

src/content/docs/docs/getting-started/updates/release-channels.md

@@ -46,7 +46,7 @@ As an important note, though, if you have mistakenly switched to the "Stable" ch
 
 You can switch release channels by logging in to your host computer (the server running AzuraCast) via SSH and executing:
 
-```
+```bash
 cd /var/azuracast
 ./docker.sh update-self
 ./docker.sh setup-release

src/content/docs/docs/help/logs.md

@@ -16,13 +16,13 @@ Users with the appropriate permissions can also view many logs directly through
 
 If you are administrating your own AzuraCast installation you can check most logs through the `Administration` -> `System Logs`.
 
-In addition to the `IceCast`, `SHOUTcast` and `Liquidsoap` logs you can find the `AzuraCast Application Log` here which contains useful information about what the AzuraCast application itself is doing.
+In addition to the `Icecast`, `SHOUTcast` and `Liquidsoap` logs you can find the `AzuraCast Application Log` here which contains useful information about what the AzuraCast application itself is doing.
 
 ## Log Viewer
 
-The `Logs` link in your station sidebar menu gives you access to the Logs from your station's `IceCast`, `SHOUTcast` and `Liquidsoap` processes.
+The `Logs` link in your station sidebar menu gives you access to the Logs from your station's `Icecast`, `SHOUTcast` and `Liquidsoap` processes.
 
-In addition to the logs, you can also view the IceCast, SHOUTcast and Liquidsoap configuration scripts that AzuraCast automatically generates for you.
+In addition to the logs, you can also view the Icecast, SHOUTcast and Liquidsoap configuration scripts that AzuraCast automatically generates for you.
 
 ## Log Types
 
@@ -38,15 +38,15 @@ In this log you can find information on how the streams are generated, what info
 
 If you encounter any problems with your stream generation this look should contain useful information in diagnosing the issue.
 
-### IceCast Access Log
+### Icecast Access Log
 
-This log file contains the raw access log data of the IceCast server.
+This log file contains the raw access log data of the Icecast server.
 
 For most issues this log does not contain any useful information but can be used for analytical purposes.
 
-### IceCast Error Log
+### Icecast Error Log
 
-This log file contains the error output of the IceCast server.
+This log file contains the error output of the Icecast server.
 
 If you encounter any problems with accessing the streams or your mount points this is were should start looking into.
 

src/content/docs/docs/user-guide/mount-points.md

@@ -18,3 +18,13 @@ Each Station in AzuraCast represents one single broadcast (with one currently pl
 
 Note that not all formats are compatible with all platforms. For instance, iOS users won't be able to listen to the Ogg format as it is not supported by Safari on iOS at the moment.
  [Checking formats compatibility](https://caniuse.com/) can help you decide which one will be better for your station.
+
+## Advanced
+
+### Mount Point URL
+
+You can set a custom URL for streams that AzuraCast will use when referring to it in both the web UI and in [API responses](/docs/developers/now-playing-data/#standard-now-playing-api) (specifically, `station.listen_url` and `mounts.*.url`). Leaving the field empty uses the default value, generated in the format: `{HTTP/HTTPS}://{BASE_URL}.TLD/listen/{STATION_URL_STUB}/{MOUNT_POINT_URL}`.
+
+### Custom Frontend Configuration
+
+This is a good spot to define mount-specific settings such as an [intro file](/docs/administration/docker/#stream-intro-file) or [http headers](https://www.stream-meta.info/version_2_headers.html).

src/content/docs/docs/user-guide/promoting-your-station.md

@@ -105,3 +105,7 @@ To add custom headers to a station, open the `Broadcasting` sidebar menu, then c
   <header name="icy-geo-lat-long" value="12.345,-23.456" />
 </http-headers>
 ```
+
+:::caution[Power users only!]
+HTTP-headers must be added to each individual mount point. Adding them to the station-wide Custom Configuration (under `Profile` -> `Edit Profile` -> `Broadcasting`) will not work.
+:::

src/content/docs/docs/user-guide/streaming-software.md

@@ -16,7 +16,7 @@ If you are using a reverse proxy service (like CloudFlare) in front of your inst
 
 **Linux, MacOS, Windows; Free and Open-Source**
 
-[Mixxx](https://www.mixxx.org) is free and open-source DJ software that also supports live broadcasting via IceCast and ShoutCast servers.
+[Mixxx](https://www.mixxx.org) is free and open-source DJ software that also supports live broadcasting via Icecast and ShoutCast servers.
 
 Live broadcasting settings can be found in the preferences menu (`Options` -> `Preferences`). It is recommended to use "Icecast 2" mode when broadcasting to AzuraCast. Out of the box, Mixxx does not include the LAME MP3 encoder (for licensing reasons), but it is not needed when connecting to AzuraCast; just set your broadcast format to 'Ogg Vorbis' and LiquidSoap will transcode the broadcast into the correct output format.
 
@@ -26,13 +26,13 @@ Live broadcasting settings can be found in the preferences menu (`Options` -> `P
 
 **Linux, MacOS, Windows; Free and Open-Source**
 
-Cross-platform and available for free at [https://sourceforge.net/projects/butt/](https://sourceforge.net/projects/butt/). Streaming via both IceCast mode and ShoutCast mode are available.
+Cross-platform and available for free at [https://sourceforge.net/projects/butt/](https://sourceforge.net/projects/butt/). Streaming via both Icecast mode and ShoutCast mode are available.
 
-### IceCast Mode
+### Icecast Mode
 
 Use the exact information specified on the Streamer/DJ page's right sidebar. "Address" is "Server" and "Icecast mountpoint" is "Mount Name".
 
-![BUTT Sample IceCast configuration](../images/streaming-software/butt_icecast.png)
+![BUTT Sample Icecast configuration](../images/streaming-software/butt_icecast.png)
 
 ### ShoutCast Mode
 
@@ -44,7 +44,7 @@ Use the given port specified in the "ShoutCast v1 Clients" section. Since ShoutC
 
 **Windows; Proprietary, Commercial**
 
-[SAM Cast](https://spacial.com/sam-cast/) is commercial software sold by Spacial. It is compatible with AzuraCast by using the MP3 encoder and the "IceCast 2" server connection settings.
+[SAM Cast](https://spacial.com/sam-cast/) is commercial software sold by Spacial. It is compatible with AzuraCast by using the MP3 encoder and the "Icecast 2" server connection settings.
 
 ### Broadcasting Steps
 
@@ -66,9 +66,9 @@ On the first tab of the encoder details, change your bitrate from the default 64
 
 ![](../images/streaming-software/samcast_4.png)
 
-Click the "Server Details" tab. On the "Server Type" selector, choose "IceCast", then choose "IceCast 2" in the secondary selector.
+Click the "Server Details" tab. On the "Server Type" selector, choose "Icecast", then choose "Icecast 2" in the secondary selector.
 
-You can now populate the "Server Details" section with the connection information supplied to you via AzuraCast's "Streamers/DJs" page. You will want to use the connection information for "IceCast Clients", the first section on the page.
+You can now populate the "Server Details" section with the connection information supplied to you via AzuraCast's "Streamers/DJs" page. You will want to use the connection information for "Icecast Clients", the first section on the page.
 
 ![](../images/streaming-software/samcast_5.png)
 
@@ -84,7 +84,7 @@ Select the encoder, then click the play-button icon in the toolbar to begin broa
 
 [RadioBOSS](https://www.djsoft.net/) is a commercial software sold by IP Kuzmitski D.V. at DJSoft.net.
 
-Streaming via both IceCast mode and ShoutCast mode are available.
+Streaming via both Icecast mode and ShoutCast mode are available.
 
 The Live broadcasting feature is possible in their Standard and Advanced edition (not in the Express edition).
 
@@ -110,11 +110,11 @@ Follow the instructions for the server type you have set up your Azuracast stati
 
 - Select `Icecast 1 & 2` and click `Next >`
 
-![RadioBOSS Encoder Configuration Wizard IceCast](../images/streaming-software/radioboss_3.jpg)
+![RadioBOSS Encoder Configuration Wizard Icecast](../images/streaming-software/radioboss_3.jpg)
 
 - Take over the corresponding credentials you can find in Azuracast:
 
-![RadioBOSS Encoder Configuration Wizard IceCast Azuracast Example settings](../images/streaming-software/radioboss_4.jpg)
+![RadioBOSS Encoder Configuration Wizard Icecast Azuracast Example settings](../images/streaming-software/radioboss_4.jpg)
 
 - Click `Finish`
 
@@ -153,7 +153,7 @@ Note 2: Be sure to select `v1`, as v2 will append the Stream ID (SID), which won
 8. In the Settings window, check the checkboxes for all encoders that you want to use.
 Remember to turn on the option `Broadcasting enabled` on top.
 
-On succesful connection, the log report in the bottom-left corner of RadioBOSS will show the following message: "Connected to server! (Output N)". This means that listeners can now connect to the streaming server (either IceCast or ShoutCast).
+On succesful connection, the log report in the bottom-left corner of RadioBOSS will show the following message: "Connected to server! (Output N)". This means that listeners can now connect to the streaming server (either Icecast or ShoutCast).
 
 If the logs show "[E40] Cannot start broadcast" in red, go over the above steps.
 
@@ -170,15 +170,15 @@ The following articles in there are helpful:
 
 [PlayIt Live](https://www.playitsoftware.com/Products/Live) is a free live-assist and automated radio playout system from PlayIt Software.
 
-It allows streaming via **IceCast**, **SHOUTcast v1** and **SHOUTcast v2** via a plugin, that you can download for free [here](https://www.playitsoftware.com/Plugins/View/InternetBroadcast), after creating an account on their website. This plugin also allows you to record the stream, in MP3.
+It allows streaming via **Icecast**, **SHOUTcast v1** and **SHOUTcast v2** via a plugin, that you can download for free [here](https://www.playitsoftware.com/Plugins/View/InternetBroadcast), after creating an account on their website. This plugin also allows you to record the stream, in MP3.
 
 The installation steps for the plugin are relatively simple, so they're not covered in this guide.
 
 ***Note:** This software is only capable of streaming via MP3, due to plugin limitations.*
 
 ### Instructions
 
-These instructions are valid and required for both streaming modes (IceCast and SHOUTcast), so be sure to follow this part before proceeding any further.
+These instructions are valid and required for both streaming modes (Icecast and SHOUTcast), so be sure to follow this part before proceeding any further.
 
  **1.** After installing the Internet Broadcast plugin, select the menu **Plugins** menu, on the top menu bar and select the **Plugin Manager...** option.
 
@@ -203,15 +203,15 @@ These instructions are valid and required for both streaming modes (IceCast and
 
 **4.** Under **Streams**, click **Add** to add a new streaming server.
 
-Now follow the specific instructions for your streaming server: **IceCast** or **SHOUTcast**.
+Now follow the specific instructions for your streaming server: **Icecast** or **SHOUTcast**.
 
-### IceCast
+### Icecast
 
 **1.** Using the connection details, available in your AzuraCast instance, under the **Streamers/DJ Accounts** page,
 
 ![Connection Details](../images/streaming-software/playitlive_4.png)
 
-*Connection Information for IceCast*
+*Connection Information for Icecast*
 
 ... fill this form in the PlayIt Live software.