diff --git a/.github/ISSUE_TEMPLATE/dac_request.md b/.github/ISSUE_TEMPLATE/dac_request.md index 7d542e0a..1640531e 100644 --- a/.github/ISSUE_TEMPLATE/dac_request.md +++ b/.github/ISSUE_TEMPLATE/dac_request.md @@ -6,7 +6,7 @@ labels: DAC assignees: "" --- -**Note: please read the [DAC section](https://balena-labs-projects.github.io/balena-sound/audio-interfaces#dac-boards) on our official documentation site before proceeding.** +**Note: please read the [DAC section](https://balena-sound.pages.dev/audio-interfaces#dac-boards) on our official documentation site before proceeding.** **Do** open an issue if you: diff --git a/README.md b/README.md index ae556a10..2c1e92ec 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Running this app is as simple as deploying it to a balenaCloud fleet. You can do it in just one click by using the button below: -[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-labs-projects/balena-sound&defaultDeviceType=raspberry-pi) +[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-io-experimental/balena-sound&defaultDeviceType=raspberry-pi) ## Documentation @@ -30,4 +30,4 @@ This project is in active development so if you have any feature requests or iss ## Getting Help -If you're having any problem, please [raise an issue](https://github.com/balena-labs-projects/balena-sound/issues/new) on GitHub and we will be happy to help. +If you're having any problem, please [raise an issue](https://github.com/balena-io-experimental/balena-sound/issues/new) on GitHub and we will be happy to help. diff --git a/balena.yml b/balena.yml index 0b2ffd11..09ba5f7b 100644 --- a/balena.yml +++ b/balena.yml @@ -10,12 +10,12 @@ assets: repository: type: blob.asset data: - url: 'https://github.com/balena-labs-projects/balena-sound' + url: 'https://github.com/balena-io-experimental/balena-sound' logo: type: blob.asset data: url: >- - https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/logo.png + https://raw.githubusercontent.com/balena-io-experimental/balena-sound/master/logo.png data: applicationEnvironmentVariables: - SOUND_VOLUME: 75 diff --git a/core/audio/balena-sound.pa b/core/audio/balena-sound.pa index 6415bc61..f5713823 100644 --- a/core/audio/balena-sound.pa +++ b/core/audio/balena-sound.pa @@ -1,4 +1,4 @@ -# See https://github.com/balena-labs-projects/balena-sound/blob/master/docs/ARCHITECTURE.md for details +# See https://github.com/balena-io-experimental/balena-sound/blob/master/docs/ARCHITECTURE.md for details # Create balena-sound sinks load-module module-null-sink sink_name=balena-sound.input diff --git a/core/multiroom/client/start.sh b/core/multiroom/client/start.sh index 9c6ec31e..20765623 100644 --- a/core/multiroom/client/start.sh +++ b/core/multiroom/client/start.sh @@ -20,7 +20,7 @@ echo "Starting multi-room client..." echo "- balenaSound mode: $MODE" echo "- Target snapcast server: $SNAPSERVER" -# Set the snapcast device name for https://github.com/balena-labs-projects/balena-sound/issues/332 +# Set the snapcast device name for https://github.com/balena-io-experimental/balena-sound/issues/332 if [[ -z $SOUND_DEVICE_NAME ]]; then SNAPCAST_CLIENT_ID=$BALENA_DEVICE_UUID else diff --git a/core/sound-supervisor/src/ui/index.html b/core/sound-supervisor/src/ui/index.html index 737c5c6f..e6446267 100644 --- a/core/sound-supervisor/src/ui/index.html +++ b/core/sound-supervisor/src/ui/index.html @@ -32,7 +32,7 @@
  • @@ -107,7 +107,7 @@

    (Requires internet) Set a custom dtoverlay. See our docs diff --git a/docker-compose.yml b/docker-compose.yml index b4329289..337632c5 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -37,7 +37,7 @@ services: restart: on-failure # Plugins - # -- Additional plugins can be added. See https://balena-labs-projects.github.io/balena-sound/plugins. + # -- Additional plugins can be added. See https://balena-sound.pages.dev/plugins # -- Remove unwanted plugins as needed bluetooth: build: ./plugins/bluetooth diff --git a/docs/01-getting-started.md b/docs/01-getting-started.md index e13c5d9e..55d38045 100644 --- a/docs/01-getting-started.md +++ b/docs/01-getting-started.md @@ -1,11 +1,6 @@ ----- -slug: / ----- - -# Getting started - -# ![logo](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/balenaSound-logo.png) +# Getting Started +![logo](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/balenaSound-logo.png) Getting started with balenaSound is as simple as deploying it to a [balenaCloud](https://balena.io/cloud) fleet; no additional configuration is required (unless you're using a DAC HAT). We've outlined the installation steps below. If you want a step-by-step tutorial on how to get balenaSound up and running, feel free to check these blog posts: @@ -37,7 +32,7 @@ One-click deploy is the easiest way to get started with balenaSound as it allows Click this button to go straight to balenaCloud fleet creation, where balenaSound app will be pre-loaded: -[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-labs-projects/balena-sound&defaultDeviceType=raspberry-pi) +[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-io-experimental/balena-sound&defaultDeviceType=raspberry-pi) ### Provision your device @@ -95,4 +90,4 @@ If you are running into issues getting your balenaSound app running, please try 1. Check the [support and troubleshooting guide](support) for common issues and how to resolve them. 2. Post in the [balenaSound forum](https://forums.balena.io/c/balenalabs/balenasound/85) for help from our growing community. -3. Create an issue on the [balenaSound GitHub project](https://github.com/balena-labs-projects/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound. +3. Create an issue on the [balenaSound GitHub project](https://github.com/balena-io-experimental/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound. diff --git a/docs/04-plugins.md b/docs/04-plugins.md index fdc8f081..52c839e3 100644 --- a/docs/04-plugins.md +++ b/docs/04-plugins.md @@ -30,8 +30,8 @@ Manual authentication will let you stream audio over the internet from a client The following plugins are available to be added to your balenaSound installation: - UPnP: Universal Plug and Play -- (Work in progress) Tidal Connect: See [PR #399](https://github.com/balena-labs-projects/balena-sound/pull/399) -- (Work in progress) Roon Bridge: See [PR #388](https://github.com/balena-labs-projects/balena-sound/pull/388) +- (Work in progress) Tidal Connect: See [PR #399](https://github.com/balena-io-experimental/balena-sound/pull/399) +- (Work in progress) Roon Bridge: See [PR #388](https://github.com/balena-io-experimental/balena-sound/pull/388) Installing these plugins is a more involved process than just deploying the off the shelf version of balenaSound. You'll need to edit the contents of the `docker-compose.yml` file before deploying the app. This means that you won't be able to deploy using the "Deploy with balena" button; you either need to use the [CLI to deploy](https://balena-labs-projects.github.io/balena-sound/getting-started#cli-deploy) or use "Deploy with balena" with your own forked version of the project. If you don't feel comfortable performing these steps or need some help along the way hit us up at our [forums](https://forums.balena.io) and we'll gladly help you out. diff --git a/docs/05-audio-interfaces.md b/docs/05-audio-interfaces.md index 71c29563..0c1bc555 100644 --- a/docs/05-audio-interfaces.md +++ b/docs/05-audio-interfaces.md @@ -2,9 +2,9 @@ If you want to upgrade the sound quality of your balenaSound devices, or if your board has no onboard soundcard, you'll probably want to add an external soundcard. Generally these come in two flavors: **USB soundcards** or **DAC boards**. Both alternatives are widely supported in balenaSound. -Checkout the [customization](customization#general) section to learn how to select which audio interface to use. For a detailed and up to date list of what interfaces are supported on each device check out the audio block [documentation](https://github.com/balenablocks/audio#supported-devices) section. +Checkout the [customization](https://balena-sound.pages.dev/customization) section to learn how to select which audio interface to use. For a detailed and up to date list of what interfaces are supported on each device check out the audio block [documentation](https://github.com/balenablocks/audio#supported-devices) section. -As a general rule of thumb, onboard and USB soundcards should work out of the box without any configuration, and DACs usually require setting a `dtoverlay`. Read on to learn more about the alternatives. If for any reason you can't get your soundcard to work, feel free to [contact us](./support#contact-us) and we'll gladly help out. +As a general rule of thumb, onboard and USB soundcards should work out of the box without any configuration, and DACs usually require setting a `dtoverlay`. Read on to learn more about the alternatives. If for any reason you can't get your soundcard to work, feel free to [contact us](https://balena-sound.pages.dev/support#contact-us) and we'll gladly help out. ## Onboard @@ -25,9 +25,9 @@ balenaSound supports a wide variety of DACs, but in an ever-growing market, chan Latest versions of balenaOS already ships with drivers for most, if not all, of the DACs available. The testing story, however, is different. It's not possible for us to test all of them individually as it would take an incredible amount of resources. For this reason, we rely on community contributions to help catalogue existing DACs into three categories: -- [Supported DACs](#Supported-DACs): battle-tested, known to work with balenaSound. -- [Untested DACs](#Untested-DACs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one). -- [Unsupported DACs](#Unsupported-DACs): DACs that probably need additional drivers that aren't currently available in balenaOS. +- [Supported DACs](https://balena-sound.pages.dev/audio-interfaces#Supported-DACs): battle-tested, known to work with balenaSound. +- [Untested DACs](https://balena-sound.pages.dev/audio-interfaces#Untested-DACs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one). +- [Unsupported DACs](https://balena-sound.pages.dev/audio-interfaces#Unsupported-DACs): DACs that probably need additional drivers that aren't currently available in balenaOS. A curated list for all three categories can be found in the sections below. If you don't find your DAC anywhere, please add a comment to [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue and we'll take a look for you. @@ -94,7 +94,7 @@ These are the DACs that are known to work with balenaSound. If you have trouble [6]: https://www.hifiberry.com/products/dacplus/ [7]: https://forums.balena.io/t/no-sound-from-dac/61343/5 [8]: http://www.inno-maker.com/product/hifi-dac-hat/ -[9]: https://github.com/balena-labs-projects/balena-sound/pull/98 +[9]: https://github.com/balena-io-experimental/balena-sound/pull/98 [10]: https://allo.com/sparky/miniboss-rpi-zero.html [11]: http://www.kumantech.com/kuman-sc07-raspberry-pi-hifi-digi-digital-sound-card-i2s-spdif-optical-fiber-for-raspberry-pi-3-2-model-b-b-sc07_p0041.html [12]: https://shop.pimoroni.com/collections/pirate-audio @@ -121,18 +121,18 @@ These are the DACs that are known to work with balenaSound. If you have trouble [33]: https://shop.pimoroni.com/products/pi-digi?variant=33370425994 [34]: https://www.raspberrypi.org/products/iqaudio-digiamp-plus/ [35]: https://www.inno-maker.com/product/hifi-amp-hat/ -[36]: https://github.com/balena-labs-projects/balena-sound/issues/385 +[36]: https://github.com/balena-io-experimental/balena-sound/issues/385 [37]: https://raspiaudio.com/produit/audio -[38]: https://github.com/balena-labs-projects/balena-sound/issues/355 +[38]: https://github.com/balena-io-experimental/balena-sound/issues/355 [39]: https://www.audiophonics.fr/fr/dac-et-interfaces-pour-raspberry-pi/audiophonics-i-sabre-dac-es9023-tcxo-raspberry-pi-a-b-20-i2s-p-9978.html -[40]: https://github.com/balena-labs-projects/balena-sound/issues/345 +[40]: https://github.com/balena-io-experimental/balena-sound/issues/345 ### Untested DACs -An up to date list of untested DACs can be found in [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue. If you have one of these DACs and want to help us test it, please post on our [forums](https://forums.balena.io/) and we'll get back to you with instructions. Hopefully, with your assistance, new DACs can be graduated into the supported category! +An up to date list of untested DACs can be found in [this](https://github.com/balena-io-experimental/balena-sound/issues/439) GitHub issue. If you have one of these DACs and want to help us test it, please post on our [forums](https://forums.balena.io/) and we'll get back to you with instructions. Hopefully, with your assistance, new DACs can be graduated into the supported category! **Note:** Please **do not** create new GitHub issues for untested DACs unless you've been instructed to do so by our forums support agents. ### Unsupported DACs -An up to date list of unsupported DACs can be found in [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue. Unsupported DACs can be made to work with balenaSound but often will require further investigation and patching balenaOS, so they are best avoided. Please **do** create a new GitHub issue if you are working on adding support or testing an unsupported DAC as that will facilitate discussion with balenaSound developers. +An up to date list of unsupported DACs can be found in [this](https://github.com/balena-io-experimental/balena-sound/issues/439) GitHub issue. Unsupported DACs can be made to work with balenaSound but often will require further investigation and patching balenaOS, so they are best avoided. Please **do** create a new GitHub issue if you are working on adding support or testing an unsupported DAC as that will facilitate discussion with balenaSound developers. diff --git a/docs/06-device-support.md b/docs/06-device-support.md index 0368d5c3..c15d8764 100644 --- a/docs/06-device-support.md +++ b/docs/06-device-support.md @@ -17,9 +17,9 @@ balenaSound has been developed and tested to work on the following devices: [1]: We recommend using a DAC or USB sound card for these device types. See [audio interfaces](audio-interfaces) for more details. -[2]: Multi-room `master` functionality is disabled on Raspberry Pi 1 and 2 family devices due to performance constraints. They can however function in multi-room client mode in conjunction with another device that supports multi-room mode. Read more about modes of operation [here](usage#modes-of-operation). +[2]: Multi-room `master` functionality is disabled on Raspberry Pi 1 and 2 family devices due to performance constraints. They can however function in multi-room client mode in conjunction with another device that supports multi-room mode. Read more about modes of operation [here](https://balena-sound.pages.dev/usage#modes-of-operation). -[3]: There is a known issue where on the 64 bit version of balenaOS no output is coming through the audio jack/hdmi. See troubleshooting section [here](https://balena-labs-projects.github.io/balena-sound/usage#modes-of-operation/support#troubleshooting) (Scroll down to `No audio when using balenaOS 64 bit on Raspberry Pi 3's`) +[3]: There is a known issue where on the 64 bit version of balenaOS no output is coming through the audio jack/hdmi. See troubleshooting section [here](https://balena-sound.pages.dev/support#troubleshooting) (Scroll down to `No audio when using balenaOS 64 bit on Raspberry Pi 3's`) [4]: There is a [known issue](https://github.com/raspberrypi/linux/issues/1444) with all variants of the Raspberry Pi 3 where Bluetooth and WiFi interfere with each other. This will only impact the performance of balenaSound if you use a **Pi 3 as the master server to do multi-room bluetooth streaming**, resulting in stuttering audio (Airplay and Spotify Connect will work fine, as well as all streaming methods with multi-room disabled). In this cases we recommend the use of a Raspberry Pi 4 as the `master` server or a Pi 3 with a bluetooth dongle. diff --git a/docs/07-support.md b/docs/07-support.md index 30db1a74..5bf75043 100644 --- a/docs/07-support.md +++ b/docs/07-support.md @@ -73,7 +73,7 @@ Using multi-room has proven to make this issue a lot more frequent and noticeabl Bad quality power supply units are more likely to trigger this problem. Investing in a good power supply unit is always a good idea! We recommend using the [original Raspberry Pi power supply](https://www.raspberrypi.org/products/raspberry-pi-universal-power-supply/) and if not possible at least one that conforms to the power requirements described in [here](https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md). -Thank you [@MatthewCroughan](https://github.com/MatthewCroughan) for the thorough [investigation and testing](https://github.com/balena-labs-projects/balena-sound/issues/62#issuecomment-605265537)! +Thank you [@MatthewCroughan](https://github.com/MatthewCroughan) for the thorough [investigation and testing](https://github.com/balena-io-experimental/balena-sound/issues/62#issuecomment-605265537)! ##### Rolling back to balenaOS 2.38 / Reduce Bluetooth UART baud rate @@ -116,7 +116,7 @@ If your device is properly configured and still can't get multi-room to work try #### Description -HDMI audio output is currently not working as intended on Raspberry Pi 4. See this [issue](https://github.com/balena-labs-projects/balena-sound/issues/79) for details. +HDMI audio output is currently not working as intended on Raspberry Pi 4. See this [issue](https://github.com/balena-io-experimental/balena-sound/issues/79) for details. #### Workaround @@ -130,7 +130,7 @@ No audio coming out from either the audio jack or HDMI when using balenaOS 64 bi For details see: -- https://github.com/balena-labs-projects/balena-sound/issues/82 +- https://github.com/balena-io-experimental/balena-sound/issues/82 - https://github.com/balena-io/balena-supervisor/issues/1245 #### Workaround diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 3db03ced..b94213de 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -4,7 +4,7 @@ Community contributions have been a staple of this open source project since its ## Overview -![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-overview.png) +![](https://raw.githubusercontent.com/balena-io-experimental/balena-sound/master/docs/images/arch-overview.png) balenaSound services can be divided in three groups: @@ -67,13 +67,13 @@ Creation and configuration scripts for these virtual sinks are located at `core/ ### Standalone -![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-standalone.png) +![](https://raw.githubusercontent.com/balena-io-experimental/balena-sound/master/docs/images/arch-standalone.png) Standalone mode is easy to understand. You just pipe ` balena-sound.input` to `balena-sound.output` and that's it. Audio coming in from any plugin will find it's way to the selected output. If this was the only mode, we could simplify the setup and use a single sink. Having the two layers however is important for the multiroom mode which is more complicated. ### Multiroom -![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-multiroom.png) +![](https://raw.githubusercontent.com/balena-io-experimental/balena-sound/master/docs/images/arch-multiroom.png) Multiroom feature relies on `snapcast` to broadcast the audio to multiple devices. Snapcast has two binaries working alongside: server and client. diff --git a/plugins/airplay/Dockerfile.template b/plugins/airplay/Dockerfile.template index 68edadd5..acce7ea5 100644 --- a/plugins/airplay/Dockerfile.template +++ b/plugins/airplay/Dockerfile.template @@ -9,7 +9,7 @@ SHELL ["/bin/sh", "-eo", "pipefail", "-c"] # shairport-sync docker image doesn't include pulseaudio support so we use ALSA bridge ENV PULSE_SERVER=tcp:localhost:4317 RUN apk add --no-cache supervisor curl~=7 && \ - curl -skL https://raw.githubusercontent.com/balena-labs-projects/audio/master/scripts/alsa-bridge/alpine-setup.sh | sh \ + curl -skL https://raw.githubusercontent.com/balena-io-experimental/audio/master/scripts/alsa-bridge/alpine-setup.sh | sh \ && apk del curl COPY start.sh /usr/src/