Installation 2.0

documentation/builders/audio.md

@@ -13,6 +13,24 @@ Audio outputs run via PulseAudio and the basic configuration should be easy.
 There is a [configuration tool](../developers/coreapps.md#Audio),
 to setup the configuration for the Jukebox Core App.
 
+### Disable On-Chip audio
+
+If you are planning on using an external sound card (e.g. USB, HifiBerry, PirateAudio, etc), we recommend to disable the on-chip audio. It will make the sound configuration easier.
+If you are planning to only use Bluetooth speakers, leave the on-chip audio enabled!
+
+Run the following command to manage the On-chip audio. Make sure you reboot your device afterwards.
+
+```bash
+cd ~/RPi-Jukebox-RFID/installation/options
+./onboard_sound.sh disable
+```
+
+If you like to enable it, use the following command:
+
+```bash
+./onboard_sound.sh enable
+```
+
 ### To set up the audio
 
 1. Follow the setup steps according to your sound card

installation/includes/00_constants.sh

@@ -5,6 +5,7 @@ SYSTEMD_USR_PATH="/usr/lib/systemd/user"
 VIRTUAL_ENV="${INSTALLATION_PATH}/.venv"
 # Do not change this directory! It must match MPDs expectation where to find the user configuration
 MPD_CONF_PATH="${HOME}/.config/mpd/mpd.conf"
+WEBAPP_NGINX_SITE_DEFAULT_CONF="/etc/nginx/sites-available/default"
 
 # The default upstream user, release branch, and develop branch
 # These are used to prepare the repo for developers

installation/includes/01_default_config.sh

@@ -2,25 +2,19 @@
 
 BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE=${BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE:-"false"}
 ENABLE_STATIC_IP=true
-DISABLE_IPv6=true
 ENABLE_AUTOHOTSPOT=false
 AUTOHOTSPOT_PROFILE="Phoniebox_Hotspot"
 AUTOHOTSPOT_SSID="$AUTOHOTSPOT_PROFILE"
 AUTOHOTSPOT_PASSWORD="PlayItLoud!"
 AUTOHOTSPOT_IP="10.0.0.1"
 AUTOHOTSPOT_COUNTRYCODE="DE"
-DISABLE_BLUETOOTH=true
-DISABLE_SSH_QOS=true
-DISABLE_BOOT_SCREEN=true
-DISABLE_BOOT_LOGS_PRINT=true
 SETUP_MPD=true
 ENABLE_MPD_OVERWRITE_INSTALL=true
 UPDATE_RASPI_OS=${UPDATE_RASPI_OS:-"true"}
 ENABLE_RFID_READER=true
 ENABLE_SAMBA=true
 ENABLE_WEBAPP=true
 ENABLE_KIOSK_MODE=false
-DISABLE_ONBOARD_AUDIO=false
 # Always try to use GIT with SSH first, and on failure drop down to HTTPS
 GIT_USE_SSH=${GIT_USE_SSH:-"true"}
 

installation/includes/02_helpers.sh

@@ -192,6 +192,46 @@ config_file_revert() {
     fi
 }
 
+_add_options_to_cmdline() {
+    local options="$1"
+
+    local cmdlineFile=$(get_boot_cmdline_path)
+    if [ ! -s "${cmdlineFile}" ];then
+        sudo tee "${cmdlineFile}" <<-EOF
+${options}
+EOF
+    else
+        for option in $options
+        do
+            if ! grep -qiw "$option" "${cmdlineFile}" ; then
+                sudo sed -i "s/$/ $option/" "${cmdlineFile}"
+            fi
+        done
+    fi
+}
+
+_remove_options_from_cmdline() {
+    local options="$1"
+
+    local cmdlineFile=$(get_boot_cmdline_path)
+
+    if [ -s "${cmdlineFile}" ]; then
+        for option in $options; do
+            sudo sed -i "/$option/d" "${cmdlineFile}"
+        done
+    fi
+}
+
+is_package_installed() {
+  local package_name=$1
+
+  if apt list --installed 2>/dev/null | grep -q "$package_name"; then
+    echo "true"
+  else
+    echo "false"
+  fi
+}
+
 ### Verify helpers
 print_verify_installation() {
     log "\n

installation/options/bluetooth.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+source ../includes/02_helpers.sh
+
+if [ -z "$1" ] || { [ "$1" != "enable" ] && [ "$1" != "disable" ]; }; then
+    print_lc "Error: Invalid or no argument provided.
+Usage: ./bluetooth.sh <arg>
+       where <arg> can be 'enable' or 'disable'"
+    exit 1
+fi
+
+arg="$1"
+
+if [ "$arg" = "enable" ]; then
+    print_lc "Enabling Bluetooth..."
+    sudo systemctl enable hciuart.service
+    sudo systemctl enable bluetooth.service
+elif [ "$arg" = "disable" ]; then
+    print_lc "Disabling Bluetooth..."
+    sudo systemctl disable hciuart.service
+    sudo systemctl disable bluetooth.service
+fi
+
+# Test
+if [ "$arg" = "enable" ]; then
+    verify_optional_service_enablement hciuart.service enabled
+    verify_optional_service_enablement bluetooth.service enabled
+elif [ "$arg" = "disable" ]; then
+    verify_optional_service_enablement hciuart.service disabled
+    verify_optional_service_enablement bluetooth.service disabled
+fi

installation/options/boot_logs.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+source ../includes/02_helpers.sh
+
+if [ -z "$1" ] || { [ "$1" != "enable" ] && [ "$1" != "disable" ]; }; then
+    print_lc "Error: Invalid or no argument provided.
+Usage: ./boot_logs.sh <arg>
+       where <arg> can be 'enable' or 'disable'"
+    exit 1
+fi
+
+arg="$1"
+boot_cmdline_options="consoleblank=1 logo.nologo quiet loglevel=0 plymouth.enable=0 vt.global_cursor_default=0 plymouth.ignore-serial-consoles splash fastboot noatime nodiratime noram"
+
+if [ "$arg" = "enable" ]; then
+    print_lc "Enable Boot logs..."
+    _remove_options_to_cmdline "${boot_cmdline_options}"
+
+elif [ "$arg" = "disable" ]; then
+    print_lc "Disable Boot logs..."
+    _add_options_to_cmdline "${boot_cmdline_options}"
+fi
+
+# Test
+if [ "$arg" = "enable" ]; then
+    for option in $boot_cmdline_options
+    do
+        verify_file_does_not_contain_string $option "${boot_cmdline_path}"
+    done
+elif [ "$arg" = "disable" ]; then
+    for option in $boot_cmdline_options
+    do
+        verify_file_contains_string_once $option "${boot_cmdline_path}"
+    done
+fi

installation/options/boot_screen.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+source ../includes/02_helpers.sh
+
+if [ -z "$1" ] || { [ "$1" != "enable" ] && [ "$1" != "disable" ]; }; then
+    print_lc "Error: Invalid or no argument provided.
+Usage: ./boot_screen.sh <arg>
+       where <arg> can be 'enable' or 'disable'"
+    exit 1
+fi
+
+arg="$1"
+boot_config_path=$(get_boot_config_path)
+
+_enable_boot_screen() {
+    sudo sed -i 's/^disable_splash=1/disable_splash=0/' "$boot_config_path"
+    if ! grep -q "^disable_splash" "$boot_config_path"; then
+        echo "disable_splash=0" | sudo tee -a "$boot_config_path"
+    fi
+}
+
+_disable_boot_screen() {
+    sudo sed -i 's/^disable_splash=0/disable_splash=1/' "$boot_config_path"
+    if ! grep -q "^disable_splash" "$boot_config_path"; then
+        echo "disable_splash=1" | sudo tee -a "$boot_config_path"
+    fi
+}
+
+# Logic
+if [ "$arg" = "enable" ]; then
+    print_lc "Enabling RPi rainbow screen..."
+    _enable_boot_screen
+elif [ "$arg" = "disable" ]; then
+    print_lc "Disabling RPi rainbow screen..."
+    _disable_boot_screen
+fi
+
+# Tests
+if [ "$arg" = "enable" ]; then
+    verify_file_does_not_contain_string "disable_splash=" "${boot_config_path}"
+elif [ "$arg" = "disable" ]; then
+    verify_file_contains_string_once "disable_splash=1" "${boot_config_path}"
+fi

installation/options/ipv6.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+source ../includes/00_constants.sh
+source ../includes/02_helpers.sh
+
+if [ -z "$1" ] || { [ "$1" != "enable" ] && [ "$1" != "disable" ]; }; then
+    print_lc "Error: Invalid or no argument provided.
+Usage: ./ipv6.sh <arg>
+       where <arg> can be 'enable' or 'disable'"
+    exit 1
+fi
+
+arg="$1"
+cmdlineFile=$(get_boot_cmdline_path)
+OPTIONS_IPV6="ipv6.disable=1"
+nginx_is_installed=$(is_package_installed nginx)
+
+if [ "$arg" = "enable" ]; then
+    print_lc "Enabling IPv6..."
+    _remove_options_to_cmdline "${OPTIONS_IPV6}"
+
+    if [ "$nginx_is_installed" = "true" ]; then
+        if ! grep -q 'listen \[::\]:80' "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"; then
+            echo 'listen [::]:80' | sudo tee -a "${WEBAPP_NGINX_SITE_DEFAULT_CONF}" > /dev/null
+        fi
+    fi
+
+elif [ "$arg" = "disable" ]; then
+    print_lc "Disabling IPv6..."
+    _add_options_to_cmdline "${OPTIONS_IPV6}"
+
+    if [ "$nginx_is_installed" = "true" ]; then
+        sudo sed -i '/listen \[::\]:80/d' "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
+    fi
+fi
+
+# Test
+if [ "$arg" = "enable" ]; then
+    verify_file_does_not_contain_string "${OPTIONS_IPV6}" "${cmdlineFile}"
+    if [ "$nginx_is_installed" = "true" ]; then
+        verify_file_contains_string "listen [::]:80" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
+    fi
+elif [ "$arg" = "disable" ]; then
+    verify_file_contains_string_once "${OPTIONS_IPV6}" "${cmdlineFile}"
+    if [ "$nginx_is_installed" = "true" ]; then
+        verify_file_does_not_contain_string "listen [::]:80" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
+    fi
+fi

installation/options/onboard_sound.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 source ../includes/02_helpers.sh
+
 script_name=$(basename "$0")
 boot_config_path=$(get_boot_config_path)
 

installation/options/ssh_qos.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# The latest version of SSH installed on the Raspberry Pi 3 uses QoS headers,
+# which disagrees with some routers and other hardware. This causes immense
+# delays when remotely accessing the RPi over ssh.
+
+source ../includes/02_helpers.sh
+
+if [ -z "$1" ] || { [ "$1" != "enable" ] && [ "$1" != "disable" ]; }; then
+    print_lc "Error: Invalid or no argument provided.
+Usage: ./ssh_qos.sh <arg>
+       where <arg> can be 'enable' or 'disable'"
+    exit 1
+fi
+
+arg="$1"
+
+if [ "$arg" = "enable" ]; then
+    print_lc "Enabling SSH QoS..."
+    sudo sed -i '/^IPQoS 0x00 0x00/d' /etc/ssh/sshd_config
+    sudo sed -i '/^IPQoS 0x00 0x00/d' /etc/ssh/ssh_config
+elif [ "$arg" = "disable" ]; then
+    print_lc "Disabling  SSH QoS..."
+    echo -e "IPQoS 0x00 0x00\n" | sudo tee -a /etc/ssh/sshd_config
+    echo -e "IPQoS 0x00 0x00\n" | sudo tee -a /etc/ssh/ssh_config
+fi
+
+# Test
+if [ "$arg" = "enable" ]; then
+    verify_file_does_not_contain_string "IPQoS 0x00 0x00" "/etc/ssh/sshd_config"
+    verify_file_does_not_contain_string "IPQoS 0x00 0x00" "/etc/ssh/ssh_config"
+elif [ "$arg" = "disable" ]; then
+    verify_file_contains_string_once "IPQoS 0x00 0x00" "/etc/ssh/sshd_config"
+    verify_file_contains_string_once "IPQoS 0x00 0x00" "/etc/ssh/ssh_config"
+fi