diff --git a/roles/azuracast/README.rst b/roles/azuracast/README.rst index fca21ce96..da7d1abab 100644 --- a/roles/azuracast/README.rst +++ b/roles/azuracast/README.rst @@ -2,18 +2,37 @@ AzuraCast README ================ -This playbook adds `AzuraCast `_ to Internet-in-a-Box (IIAB) for network radio station functionality. With 'AzuraCast' you and your community can schedule podcasts, music, and even do live streaming of audio content. A variety of streaming formats are supported. +This playbook adds `AzuraCast `_ to Internet-in-a-Box (IIAB) for "radio station" functionality. You and your community can schedule podcasts, music, and even do live streaming of audio content. A variety of streaming formats are supported. -Please see AzuraCast's `screenshots `_. +As soon as you install AzuraCast with IIAB, it can stream MP3 files (and similar) for you, using `LiquidSoap `_ to help you schedule or randomize playback of MP3 songs (and similar). -As of 2019-08-04, this will only run on Ubuntu 18.04, and tentatively on Debian 10 "Buster" (`#1766 `_). Support for Raspberry Pi remains a goal for now — please if you can, consider helping us solve this critical challenge (`#1772 `_, `AzuraCast/AzuraCast#332 `_). +Please see AzuraCast's `screenshots `_ and `docs <./README.rst#Requirements>`_. + +Optionally, live-streaming can also be made to work, e.g. if you install `Mixxx or BUTT `_ on your own. If so, you have many options to configure streaming with `Icecast `_, `Shoutcast `_, etc. + +Requirements +------------ + +AzuraCast recommends `2-to-4 GB RAM minimum `_. + +As of 2022-08-31, AzuraCast should run on Ubuntu 22.04 and 64-bit Raspberry Pi OS: `#1772 `_, `AzuraCast/AzuraCast#332 `_, `PR #2946 `_ + +Other Linux distributions may also work, at your own risk, especially if Docker runs smoothly. Using It -------- -* Do a normal IIAB install (https://download.iiab.io), making sure to set both variables ``azuracast_install`` and ``azuracast_enabled`` to ``True`` when it prompts you to edit `/etc/iiab/local_vars.yml `_, as you begin the installation. -* When the IIAB software install completes, it will ask you to reboot, and AzuraCast's console will then be available at http://box.lan:10080 +* Do a normal IIAB install (https://download.iiab.io), making sure to set both variables ``azuracast_install`` and ``azuracast_enabled`` to ``True`` when IIAB's installer prompts you to edit `/etc/iiab/local_vars.yml `_ +* When the IIAB software install completes, it will ask you to reboot, and AzuraCast's console will then be available at http://box.lan:12080 * This console site will prompt you to complete AzuraCast's initial setup: user accounts, managing stations, radio streams, etc. * Finally, check out some `how-to videos `_ to learn to manage your own radio station! -Note: When creating a station using AzuraCast's console, its default streaming ports for ``station`` and ``autodj`` need to be in the `port range 10000-10100 `_. +Note: When creating a station using AzuraCast's console, its default streaming ports for ``station`` and ``autodj`` need to be in the `port range 12000-12100 `_ (port 12443 may also be required!) + +AzuraCast Docs +-------------- + +- https://docs.azuracast.com +- https://docs.azuracast.com/en/getting-started/installation/post-installation-steps +- https://docs.azuracast.com/en/getting-started/updates +- https://docs.azuracast.com/en/user-guide/streaming-software