- -
-- Local copy of documentation for {{ project }} Version {{ release }}. - View online documentation - -
- -{% endif %} -{% endblock %} diff --git a/docs/sphinx/api/api.rst b/docs/sphinx/api/api.rst deleted file mode 100644 index 117fe92f6..000000000 --- a/docs/sphinx/api/api.rst +++ /dev/null @@ -1,20 +0,0 @@ ----------------------- -Developers API ----------------------- - -Developers API Introduction - -.. toctree:: - :maxdepth: 2 - :caption: The Python packages: - - plugs - publishing - rpc_server - cfghandler - playlist - utils - volume - controls - callingback - gpioz/gpioz diff --git a/docs/sphinx/api/callingback.rst b/docs/sphinx/api/callingback.rst deleted file mode 100644 index f913b41fd..000000000 --- a/docs/sphinx/api/callingback.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -Generic Callback Handler -------------------------------- - -.. automodule:: jukebox.callingback - :members: diff --git a/docs/sphinx/api/cfghandler.rst b/docs/sphinx/api/cfghandler.rst deleted file mode 100644 index cfdcd078d..000000000 --- a/docs/sphinx/api/cfghandler.rst +++ /dev/null @@ -1,5 +0,0 @@ -Config Handler -***************** - -.. automodule:: jukebox.cfghandler - :members: diff --git a/docs/sphinx/api/controls.rst b/docs/sphinx/api/controls.rst deleted file mode 100644 index 1ad0a2956..000000000 --- a/docs/sphinx/api/controls.rst +++ /dev/null @@ -1,19 +0,0 @@ - -Controls based on EvDev input devices -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -Common -************************* - -.. automodule:: components.controls.common.evdev_listener - :members: - :private-members: _filter_by_device_name, _filter_by_mandatory_keys - -Bluetooth audio buttons -************************* - -See also the corresponding user guide :ref:`userguide/bluetooth_audio_buttons:Bluetooth audio buttons` - -.. automodule:: components.controls.bluetooth_audio_buttons - :members: diff --git a/docs/sphinx/api/gpioz/connector.rst b/docs/sphinx/api/gpioz/connector.rst deleted file mode 100644 index eb547de55..000000000 --- a/docs/sphinx/api/gpioz/connector.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -GPIOZ Connector Functions -------------------------------- - -.. automodule:: components.gpio.gpioz.plugin.connectivity - -.. currentmodule:: components.gpio.gpioz.plugin.connectivity - -Common -^^^^^^^^ - -.. autoattribute:: components.gpio.gpioz.plugin.connectivity.BUZZ_TONE - -RFID -^^^^^ - -.. autofunction:: register_rfid_callback - - -Volume -^^^^^^^^ - -.. autofunction:: register_volume_led_callback - -.. autofunction:: register_volume_rgbled_callback - -.. autofunction:: register_volume_buzzer_callback - -Audio output sink -^^^^^^^^^^^^^^^^^^ - -.. autofunction:: register_audio_sink_change_callback - -Status -^^^^^^^^ -.. autofunction:: register_status_led_callback - -.. autofunction:: register_status_buzzer_callback - -.. autofunction:: register_status_tonalbuzzer_callback - - diff --git a/docs/sphinx/api/gpioz/converter.rst b/docs/sphinx/api/gpioz/converter.rst deleted file mode 100644 index d65e4b595..000000000 --- a/docs/sphinx/api/gpioz/converter.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -GPIOZ Converters -------------------------------- - -.. automodule:: components.gpio.gpioz.core.converter - :members: - :special-members: +__call__ - - - diff --git a/docs/sphinx/api/gpioz/gpioz.rst b/docs/sphinx/api/gpioz/gpioz.rst deleted file mode 100644 index 024fd90ee..000000000 --- a/docs/sphinx/api/gpioz/gpioz.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - ----------------------- -GPIOZ ----------------------- - -The GPIOZ plugin connects to GPIO devices such as Buttons, LEDs, Buzzers. It utilizes GPIOZero to do so. - -.. toctree:: - :maxdepth: 2 - :caption: The GPIOZ packages: - - input_devices - output_devices - connector - converter diff --git a/docs/sphinx/api/gpioz/input_devices.rst b/docs/sphinx/api/gpioz/input_devices.rst deleted file mode 100644 index ba29d70f5..000000000 --- a/docs/sphinx/api/gpioz/input_devices.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -GPIOZ Input Devices -------------------------------- - -.. automodule:: components.gpio.gpioz.core.input_devices - -.. currentmodule:: components.gpio.gpioz.core.input_devices - -Button -^^^^^^^^ - -.. autoclass:: Button - :members: on_press, set_rpc_actions, close, value, pull_up, pin, hold_time, hold_repeat - -Long press Button -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. autoclass:: LongPressButton - :members: on_press, set_rpc_actions, close, value, pull_up, pin, hold_time, hold_repeat - -Short + Long press Button -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. autoclass:: ShortLongPressButton - :members: on_short_press, on_long_press, set_rpc_actions, close, value, pull_up, pin, hold_time, hold_repeat - -Twin Button -^^^^^^^^^^^^^^^^^^^ - -.. autoclass:: TwinButton - :members: on_short_press_a, on_short_press_b, on_short_press_ab, on_long_press_a, on_long_press_b, on_long_press_ab, value, is_active, hold_repeat, hold_time, close - -Rotary Encoder -^^^^^^^^^^^^^^^^^^ - -.. autoclass:: RotaryEncoder - :members: on_rotate_clockwise, on_rotate_counter_clockwise, set_rpc_actions, close, pin_a, pin_b - - diff --git a/docs/sphinx/api/gpioz/output_devices.rst b/docs/sphinx/api/gpioz/output_devices.rst deleted file mode 100644 index a30986f03..000000000 --- a/docs/sphinx/api/gpioz/output_devices.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. RPI Jukebox RFID Version 3 -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -GPIOZ Output Devices -------------------------------- - -.. automodule:: components.gpio.gpioz.core.output_devices - -.. py:currentmodule:: components.gpio.gpioz.core.output_devices - - -LED -^^^ - -.. autoclass:: LED(pin, *, active_high=True, initial_value=False, pin_factory=None, name=None) - :members: flash, on, off, toggle, blink, pin, is_lit, value - -PWMLED -^^^^^^^ - -.. autoclass:: PWMLED(pin, *, active_high=True, initial_value=0, frequency=100, pin_factory=None, name=None) - :members: flash, on, off, toggle, blink, pulse, pin, is_lit, value - - -RGBLED -^^^^^^^ - -.. autoclass:: RGBLED(red, green, blue, *, active_high=True, initial_value=(0, 0, 0), pwm=True, pin_factory=None, name=None) - :members: flash, on, off, toggle, blink, pulse, red, green, blue, is_lit, color, value - - -Buzzer -^^^^^^^ - -.. autoclass:: Buzzer(pin, *, active_high=True, initial_value=False, pin_factory=None, name=None) - :members: flash, on, off, toggle, beep, pin, is_active, value - - -TonalBuzzer -^^^^^^^^^^^^^^ - -.. autoclass:: TonalBuzzer(pin, *, initial_value=None, mid_tone=Tone('A5'), octaves=2, pin_factory=None, name=None) - :members: melody, flash, play, stop, octaves, min_tone, mid_tone, max_tone, tone, is_active, value diff --git a/docs/sphinx/api/playlist.rst b/docs/sphinx/api/playlist.rst deleted file mode 100644 index febeb4c0f..000000000 --- a/docs/sphinx/api/playlist.rst +++ /dev/null @@ -1,11 +0,0 @@ -Playlist Generator -********************** - -.. automodule:: jukebox.playlistgenerator - -.. autoclass:: jukebox.playlistgenerator.PlaylistCollector - :members: - :private-members: _exclude_endings - - - diff --git a/docs/sphinx/api/plugs.rst b/docs/sphinx/api/plugs.rst deleted file mode 100644 index 73f2e1043..000000000 --- a/docs/sphinx/api/plugs.rst +++ /dev/null @@ -1,6 +0,0 @@ ----------------------------- -Plugs: The Plugin Package ----------------------------- - -.. automodule:: jukebox.plugs - :members: diff --git a/docs/sphinx/api/publishing.rst b/docs/sphinx/api/publishing.rst deleted file mode 100644 index 607d9e8d3..000000000 --- a/docs/sphinx/api/publishing.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. automodule:: jukebox.publishing.server - - jukebox.publishing - ------------------- - - .. autofunction:: jukebox.publishing.get_publisher - - jukebox.publishing.server - ------------------------- - - .. autoclass:: jukebox.publishing.server.Publisher - :members: diff --git a/docs/sphinx/api/rpc_server.rst b/docs/sphinx/api/rpc_server.rst deleted file mode 100644 index 634adf763..000000000 --- a/docs/sphinx/api/rpc_server.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. automodule:: jukebox.rpc.server - - jukebox.rpc.server - ------------------------- - - .. autoclass:: jukebox.rpc.server.RpcServer - :members: diff --git a/docs/sphinx/api/utils.rst b/docs/sphinx/api/utils.rst deleted file mode 100644 index 17ba7500c..000000000 --- a/docs/sphinx/api/utils.rst +++ /dev/null @@ -1,6 +0,0 @@ ----------------------------- -Jukebox utility functions ----------------------------- - -.. automodule:: jukebox.utils - :members: diff --git a/docs/sphinx/api/volume.rst b/docs/sphinx/api/volume.rst deleted file mode 100644 index 4bf700832..000000000 --- a/docs/sphinx/api/volume.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. RPI Jukebox RFID -.. RPI Jukebox RFID -.. Copyright (c) See file LICENSE in project root folder - -------------------------------- -Volume and Audio Sink Control -------------------------------- - -.. automodule:: components.volume - -.. autoclass:: components.volume.PulseMonitor - :members: - :inherited-members: Thread - -.. autoclass:: components.volume.PulseVolumeControl - :members: - :inherited-members: Thread diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py deleted file mode 100644 index 79b9476bd..000000000 --- a/docs/sphinx/conf.py +++ /dev/null @@ -1,67 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys -import sphinx_rtd_theme -sys.path.insert(0, os.path.abspath('../../src/jukebox')) -# This is needed for autodoc to load components.plugins with regular import - i.e. w/o going through plugs.load(...) -import jukebox.plugs # noqa: E402 -jukebox.plugs.ALLOW_DIRECT_IMPORTS = True -import jukebox.utils # noqa: E402 - - -# -- Project information ----------------------------------------------------- - -project = 'RPi Jukebox RFID' -copyright = '2021-2022, The RPi Jukebox RFID Community' -author = 'The RPi Jukebox RFID Community' - -# The full version, including alpha/beta/rc tags -release = jukebox.version() -version = release - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# html_theme = 'alabaster' -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# There are none yet: Comment out to suppress warning -# html_static_path = ['_static'] - -# --------------------------------------------------- - -# Prefix document path to section labels, to use: -# `path/to/file:heading` instead of just `heading` -autosectionlabel_prefix_document = True diff --git a/docs/sphinx/developer/coreapps.rst b/docs/sphinx/developer/coreapps.rst deleted file mode 100644 index 887b8d143..000000000 --- a/docs/sphinx/developer/coreapps.rst +++ /dev/null @@ -1,61 +0,0 @@ -Jukebox Apps -=============== - -The Jukebox's core apps are located in ``src/jukebox``. Run the following command to learn more about each app and its parameters: - -.. code-block:: bash - - $ ./run_app_name.py -h - -Jukebox Core -***************** - -run_jukebox.py ---------------- - -.. automodule:: run_jukebox - -Configuration Tools -******************** - -Before running the configuration tools, stop the Jukebox Core service. -See :ref:`userguide/configuration:Best practice procedure`. - -run_configure_audio.py ------------------------------ - -.. automodule:: run_configure_audio - -run_register_rfid_reader.py ------------------------------ - -.. automodule:: run_register_rfid_reader - -Developer Tools -***************** - -run_rpc_tool.py ---------------- - -.. automodule:: run_rpc_tool - -run_publicity_sniffer.py -------------------------- - -.. automodule:: run_publicity_sniffer - -run_sphinx.sh -------------------------- - -This command rebuilds the documentation using a Sphinx flow, located in the main directory. - -The documentation is built partially from auto-generated RST-files. -Thee files contain the :ref:`userguide/rpc_command_reference:RPC Command Reference` -and :ref:`userguide/rpc_command_alias_reference:RPC Command Alias Reference`. - -.. code-block:: bash - - run_jukebox.py -a - -The above command regenerate these RST files. This only needs to be done when -the RPC call references need to be updated within the documentation flow. diff --git a/docs/sphinx/developer/developer_issues.rst b/docs/sphinx/developer/developer_issues.rst deleted file mode 100644 index dd3a511fd..000000000 --- a/docs/sphinx/developer/developer_issues.rst +++ /dev/null @@ -1,80 +0,0 @@ -Developer Issues -****************** - -.. contents:: - -Building the Webapp on the PI -================================== - -JavaScript heap out of memory --------------------------------- - -While (re-) building the Web App, you get the following output: - -.. code-block:: bash - :emphasize-lines: 12 - - pi@MusicPi:~/RPi-Jukebox-RFID/src/webapp $ npm run build - - > webapp@0.1.0 build - > react-scripts build - - Creating an optimized production build... - - [...] - - <--- JS stacktrace ---> - - FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory - - -**Reason** - -Not enough memory for Node - -**Solution** - -Prior to building set the node memory environment variable. - - #. Make sure the value is less than the total available space on the system, or you may run into the next issue. (Not always though!) - Check memory availability with ``free -mt``. - #. We also experience trouble, when the space is set too small a value. 512 always works, 256 sometimes does, sometimes does not. - If your free memory is small, consider increasing the swap size of your system! - -.. code-block:: bash - - export NODE_OPTIONS=--max-old-space-size=512 - npm run build - -Alternatively, use the provided script, which sets the variable for you (provided your swap size is large enough): - -.. code-block:: bash - - $ ./run_rebuild.sh - - -Process exited too early // kill -9 ---------------------------------------- - -.. code-block:: bash - :emphasize-lines: 8,9 - - pi@MusicPi:~/RPi-Jukebox-RFID/src/webapp $ npm run build - - > webapp@0.1.0 build - > react-scripts build - - ... - - The build failed because the process exited too early. - This probably means the system ran out of memory or someone called 'kill -9' on the process. - -**Reason** - -Node tried to allocate more memory than available on the system. - -**Solution** - -Adjust the node memory variable as described in :ref:`developer/developer_issues:JavaScript heap out of memory`. -But make sure to allocate less memory than the available memory. -If that is not sufficient, increase the swap file size of your system and try again. diff --git a/docs/sphinx/developer/development_environment.rst b/docs/sphinx/developer/development_environment.rst deleted file mode 100644 index 243584eb7..000000000 --- a/docs/sphinx/developer/development_environment.rst +++ /dev/null @@ -1,73 +0,0 @@ -Development Environment -************************ - -You have 3 development options: - -.. contents:: - -Directly on Raspberry Pi ------------------------- - -The full setup is running on the RPi and you access files via SSH. Pretty easy to set up as -you simply do a normal install and switch to the ``future3/develop`` branch. - -Steps to install -```````````````` - -We recommend to use at least a Pi 3 or Pi Zero 2 for development. This hardware won't be needed -in production, but it can be slow while developing. - -1. Install the latest Pi OS on a SD card. -2. Boot up your Raspberry Pi. -3. :ref:`Install-- - diff --git a/run_sphinx.sh b/run_sphinx.sh deleted file mode 100755 index 972860cbe..000000000 --- a/run_sphinx.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/usr/bin/env bash - -usage() { - echo "Runner script for sphinx documentation build" - echo -e "\nWarnings are treated as errors as preparation for documentation releases.\n" - echo "Usage:" - echo " ./run_sphinx.sh : incremental build" - echo " ./run_sphinx.sh -c : clean re-build" - echo " ./run_sphinx.sh -n : Don't escalate warning to errors (for debug only!)" - exit 1 -} - -# Change working directory to location of script -SOURCE=${BASH_SOURCE[0]} -SCRIPT_DIR="$(dirname "$SOURCE")" -cd "$SCRIPT_DIR/docs/sphinx" || (echo "Could not change to docs directory" && exit 1) - -BUILD_DIR=_build - -CLEAN_BUILD=false -SPHINX_OPTS="-W --keep-going -T" -while getopts ":chn" opt; -do - case ${opt} in - c ) CLEAN_BUILD=true - ;; - h ) usage - ;; - n ) SPHINX_OPTS="-T" - ;; - \? ) usage - ;; - esac -done - - -if [[ $CLEAN_BUILD = true ]]; then - echo "Cleaning $BUILD_DIR" - rm -rf $BUILD_DIR - SPHINX_OPTS="$SPHINX_OPTS -a -E" -fi - -echo "Building docs [ sphinx-build $SPHINX_OPTS -b html . ${BUILD_DIR}/html/docs ]" -sphinx-build $SPHINX_OPTS -b html . ${BUILD_DIR}/html/docs - diff --git a/src/jukebox/components/controls/bluetooth_audio_buttons/README.rst b/src/jukebox/components/controls/bluetooth_audio_buttons/README.rst index 290b0c6b1..87a7eab2b 100644 --- a/src/jukebox/components/controls/bluetooth_audio_buttons/README.rst +++ b/src/jukebox/components/controls/bluetooth_audio_buttons/README.rst @@ -52,4 +52,4 @@ The RPC command follows the regular RPC command rules as defined in :ref:`usergu Key codes can be found in the log files. Press the various buttons on your headset, while watching the -logs with e.g. ``tail -f shared/logs/app.log``. Look for entries like ``No callback registered for button ...``. \ No newline at end of file +logs with e.g. ``tail -f shared/logs/app.log``. Look for entries like ``No callback registered for button ...``. diff --git a/src/jukebox/components/gpio/gpioz/README.rst b/src/jukebox/components/gpio/gpioz/README.rst index 9d6d7020b..46ab0250a 100644 --- a/src/jukebox/components/gpio/gpioz/README.rst +++ b/src/jukebox/components/gpio/gpioz/README.rst @@ -462,5 +462,3 @@ Simply change the header in the configuration file to enable it. Host is the IP pigpio.PiGPIOFactory: kwargs: host: 192.168.178.32 - - diff --git a/src/jukebox/components/rfid/hardware/template_new_reader/README.rst b/src/jukebox/components/rfid/hardware/template_new_reader/README.rst index 228f3039a..e20e4452b 100644 --- a/src/jukebox/components/rfid/hardware/template_new_reader/README.rst +++ b/src/jukebox/components/rfid/hardware/template_new_reader/README.rst @@ -27,8 +27,7 @@ Your new reader is a python subpackage with these three mandatory files +- description.py <-- A description module w/o dependencies. Do not change the filename! +- README.rst <-- The Readme -The module documentation must go into a separate file so we can import it into the Sphinx document generation flow -without loading the Python module. +The module documentation must go into a separate file, named README.MD. Conventions ^^^^^^^^^^^^^^^^^^ diff --git a/src/jukebox/jukebox/daemon.py b/src/jukebox/jukebox/daemon.py index 0c3805eeb..e847428e2 100755 --- a/src/jukebox/jukebox/daemon.py +++ b/src/jukebox/jukebox/daemon.py @@ -230,13 +230,10 @@ def run(self): if self.write_artifacts: # This writes out - # rpc_command_reference.rst # rpc_command_reference.txt - # rpc_command_alias_reference.rst # rpc_command_alias_reference.txt artifacts_dir = '../../shared/artifacts/' - sphinx_dir = '../../docs/sphinx/userguide' try: os.mkdir(artifacts_dir) @@ -250,14 +247,6 @@ def run(self): with open(os.path.join(artifacts_dir, 'rpc_command_alias_reference.txt'), 'w') as stream: jukebox.utils.generate_cmd_alias_reference(stream) - # Write RST files directly into Sphinx directory - - with open(os.path.join(sphinx_dir, 'rpc_command_reference.rst'), 'w') as stream: - plugin.generate_help_rst(stream) - - with open(os.path.join(sphinx_dir, 'rpc_command_alias_reference.rst'), 'w') as stream: - jukebox.utils.generate_cmd_alias_rst(stream) - # Start the RPC Server self.rpc_server.run() From 7406085aa8f960c202d933073390aef99c9f4a49 Mon Sep 17 00:00:00 2001 From: s-martinUps! Looks like your documentation has not been build!
-No reason to panic. Please run through the following steps: -
-
-- -
cd /home/pi/RPi-Jukebox-RFID- -
./run_sphinx.sh -c- Reload this page
-Or check out the online documentation at Read The Docs. -
+
+
+
## Install Phoniebox software
Run the following command in your SSH terminal and follow the instructions
@@ -90,4 +106,3 @@ If you suspect an error you can monitor the installation-process with
```bash
cd; tail -f INSTALL-In case you forgot to customize the OS settings, follow these instructions after RPi OS has been written to the SD card.
+ +### Pre-boot preparation You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to proceed with the next steps. @@ -62,6 +76,8 @@ You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to 9. Login into your Raspberry Pi, username is `pi` and password is `raspberry`. If `raspberrypi.local` does not work, find out your Raspberry Pi's IP address from your router. +
@@ -43,7 +43,6 @@ You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to
$ touch ssh
```
-
5. Set up your Wifi connection.
*Mac*
@@ -100,7 +99,6 @@ This will switch directly to the specified feature branch during installation.
> [!NOTE]
> For all branches *except* the current Release, you will need to build the Web App locally on the Pi. This is not part of the installation process due to memory limitation issues. See [Steps to install](../developers/development-environment.md#steps-to-install)
-
If you suspect an error you can monitor the installation-process with
```bash
From b7480b8845be343f111d83a78a02e1dd96f985e2 Mon Sep 17 00:00:00 2001
From: Simon
Date: Thu, 16 Nov 2023 22:10:07 +0100
Subject: [PATCH 018/121] fix rename
---
.../rfid/hardware/template_new_reader/{README.rst => README.md} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename src/jukebox/components/rfid/hardware/template_new_reader/{README.rst => README.md} (100%)
diff --git a/src/jukebox/components/rfid/hardware/template_new_reader/README.rst b/src/jukebox/components/rfid/hardware/template_new_reader/README.md
similarity index 100%
rename from src/jukebox/components/rfid/hardware/template_new_reader/README.rst
rename to src/jukebox/components/rfid/hardware/template_new_reader/README.md
From acf6ec0b4832db6bea2855a2d0fba4079037ad18 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Thu, 16 Nov 2023 22:49:57 +0100
Subject: [PATCH 019/121] Future3 fix venv usage (#2111)
* fix node setup
nodejs includes npm. fails on extra installation
folder keyrings might not be created yet
* install python packages via pip in venv
* move venv to project root
* remove outdated comments / messages about venv
* remove hardwired path. replace during installation
* fix dead variable
* #2112 fix 'not tagged as plugin callable'
---
.github/workflows/pythonpackage_future3.yml | 2 --
docker/armv7/jukebox.Dockerfile | 5 ++-
docker/jukebox.Dockerfile | 4 +--
.../developers/development-environment.md | 3 +-
installation/includes/00_constants.sh | 2 +-
installation/routines/setup_jukebox_core.sh | 32 ++++++++++---------
installation/routines/setup_jukebox_webapp.sh | 4 ++-
installation/routines/setup_mpd.sh | 2 +-
requirements.txt | 14 +++++---
.../default-services/jukebox-daemon.service | 4 +--
.../components/rfid/configure/__init__.py | 7 ----
src/jukebox/jukebox/multitimer.py | 1 +
12 files changed, 39 insertions(+), 41 deletions(-)
diff --git a/.github/workflows/pythonpackage_future3.yml b/.github/workflows/pythonpackage_future3.yml
index 757edb6f8..48e27b15d 100644
--- a/.github/workflows/pythonpackage_future3.yml
+++ b/.github/workflows/pythonpackage_future3.yml
@@ -34,8 +34,6 @@ jobs:
sudo apt-get update
sudo apt-get install -y libasound2-dev pulseaudio
python3 -m pip install --upgrade pip
- pip3 install wheel
- pip3 install spidev
pip3 install -r requirements.txt
# For operation of the Jukebox, ZMQ must be compiled from sources due to Websocket support
# Also install all optional dependencies
diff --git a/docker/armv7/jukebox.Dockerfile b/docker/armv7/jukebox.Dockerfile
index a0e872325..d81c447de 100644
--- a/docker/armv7/jukebox.Dockerfile
+++ b/docker/armv7/jukebox.Dockerfile
@@ -25,11 +25,10 @@ RUN apt-get update && apt-get install -qq -y \
--allow-downgrades --allow-remove-essential --allow-change-held-packages \
at wget gcc \
mpc mpg123 git ffmpeg spi-tools netcat alsa-tools \
- python3 python3-venv python3-dev python3-pip python3-setuptools python3-mutagen python3-gpiozero
+ python3 python3-venv python3-dev python3-mutagen
#samba samba-common-bin
#raspberrypi-kernel-headers
#resolvconf
-#python3-spidev
# Install Jukebox
# Install libzmq with Websocket support from pre-compiled source
@@ -57,7 +56,7 @@ RUN mkdir -p ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
# zeromq-${ZMQ_VERSION}/configure --prefix=${ZMQ_PREFIX} --enable-drafts; \
# make && make install;
-ENV VIRTUAL_ENV=/opt/venv
+ENV VIRTUAL_ENV=${INSTALLATION_PATH}/.venv
RUN python3 -m venv $VIRTUAL_ENV
ENV PATH="$VIRTUAL_ENV/bin:$PATH"
diff --git a/docker/jukebox.Dockerfile b/docker/jukebox.Dockerfile
index a455ec9d2..5e7a08915 100644
--- a/docker/jukebox.Dockerfile
+++ b/docker/jukebox.Dockerfile
@@ -25,9 +25,9 @@ RUN apt-get update && apt-get install -qq -y \
--allow-downgrades --allow-remove-essential --allow-change-held-packages \
gcc at wget \
espeak mpc mpg123 git ffmpeg spi-tools netcat \
- python3 python3-venv python3-dev python3-pip python3-mutagen python3-gpiozero
+ python3 python3-venv python3-dev python3-mutagen
-ENV VIRTUAL_ENV=/opt/venv
+ENV VIRTUAL_ENV=${INSTALLATION_PATH}/.venv
RUN python3 -m venv $VIRTUAL_ENV
ENV PATH="$VIRTUAL_ENV/bin:$PATH"
diff --git a/documentation/content/developers/development-environment.md b/documentation/content/developers/development-environment.md
index 44b748ebb..62eaeaec6 100644
--- a/documentation/content/developers/development-environment.md
+++ b/documentation/content/developers/development-environment.md
@@ -50,8 +50,7 @@ developing.
The jukebox also runs on any Linux machine. The Raspberry Pi specific
stuff will not work of course. That is no issue depending our your
-development area. USB RFID Readers, however, will work. You may setup a
-Python virtual environment or a conda virtual environment. You will have
+development area. USB RFID Readers, however, will work. You will have
to install and configure [MPD (Music Player
Daemon)](https://www.musicpd.org/).
diff --git a/installation/includes/00_constants.sh b/installation/includes/00_constants.sh
index f643cdc47..e19dd1327 100644
--- a/installation/includes/00_constants.sh
+++ b/installation/includes/00_constants.sh
@@ -1,7 +1,7 @@
RPI_BOOT_CONFIG_FILE="/boot/config.txt"
SHARED_PATH="${INSTALLATION_PATH}/shared"
SETTINGS_PATH="${SHARED_PATH}/settings"
-SYSTEMD_USR_PATH="/usr/lib/systemd/user/"
+SYSTEMD_USR_PATH="/usr/lib/systemd/user"
# The default upstream user, release branch, and develop branch
# These are used to prepare the repo for developers
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index ab5f0a9bd..e6dfa6d8f 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -19,12 +19,11 @@ echo " --------------------------------------------------------------------
# Functions
_jukebox_core_install_os_dependencies() {
- echo "Install Jukebox OS dependencies"
- sudo apt-get -y update; sudo apt-get -y install \
+ echo " Install Jukebox OS dependencies"
+ sudo apt-get -y update && sudo apt-get -y install \
at \
alsa-utils \
- python3 python3-venv python3-dev python3-pip python3-setuptools \
- python3-rpi.gpio python3-gpiozero \
+ python3 python3-venv python3-dev \
espeak ffmpeg mpg123 \
pulseaudio pulseaudio-module-bluetooth pulseaudio-utils caps \
libasound2-dev \
@@ -32,13 +31,19 @@ _jukebox_core_install_os_dependencies() {
--allow-downgrades \
--allow-remove-essential \
--allow-change-held-packages
+}
+
+_jukebox_core_install_python_requirements() {
+ echo " Install Python requirements"
- VIRTUAL_ENV="${HOME_PATH}/.venv"
+ cd "${INSTALLATION_PATH}" || exit_on_error
+
+ VIRTUAL_ENV="${INSTALLATION_PATH}/.venv"
python3 -m venv $VIRTUAL_ENV
- PATH="$VIRTUAL_ENV/bin:$PATH"
source "$VIRTUAL_ENV/bin/activate"
pip install --upgrade pip
+ pip install --no-cache-dir -r "${INSTALLATION_PATH}/requirements.txt"
}
_jukebox_core_configure_pulseaudio() {
@@ -111,12 +116,6 @@ _jukebox_core_build_and_install_pyzmq() {
fi
}
-_jukebox_core_install_python_requirements() {
- echo " Install requirements"
- cd "${INSTALLATION_PATH}" || exit_on_error
- pip install --no-cache-dir -r "${INSTALLATION_PATH}/requirements.txt"
-}
-
_jukebox_core_install_settings() {
echo " Register Jukebox settings"
cp -f "${INSTALLATION_PATH}/resources/default-settings/jukebox.default.yaml" "${SETTINGS_PATH}/jukebox.yaml"
@@ -125,8 +124,11 @@ _jukebox_core_install_settings() {
_jukebox_core_register_as_service() {
echo " Register Jukebox Core user service"
- sudo cp -f "${INSTALLATION_PATH}/resources/default-services/jukebox-daemon.service" "${SYSTEMD_USR_PATH}"
- sudo chmod 644 "${SYSTEMD_USR_PATH}/jukebox-daemon.service"
+
+ local jukebox_service="${SYSTEMD_USR_PATH}/jukebox-daemon.service"
+ sudo cp -f "${INSTALLATION_PATH}/resources/default-services/jukebox-daemon.service" "${jukebox_service}"
+ sudo sed -i "s|%%INSTALLATION_PATH%%|${INSTALLATION_PATH}|g" "${jukebox_service}"
+ sudo chmod 644 "${jukebox_service}"
systemctl --user daemon-reload
systemctl --user enable jukebox-daemon.service
@@ -136,8 +138,8 @@ setup_jukebox_core() {
echo "Install Jukebox Core" | tee /dev/fd/3
_jukebox_core_install_os_dependencies
- _jukebox_core_configure_pulseaudio
_jukebox_core_install_python_requirements
+ _jukebox_core_configure_pulseaudio
_jukebox_core_build_and_install_pyzmq
_jukebox_core_install_settings
_jukebox_core_register_as_service
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index a2f9e014a..a0e195622 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -32,10 +32,12 @@ _jukebox_webapp_install_node() {
else
# install NodeJS and npm as recommended in
# https://github.com/nodesource/distributions
+ sudo apt-get install -y ca-certificates curl gnupg
+ sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
sudo apt-get update
- sudo apt-get install nodejs npm -y
+ sudo apt-get install -y nodejs
fi
fi
diff --git a/installation/routines/setup_mpd.sh b/installation/routines/setup_mpd.sh
index b3a1c3473..6b72b5f9a 100644
--- a/installation/routines/setup_mpd.sh
+++ b/installation/routines/setup_mpd.sh
@@ -36,7 +36,7 @@ setup_mpd() {
local MPD_EXECUTE_INSTALL=true
- if [[ -f ${MPD_CONF_PATH} || -f ${SYSTEMD_PATH}/mpd.service ]]; then
+ if [[ -f ${MPD_CONF_PATH} || -f ${SYSTEMD_USR_PATH}/mpd.service ]]; then
echo " It seems there is a MPD already installed."
echo " Note: It is important that MPD runs as a user service!"
echo " Would you like to overwrite your configuration? [Y/n] " | tee /dev/fd/3
diff --git a/requirements.txt b/requirements.txt
index 1d9e9ae83..f9f452799 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,9 @@
+# Common python packages
+# You need to install these with `python -m pip install --no-cache-dir -r requirements.txt`
+
+setuptools
+wheel
+
# Note:
# sudo apt install libasound2-dev required on some machines
@@ -13,10 +19,9 @@ requests
# For the publisher event reactor loop:
tornado
-# RPi's GPIO packages: these are installed via APT on the PI
-# On regular machines, install them manually if needed for development
-# RPi.GPIO
-# gpiozero
+# RPi's GPIO packages:
+RPi.GPIO
+gpiozero
# PyZMQ is a special case:
# On the PI, it needs to be compiled with special options to enable Websocket support
@@ -28,4 +33,3 @@ tornado
flake8>=4.0.0
pytest
mock
-
diff --git a/resources/default-services/jukebox-daemon.service b/resources/default-services/jukebox-daemon.service
index f2557480e..050897e14 100644
--- a/resources/default-services/jukebox-daemon.service
+++ b/resources/default-services/jukebox-daemon.service
@@ -10,8 +10,8 @@ After=network.target sound.target mpd.service pulseaudio.service
Requires=mpd.service pulseaudio.service
[Service]
-WorkingDirectory=/home/pi/RPi-Jukebox-RFID/src/jukebox
-ExecStart=/bin/bash -c 'source /home/pi/.venv/bin/activate && /home/pi/.venv/bin/python run_jukebox.py'
+WorkingDirectory=%%INSTALLATION_PATH%%/src/jukebox
+ExecStart=/bin/bash -c 'source %%INSTALLATION_PATH%%/.venv/bin/activate && python run_jukebox.py'
StandardOutput=inherit
StandardError=inherit
Restart=always
diff --git a/src/jukebox/components/rfid/configure/__init__.py b/src/jukebox/components/rfid/configure/__init__.py
index bf8dec4a9..7f9e232f2 100755
--- a/src/jukebox/components/rfid/configure/__init__.py
+++ b/src/jukebox/components/rfid/configure/__init__.py
@@ -26,13 +26,6 @@ def reader_install_dependencies(reader_path: str, dependency_install: str) -> No
if os.path.exists(reader_path + '/requirements.txt'):
# The python dependencies (if any)
print("\nInstalling/Checking Python dependencies ...\n")
- print("IMPORTANT for developers: Python dependencies will be installed using "
- " $ pip install --upgrade -r requirements.txt'\n"
- " i.e. on system level. This is target for the default RPI setup. "
- "If you do not want that, but rather have them in a local or virtual environment, "
- "hit No here and manually install the dependencies from your virtual environment\n"
- " $ pip install --upgrade -r requirements.txt'\n"
- "It is no problem to install them after running this script.\n\n")
if dependency_install == 'auto' or pyil.input_yesno("Install Python dependencies?", blank=True,
prompt_color=Colors.lightgreen, prompt_hint=True):
print(f"{'=' * 80}")
diff --git a/src/jukebox/jukebox/multitimer.py b/src/jukebox/jukebox/multitimer.py
index 455b8ba75..b03aae83f 100644
--- a/src/jukebox/jukebox/multitimer.py
+++ b/src/jukebox/jukebox/multitimer.py
@@ -249,6 +249,7 @@ def start(self, iterations=None, wait_seconds_per_iteration=None):
self._function = self._callee(*self.class_args, iterations=self._iterations, **self.class_kwargs)
super().start(wait_seconds_per_iteration)
+ @plugin.tag
def get_state(self):
return {'enabled': self.is_alive(),
'wait_seconds_per_iteration': self.get_timeout(),
From babb237a34cf4765523082d7845c428d41240d0d Mon Sep 17 00:00:00 2001
From: s-martin
Date: Thu, 16 Nov 2023 23:57:28 +0100
Subject: [PATCH 020/121] fix docker description for windows (#2114)
---
documentation/content/developers/docker.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/documentation/content/developers/docker.md b/documentation/content/developers/docker.md
index 012b8d3db..0def11610 100644
--- a/documentation/content/developers/docker.md
+++ b/documentation/content/developers/docker.md
@@ -129,24 +129,26 @@ $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml d
6. Execute `$INSTALL_DIR/bin/pulseaudio.exe`
-7. Run `docker-compose`
+7. Make sure Docker is running (e.g. start Docker Desktop)
+
+8. Run `docker-compose`
``` bash
// Build Images
- $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.windows.yml build
+ $ docker-compose -f docker/docker-compose.yml build
// Run Docker Environment
- $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.windows.yml up
+ $ docker-compose -f docker/docker-compose.yml up
// Shuts down Docker containers and Docker network
- $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.windows.yml down
+ $ docker-compose -f docker/docker-compose.yml down
```
## Test & Develop
The Dockerfile is defined to start all Phoniebox related services.
-Open in your browser to see the web application.
+Open in your browser to see the web application.
While the `webapp` container does not require a reload while working on
it (hot-reload is enabled), you will have to restart your `jukebox`
From dfb9e931fb0ed99750b30c3a52bbcf16139727f0 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Sat, 18 Nov 2023 14:40:10 +0100
Subject: [PATCH 021/121] Cleanup installation messages (#2109)
* cleanup installation messages
use clear for each new option
added headers
use correct urls in finish message
fixed some typos and wording
* fix usage with multiple ip addresses (ipv4/ipv6)
use single call to get all information during installation
show and read out only first ip in webui
* fix typo in translation
* fix order for gateway / interface
* harmonize read answer option
* fix FIN_MESSAGE
* fix line break on OS check
---
installation/includes/02_helpers.sh | 2 +-
installation/includes/03_welcome.sh | 12 +-
installation/includes/05_finish.sh | 19 ++-
installation/routines/customize_options.sh | 142 ++++++++++++------
installation/routines/install.sh | 1 +
installation/routines/optimize_boot_time.sh | 19 +--
installation/routines/setup_mpd.sh | 6 +-
.../components/hostif/linux/__init__.py | 3 +
src/webapp/public/locales/de/translation.json | 2 +-
9 files changed, 125 insertions(+), 81 deletions(-)
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index d2e1162f1..9ad8e71b8 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -45,7 +45,7 @@ check_os_type() {
local os_type
os_type=$(uname -m)
- echo "Checking OS type ... $os_type" | tee /dev/fd/3
+ echo -e "\nChecking OS type '$os_type'" | tee /dev/fd/3
if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then
echo -e " ... OK!\n" | tee /dev/fd/3
diff --git a/installation/includes/03_welcome.sh b/installation/includes/03_welcome.sh
index 1b2de1600..7aeaa56ab 100644
--- a/installation/includes/03_welcome.sh
+++ b/installation/includes/03_welcome.sh
@@ -19,16 +19,18 @@ Depending on your hardware, this installation might last
around 60 minutes (usually it's faster). It updates OS
packages, installs Phoniebox dependencies and registers
settings. Be patient and don't let your computer go to
-sleep. It might disconnect your SSH connection causing the
-interruption of the installation process.
+sleep. It might disconnect your SSH connection causing
+the interruption of the installation process.
+Consider starting the installation in a terminal
+multiplexer like 'screen' or 'tmux' to avoid this.
By the way, you can follow the installation details here
in a separate SSH session:
cd; tail -f ${INSTALLATION_LOGFILE}
-Let's set up your Phoniebox now?! [Y/n]" 1>&3
-
- read -rp "Do you want to install? [Y/n] " response
+Let's set up your Phoniebox.
+Do you want to start the installation? [Y/n]" 1>&3
+ read -r response
case "$response" in
[nN][oO]|[nN])
exit
diff --git a/installation/includes/05_finish.sh b/installation/includes/05_finish.sh
index 513d757d2..50c2f6d9d 100644
--- a/installation/includes/05_finish.sh
+++ b/installation/includes/05_finish.sh
@@ -1,8 +1,8 @@
#!/usr/bin/env bash
finish() {
- echo -e "
----
+local local_hostname=$(hostname)
+ echo -e "####################### FINISHED ########################
Installation complete!
@@ -11,14 +11,13 @@ ${FIN_MESSAGE}
In order to start, you need to reboot your Raspberry Pi.
Your SSH connection will disconnect.
-After the reboot, open either http://raspberrypi.local
-(for Mac / iOS) or http://[IP-ADDRESS] (for Android / Windows)
-in a browser to get started. Don't forget to upload files
-via Samba.
+After the reboot, you can access the WebApp in your browser at
+http://${local_hostname}.local or http://${CURRENT_IP_ADDRESS}
+Don't forget to upload files.
Do you want to reboot now? [Y/n]" 1>&3
- read -rp "Do you want to reboot now? [Y/n] " response
+ read -r response
case "$response" in
[nN][oO]|[nN])
echo "Reboot aborted" | tee /dev/fd/3
@@ -41,14 +40,14 @@ Do you want to reboot now? [Y/n]" 1>&3
exit_on_error () {
echo -e "\n****************************************" | tee /dev/fd/3
- echo -e "ERROR OCCURRED!
+ echo "ERROR OCCURRED!
A non-recoverable error occurred.
Check install log for details:" | tee /dev/fd/3
echo "$INSTALLATION_LOGFILE" | tee /dev/fd/3
- echo -e "****************************************" | tee /dev/fd/3
+ echo "****************************************" | tee /dev/fd/3
if [[ -n $1 ]]; then
echo "$1" | tee /dev/fd/3
- echo -e "****************************************" | tee /dev/fd/3
+ echo "****************************************" | tee /dev/fd/3
fi
echo "Abort!"
exit 1
diff --git a/installation/routines/customize_options.sh b/installation/routines/customize_options.sh
index d12b42390..d5ac7c547 100644
--- a/installation/routines/customize_options.sh
+++ b/installation/routines/customize_options.sh
@@ -2,10 +2,21 @@
_option_static_ip() {
# ENABLE_STATIC_IP
- CURRENT_IP_ADDRESS=$(hostname -I)
- echo "Would you like to set a static IP (will be ${CURRENT_IP_ADDRESS})?
-It'll save a lot of start up time. This can be changed later.
-[Y/n] " 1>&3
+ # Using the dynamically assigned IP address as it is the best guess to be free
+ # Reference: https://unix.stackexchange.com/a/505385
+ CURRENT_ROUTE=$(ip route get 8.8.8.8)
+ CURRENT_GATEWAY=$(echo "${CURRENT_ROUTE}" | awk '{ print $3; exit }')
+ CURRENT_INTERFACE=$(echo "${CURRENT_ROUTE}" | awk '{ print $5; exit }')
+ CURRENT_IP_ADDRESS=$(echo "${CURRENT_ROUTE}" | awk '{ print $7; exit }')
+ clear 1>&3
+ echo "----------------------- STATIC IP -----------------------
+
+Setting a static IP will save a lot of start up time.
+The static adress will be '${CURRENT_IP_ADDRESS}'
+from interface '${CURRENT_INTERFACE}'
+with the gateway '${CURRENT_GATEWAY}'.
+
+Set a static IP? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
@@ -19,7 +30,13 @@ It'll save a lot of start up time. This can be changed later.
_option_ipv6() {
# DISABLE_IPv6
- echo "Do you want to disable IPv6? [Y/n] " 1>&3
+ clear 1>&3
+ echo "------------------------- IP V6 -------------------------
+
+IPv6 is only needed if you intend to use it.
+Otherwise it can be disabled.
+
+Do you want to disable IPv6? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
@@ -33,14 +50,17 @@ _option_ipv6() {
_option_autohotspot() {
# ENABLE_AUTOHOTSPOT
- echo "Do you want to enable a WiFi hotspot on demand?
+ clear 1>&3
+ echo "---------------------- AUTOHOTSPOT ----------------------
+
When enabled, this service spins up a WiFi hotspot
when the Phoniebox is unable to connect to a known
WiFi. This way you can still access it.
-[y/N] " 1>&3
+
+Do you want to enable an Autohotpot? [y/N]" 1>&3
read -r response
case "$response" in
- [yY])
+ [yY][eE][sS]|[yY])
ENABLE_AUTOHOTSPOT=true
;;
*)
@@ -51,7 +71,7 @@ WiFi. This way you can still access it.
echo "Do you want to set a custom Password? (default: ${AUTOHOTSPOT_PASSWORD}) [y/N] " 1>&3
read -r response_pw_q
case "$response_pw_q" in
- [yY])
+ [yY][eE][sS]|[yY])
while [ $(echo ${response_pw}|wc -m) -lt 8 ]
do
echo "Please type the new password (at least 8 character)." 1>&3
@@ -80,9 +100,13 @@ WiFi. This way you can still access it.
_option_bluetooth() {
# DISABLE_BLUETOOTH
- echo "Do you want to disable Bluetooth?
-Turn off Bluetooth if you do not plan to use it. It saves energy and start up time.
-[Y/n] " 1>&3
+ clear 1>&3
+ echo "----------------------- BLUETOOTH -----------------------
+
+Turning off Bluetooth will save energy and
+start up time, if you do not plan to use it.
+
+Do you want to disable Bluetooth? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
@@ -96,10 +120,15 @@ Turn off Bluetooth if you do not plan to use it. It saves energy and start up ti
_option_samba() {
# ENABLE_SAMBA
- echo "Samba will be installed. It is required to conveniently copy files to
-your Phoniebox via a network share. If you don't need it, feel free to skip
-the installation. If you are unsure, stick to YES!
-[Y/n] " 1>&3
+ clear 1>&3
+ echo "------------------------- SAMBA -------------------------
+
+Samba is required to conveniently copy files
+to your Phoniebox via a network share.
+If you don't need it, feel free to skip the installation.
+If you are unsure, stick to YES!
+
+Do you want to install Samba? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
@@ -114,10 +143,13 @@ the installation. If you are unsure, stick to YES!
_option_webapp() {
# ENABLE_WEBAPP
- echo "Would you like to install the web application?
-This is only required if you want to use a graphical interface
-to manage your Phoniebox!
-[Y/n] " 1>&3
+ clear 1>&3
+ echo "------------------------ WEBAPP -------------------------
+
+This is only required if you want to use
+a graphical interface to manage your Phoniebox!
+
+Would you like to install the web application? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
@@ -132,14 +164,18 @@ to manage your Phoniebox!
_option_kiosk_mode() {
# ENABLE_KIOSK_MODE
- echo "Would you like to enable the Kiosk Mode?
-If you have a screen attached to your RPi, this will launch the
-web application right after boot. It will only install the necessary
-xserver dependencies and not the entire RPi desktop environment.
-[y/N] " 1>&3
+ clear 1>&3
+ echo "----------------------- KIOSK MODE ----------------------
+
+If you have a screen attached to your RPi,
+this will launch the web application right after boot.
+It will only install the necessary xserver dependencies
+and not the entire RPi desktop environment.
+
+Would you like to enable the Kiosk Mode? [y/N]" 1>&3
read -r response
case "$response" in
- [yY])
+ [yY][eE][sS]|[yY])
ENABLE_KIOSK_MODE=true
;;
*)
@@ -150,12 +186,16 @@ xserver dependencies and not the entire RPi desktop environment.
_options_update_raspi_os() {
# UPDATE_RASPI_OS
- echo "Would you like to update the operating system?
-This shall be done eventually, but increases the installation time a lot.
-[Y/n] " 1>&3
+ clear 1>&3
+ echo "----------------------- UPDATE OS -----------------------
+
+This shall be done eventually,
+but increases the installation time a lot.
+
+Would you like to update the operating system? [Y/n]" 1>&3
read -r response
case "$response" in
- [nN])
+ [nN][oO]|[nN])
UPDATE_RASPI_OS=false
;;
*)
@@ -167,18 +207,25 @@ This shall be done eventually, but increases the installation time a lot.
_option_disable_onboard_audio() {
# Disable BCM on-chip audio (typically Headphones)
# not needed when external sound card is sued
+ clear 1>&3
+ echo "--------------------- ON-CHIP AUDIO ---------------------
+
+If you are using an external sound card (e.g. USB,
+HifiBerry, PirateAudio, etc), we recommend to disable
+the on-chip audio. It will make the ALSA sound
+configuration easier.
+If you are planning to only use Bluetooth speakers,
+leave the on-chip audio enabled!
+(This will touch your boot configuration in
+${RPI_BOOT_CONFIG_FILE}.
+We will do our best not to mess anything up. However,
+a backup copy will be written to
+${DISABLE_ONBOARD_AUDIO_BACKUP} )
- echo -e "Disable Pi's on-chip audio (headphone / jack output)?
-If you are using an external sound card (e.g. USB, HifiBerry, PirateAudio, etc),
-we recommend to disable the on-chip audio. It will make the ALSA sound configuration easier.
-If you are planning to only use Bluetooth speakers, leave the on-chip audio enabled!
-(This will touch your boot configuration in ${RPI_BOOT_CONFIG_FILE}.
-We will do our best not to mess anything up. However, a backup copy will be written to
-${DISABLE_ONBOARD_AUDIO_BACKUP} if things go pear-shaped.)
-[y/N] " 1>&3
+Disable Pi's on-chip audio (headphone / jack output)? [y/N]" 1>&3
read -r response
case "$response" in
- [yY])
+ [yY][eE][sS]|[yY])
DISABLE_ONBOARD_AUDIO=true
;;
*)
@@ -196,27 +243,28 @@ _option_webapp_devel_build() {
if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" = "release-only" ]]; then
ENABLE_WEBAPP_PROD_DOWNLOAD=false
fi
-
if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" = false ]]; then
- echo -e "Your are installing from a non-release branch.
+ clear 1>&3
+ echo "--------------------- WEBAPP NODE ---------------------
+
+You are installing from a non-release branch.
This means, you will need to build the web app locally.
For that you'll need Node.
-Do you want to install Node? [Y/n] " 1>&3
+
+Do you want to install Node? [Y/n]" 1>&3
read -r response
case "$response" in
- [nN])
+ [nN][oO]|[nN])
ENABLE_INSTALL_NODE=false
;;
*)
;;
esac
-
# This message will be displayed at the end of the installation process
- FIN_MESSAGE="$FIN_MESSAGE\n\nATTENTION: You need to build the web app locally with
+ FIN_MESSAGE="$FIN_MESSAGE\nATTENTION: You need to build the web app locally with
$ cd ~/RPi-Jukebox-RFID/src/webapp && ./run_rebuild.sh -u
This must be done after reboot, due to memory restrictions.
Read the documentation regarding local Web App builds!"
- ENABLE_WEBAPP_PROD_DOWNLOAD=false
fi
fi
}
@@ -224,8 +272,8 @@ Do you want to install Node? [Y/n] " 1>&3
customize_options() {
echo "Customize Options starts"
- _option_static_ip
_option_ipv6
+ _option_static_ip
_option_autohotspot
_option_bluetooth
_option_disable_onboard_audio
diff --git a/installation/routines/install.sh b/installation/routines/install.sh
index f7db0e1d5..ca25a17a3 100644
--- a/installation/routines/install.sh
+++ b/installation/routines/install.sh
@@ -1,5 +1,6 @@
install() {
check_os_type
+ clear 1>&3
customize_options
clear 1>&3
set_raspi_config
diff --git a/installation/routines/optimize_boot_time.sh b/installation/routines/optimize_boot_time.sh
index ef40ed1fb..2fea66a86 100644
--- a/installation/routines/optimize_boot_time.sh
+++ b/installation/routines/optimize_boot_time.sh
@@ -40,26 +40,17 @@ _optimize_handle_network_connection() {
echo " Skipping. Already set up!" | tee /dev/fd/3
else
# DHCP has not been configured
- # Reference: https://unix.stackexchange.com/a/307790/478030
- INTERFACE=$(route | grep '^default' | grep -o '[^ ]*$')
-
- # Reference: https://serverfault.com/a/31179/431930
- GATEWAY=$(route -n | grep 'UG[ \t]' | awk '{print $2}')
-
- # Using the dynamically assigned IP address as it is the best guess to be free
- # Reference: https://unix.stackexchange.com/a/48254/478030
- CURRENT_IP_ADDRESS=$(hostname -I)
- echo " * ${INTERFACE} is the default network interface" | tee /dev/fd/3
- echo " * ${GATEWAY} is the Router Gateway address" | tee /dev/fd/3
+ echo " * ${CURRENT_INTERFACE} is the default network interface" | tee /dev/fd/3
+ echo " * ${CURRENT_GATEWAY} is the Router Gateway address" | tee /dev/fd/3
echo " * Using ${CURRENT_IP_ADDRESS} as the static IP for now" | tee /dev/fd/3
sudo tee -a $DHCP_CONF <<-EOF
## Jukebox DHCP Config
-interface ${INTERFACE}
+interface ${CURRENT_INTERFACE}
static ip_address=${CURRENT_IP_ADDRESS}/24
-static routers=${GATEWAY}
-static domain_name_servers=${GATEWAY}
+static routers=${CURRENT_GATEWAY}
+static domain_name_servers=${CURRENT_GATEWAY}
EOF
diff --git a/installation/routines/setup_mpd.sh b/installation/routines/setup_mpd.sh
index 6b72b5f9a..53b9ac01b 100644
--- a/installation/routines/setup_mpd.sh
+++ b/installation/routines/setup_mpd.sh
@@ -37,9 +37,9 @@ setup_mpd() {
local MPD_EXECUTE_INSTALL=true
if [[ -f ${MPD_CONF_PATH} || -f ${SYSTEMD_USR_PATH}/mpd.service ]]; then
- echo " It seems there is a MPD already installed."
- echo " Note: It is important that MPD runs as a user service!"
- echo " Would you like to overwrite your configuration? [Y/n] " | tee /dev/fd/3
+ echo "It seems there is a MPD already installed.
+Note: It is important that MPD runs as a user service!
+Would you like to overwrite your configuration? [Y/n]" 1>&3
read -r response
case "$response" in
[nN][oO]|[nN])
diff --git a/src/jukebox/components/hostif/linux/__init__.py b/src/jukebox/components/hostif/linux/__init__.py
index 379af014d..582074413 100644
--- a/src/jukebox/components/hostif/linux/__init__.py
+++ b/src/jukebox/components/hostif/linux/__init__.py
@@ -193,6 +193,9 @@ def get_ip_address():
ip_address = p.stdout.strip().decode()
else:
ip_address = '127.0.0.1'
+
+ # only get first if multiple adresses are present (ipv4/ipv6)
+ ip_address = ip_address.split(' ')[0]
return ip_address
diff --git a/src/webapp/public/locales/de/translation.json b/src/webapp/public/locales/de/translation.json
index 25b11b703..85d39b879 100644
--- a/src/webapp/public/locales/de/translation.json
+++ b/src/webapp/public/locales/de/translation.json
@@ -227,7 +227,7 @@
},
"disk-usage": {
"label": "Speicherverbrauch",
- "loading-error": "Die Angaben zum Speicherverbrauch konntent nicht geladen werden.",
+ "loading-error": "Die Angaben zum Speicherverbrauch konnten nicht geladen werden.",
"result": "{{used}} GB von {{total}} GB sind belegt ({{result}}%)"
},
"ip-address": {
From 2a0bb20bcb83000a9d7b0f0898aba0c8e811841b Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Fri, 24 Nov 2023 23:24:29 +0100
Subject: [PATCH 022/121] Update some links in the documentation (#2122)
* Update some links in the documentation
* Rename docs folder userguide to builders
* Update some headlines
---
README.md | 2 +-
documentation/README.md | 14 ++++++++------
.../content/{userguide => builders}/README.md | 2 +-
.../content/{userguide => builders}/audio.md | 0
.../{userguide => builders}/autohotspot.md | 0
.../bluetooth-audio-buttons.md | 0
.../{userguide => builders}/card-database.md | 2 +-
.../content/{userguide => builders}/concepts.md | 0
.../{userguide => builders}/configuration.md | 0
.../{userguide => builders}/installation.md | 2 +-
.../content/{userguide => builders}/mock_gpio.png | Bin
.../content/{userguide => builders}/rfid.md | 0
.../content/{userguide => builders}/system.md | 0
.../{userguide => builders}/troubleshooting.md | 0
.../content/{userguide => builders}/update.md | 0
documentation/content/developers/coreapps.md | 8 ++++----
.../content/developers/development-environment.md | 2 +-
documentation/content/developers/rfid/basics.md | 4 ++--
.../content/developers/rfid/mock_reader.md | 2 +-
documentation/content/developers/status.md | 2 +-
20 files changed, 21 insertions(+), 19 deletions(-)
rename documentation/content/{userguide => builders}/README.md (97%)
rename documentation/content/{userguide => builders}/audio.md (100%)
rename documentation/content/{userguide => builders}/autohotspot.md (100%)
rename documentation/content/{userguide => builders}/bluetooth-audio-buttons.md (100%)
rename documentation/content/{userguide => builders}/card-database.md (97%)
rename documentation/content/{userguide => builders}/concepts.md (100%)
rename documentation/content/{userguide => builders}/configuration.md (100%)
rename documentation/content/{userguide => builders}/installation.md (97%)
rename documentation/content/{userguide => builders}/mock_gpio.png (100%)
rename documentation/content/{userguide => builders}/rfid.md (100%)
rename documentation/content/{userguide => builders}/system.md (100%)
rename documentation/content/{userguide => builders}/troubleshooting.md (100%)
rename documentation/content/{userguide => builders}/update.md (100%)
diff --git a/README.md b/README.md
index b95b0e8c3..8b494698d 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ project check out the [documentation of Version 2]( [!IMPORTANT]
-> Currently, the installation does only work on Raspberry Pi's with ARMv7 and ARMv8 architecture, so 2, 3 and 4! Pi 1 and Zero's are currently unstable and will require a bit more work!
+> Currently, the installation does only work on Raspberry Pi's with ARMv7 and ARMv8 architecture, so 2, 3 and 4! Pi 1 and Zero's are currently unstable and will require a bit more work! Pi 4 and 5 are an excess ;-)
Before you can install the Phoniebox software, you need to prepare your Raspberry Pi.
diff --git a/documentation/content/userguide/mock_gpio.png b/documentation/content/builders/mock_gpio.png
similarity index 100%
rename from documentation/content/userguide/mock_gpio.png
rename to documentation/content/builders/mock_gpio.png
diff --git a/documentation/content/userguide/rfid.md b/documentation/content/builders/rfid.md
similarity index 100%
rename from documentation/content/userguide/rfid.md
rename to documentation/content/builders/rfid.md
diff --git a/documentation/content/userguide/system.md b/documentation/content/builders/system.md
similarity index 100%
rename from documentation/content/userguide/system.md
rename to documentation/content/builders/system.md
diff --git a/documentation/content/userguide/troubleshooting.md b/documentation/content/builders/troubleshooting.md
similarity index 100%
rename from documentation/content/userguide/troubleshooting.md
rename to documentation/content/builders/troubleshooting.md
diff --git a/documentation/content/userguide/update.md b/documentation/content/builders/update.md
similarity index 100%
rename from documentation/content/userguide/update.md
rename to documentation/content/builders/update.md
diff --git a/documentation/content/developers/coreapps.md b/documentation/content/developers/coreapps.md
index 757af2ae4..be15f133a 100644
--- a/documentation/content/developers/coreapps.md
+++ b/documentation/content/developers/coreapps.md
@@ -13,14 +13,14 @@ $ ./run_app_name.py -h
This is the main app and starts the Jukebox Core.
-Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../userguide/configuration.md#jukebox-configuration).
+Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../builders/configuration.md#jukebox-configuration).
-For debugging, it is usually desirable to run the Jukebox directly from the console rather than as service. This gives direct logging info in the console and allows changing command line parameters. See [Troubleshooting](../userguide/troubleshooting.md).
+For debugging, it is usually desirable to run the Jukebox directly from the console rather than as service. This gives direct logging info in the console and allows changing command line parameters. See [Troubleshooting](../builders/troubleshooting.md).
## Configuration Tools
Before running the configuration tools, stop the Jukebox Core service.
-See [Best practice procedure](../userguide/configuration.md#best-practice-procedure).
+See [Best practice procedure](../builders/configuration.md#best-practice-procedure).
### `run_configure_audio.py`
@@ -28,7 +28,7 @@ Setup tool to register the PulseAudio sinks as primary and secondary audio outpu
Will also setup equalizer and mono down mixer in the pulseaudio config file.
-Run this once after installation. Can be re-run at any time to change the settings. For more information see [Audio Configuration](../userguide/audio.md).
+Run this once after installation. Can be re-run at any time to change the settings. For more information see [Audio Configuration](../builders/audio.md).
### `run_register_rfid_reader.py`
diff --git a/documentation/content/developers/development-environment.md b/documentation/content/developers/development-environment.md
index 62eaeaec6..d79a6101e 100644
--- a/documentation/content/developers/development-environment.md
+++ b/documentation/content/developers/development-environment.md
@@ -16,7 +16,7 @@ developing.
1. Install the latest Pi OS on a SD card.
2. Boot up your Raspberry Pi.
-3. [Install](../userguide/installation.md) the Jukebox software as if you were building a
+3. [Install](../builders/installation.md) the Jukebox software as if you were building a
Phoniebox. You can install from your own fork and feature branch if
you wish which can be changed later as well. The original repository
will be set as `upstream`.
diff --git a/documentation/content/developers/rfid/basics.md b/documentation/content/developers/rfid/basics.md
index 5cd1d1e9f..ec8844263 100644
--- a/documentation/content/developers/rfid/basics.md
+++ b/documentation/content/developers/rfid/basics.md
@@ -6,7 +6,7 @@ Cards placed on the reader trigger an action. An action may be any
callable plugin function through the RPC with any arguments. Typically,
this would be "play some folder", but can also be "activate shutdown
timer", or "increase volume". This is configured in the
-[Card Database](../../userguide/card-database.md).
+[Card Database](../../builders/card-database.md).
You may configure a single or even multiple parallel readers (of
different or identical types).
@@ -79,7 +79,7 @@ For place-capable RFID readers enable dual action mode: a start action (e.g. pla
#### card_removal_action: Dictionary
-Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../userguide/rpc-commands.md).
+Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../builders/rpc-commands.md).
> [!NOTE]
> Developer's note: The reason for a unique removal action for all cards is that card triggering and card removal are happening in two separate threads. Removal needs to be in a time-out thread. Thus, we would need to transport information from one thread to another. This can be done of course but is not implemented (yet). Ignoring card removal is much easier and works for now.
diff --git a/documentation/content/developers/rfid/mock_reader.md b/documentation/content/developers/rfid/mock_reader.md
index da90d5405..ece44f653 100644
--- a/documentation/content/developers/rfid/mock_reader.md
+++ b/documentation/content/developers/rfid/mock_reader.md
@@ -6,7 +6,7 @@ machine - probably in a Python virtual environment.
**place-capable**: yes
-If you [mock the GPIO pins](../userguide/gpio.md), this GUI will show the GPIO devices.
+If you [mock the GPIO pins](../builders/gpio.md), this GUI will show the GPIO devices.
diff --git a/documentation/content/developers/status.md b/documentation/content/developers/status.md
index 3cc8d7f47..50968293c 100644
--- a/documentation/content/developers/status.md
+++ b/documentation/content/developers/status.md
@@ -183,7 +183,7 @@ Topics marked _in progress_ are already in the process of implementation by comm
### GPIO
-- [x] All done! Read the docs at [GPIO Recipes](#userguide/gpioz:GPIO Recipes)!
+- [x] All done! Read the docs at [GPIO Recipes](#builders/gpioz:GPIO Recipes)!
- [ ] USB Buttons: It's a different category as it works similar to the RFID cards (in progress)
### WLAN
From 94aa9dc6231a5d42337ade19fccf9885984af0e1 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Sat, 25 Nov 2023 00:14:29 +0100
Subject: [PATCH 023/121] Future3/update docs (#2123)
* Update pulseaudio link for docker mac setup
* Update Docker docs
---
documentation/content/developers/docker.md | 112 ++++++++++-----------
1 file changed, 54 insertions(+), 58 deletions(-)
diff --git a/documentation/content/developers/docker.md b/documentation/content/developers/docker.md
index 0def11610..96b5a64b6 100644
--- a/documentation/content/developers/docker.md
+++ b/documentation/content/developers/docker.md
@@ -14,16 +14,8 @@ need to adapt some of those commands to your needs.
## Prerequisites
-1. Install required software
- * Linux
- * [Docker](https://docs.docker.com/engine/install/debian/)
- * [Compose](https://docs.docker.com/compose/install/)
- * Mac
- * [Docker & Compose (Mac)](https://docs.docker.com/docker-for-mac/install/)
- * [pulseaudio (Docker)](https://devops.datenkollektiv.de/running-a-docker-soundbox-on-mac.html)
- * Windows
- * [Docker & Compose (Windows)](https://docs.docker.com/docker-for-windows/install/)
- * [pulseaudio (Windows)](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/)
+1. Install required software: Docker, Compose and pulseaudio
+ * Check installations guide for [Mac](#mac), [Windows](#windows) or [Linux](#linux)
2. Pull the Jukebox repository:
@@ -52,47 +44,10 @@ practice to isolate different components in different Docker images.
They can be run individually or in combination. To do that, we use
`docker-compose`.
-### Linux
-
-Make sure you don\'t use `sudo` to run your `docker-compose`. Check out
-Docker\'s [post-installation guide](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
-
-```bash
-// Build Images
-$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml build
-
-// Run Docker Environment
-$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml up
-
-// Shuts down Docker containers and Docker network
-$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml down
-```
-
-Note: if you have `mpd` running on your system, you need to stop it
-using:
-
-``` bash
-$ sudo systemctl stop mpd.socket
-$ sudo mpd --kill
-```
-
-Otherwise you might get the error message:
-
-``` bash
-$ docker-compose -f docker-compose.yml -f docker-compose.linux.yml up
-Starting mpd ...
-Starting mpd ... error
-(...)
-Error starting userland proxy: listen tcp4 0.0.0.0:6600: bind: address already in use
-```
-
-Read these threads for details: [thread 1](https://unix.stackexchange.com/questions/456909/socket-already-in-use-but-is-not-listed-mpd) and [thread 2](https://stackoverflow.com/questions/5106674/error-address-already-in-use-while-binding-socket-with-address-but-the-port-num/5106755#5106755)
-
### Mac
-Remember, pulseaudio is a prerequisite. [Follow these
-instructions](https://stackoverflow.com/a/50939994/1062438) for Mac
-hosts.
+1. [Install Docker & Compose (Mac)](https://docs.docker.com/docker-for-mac/install/)
+2. [Install pulseaudio](https://gist.github.com/seongyongkim/b7d630a03e74c7ab1c6b53473b592712) (Other references: [[1]](https://devops.datenkollektiv.de/running-a-docker-soundbox-on-mac.html), [[2]](https://stackoverflow.com/a/50939994/1062438))
``` bash
// Build Images
@@ -107,31 +62,32 @@ $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml d
### Windows
-1. Download
- [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/)
+1. Install [Docker & Compose (Windows)](https://docs.docker.com/docker-for-windows/install/)
+
+2. Download [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/)
-2. Uncompress somewhere in your user folder
+3. Uncompress somewhere in your user folder
-3. Edit `$INSTALL_DIR/etc/pulse/default.pa`
+4. Edit `$INSTALL_DIR/etc/pulse/default.pa`
-4. Add the following line
+5. Add the following line
``` bash
load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1
```
-5. Edit `$INSTALL_DIR/etc/pulse//etc/pulse/daemon.conf`, find the
+6. Edit `$INSTALL_DIR/etc/pulse//etc/pulse/daemon.conf`, find the
following line and change it to:
``` bash
exit-idle-time = -1
```
-6. Execute `$INSTALL_DIR/bin/pulseaudio.exe`
+7. Execute `$INSTALL_DIR/bin/pulseaudio.exe`
-7. Make sure Docker is running (e.g. start Docker Desktop)
+8. Make sure Docker is running (e.g. start Docker Desktop)
-8. Run `docker-compose`
+9. Run `docker-compose`
``` bash
// Build Images
@@ -144,6 +100,46 @@ $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml d
$ docker-compose -f docker/docker-compose.yml down
```
+### Linux
+
+1. Install Docker & Compose
+ * [Docker](https://docs.docker.com/engine/install/debian/)
+ * [Compose](https://docs.docker.com/compose/install/)
+2. Make sure you don\'t use `sudo` to run your `docker-compose`. Check out
+Docker\'s [post-installation guide](https://docs.docker.com/engine/install/linux-postinstall/) for more information.
+
+```bash
+// Build Images
+$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml build
+
+// Run Docker Environment
+$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml up
+
+// Shuts down Docker containers and Docker network
+$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml down
+```
+
+Note: if you have `mpd` running on your system, you need to stop it
+using:
+
+``` bash
+$ sudo systemctl stop mpd.socket
+$ sudo mpd --kill
+```
+
+Otherwise you might get the error message:
+
+``` bash
+$ docker-compose -f docker-compose.yml -f docker-compose.linux.yml up
+Starting mpd ...
+Starting mpd ... error
+(...)
+Error starting userland proxy: listen tcp4 0.0.0.0:6600: bind: address already in use
+```
+
+Read these threads for details: [thread 1](https://unix.stackexchange.com/questions/456909/socket-already-in-use-but-is-not-listed-mpd) and [thread 2](https://stackoverflow.com/questions/5106674/error-address-already-in-use-while-binding-socket-with-address-but-the-port-num/5106755#5106755)
+
+
## Test & Develop
The Dockerfile is defined to start all Phoniebox related services.
From 924c7f3a4db584d26d45e188b44209e0f053d320 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Sat, 25 Nov 2023 19:46:42 +0100
Subject: [PATCH 024/121] Remove content folder from docs (#2124)
---
documentation/README.md | 12 ++++++------
documentation/{content => }/builders/README.md | 0
documentation/{content => }/builders/audio.md | 0
documentation/{content => }/builders/autohotspot.md | 0
.../builders/bluetooth-audio-buttons.md | 0
.../{content => }/builders/card-database.md | 0
documentation/{content => }/builders/concepts.md | 0
.../{content => }/builders/configuration.md | 0
.../{content => }/builders/installation.md | 0
documentation/{content => }/builders/mock_gpio.png | Bin
documentation/{content => }/builders/rfid.md | 0
documentation/{content => }/builders/system.md | 0
.../{content => }/builders/troubleshooting.md | 0
documentation/{content => }/builders/update.md | 0
.../calendars/2019-Phoniebox-Calendar.jpg | Bin
.../calendars/2020-Phoniebox-Calendar.jpg | Bin
.../calendars/2021-Phoniebox-Calendar.jpg | Bin
documentation/{content => }/developers/README.md | 2 +-
documentation/{content => }/developers/coreapps.md | 0
.../{content => }/developers/developer-issues.md | 0
.../developers/development-environment.md | 0
documentation/{content => }/developers/docker.md | 0
.../{content => }/developers/known-issues.md | 0
.../{content => }/developers/rfid/README.md | 0
.../{content => }/developers/rfid/basics.md | 0
.../{content => }/developers/rfid/genericusb.md | 0
.../{content => }/developers/rfid/mfrc522_spi.md | 0
.../{content => }/developers/rfid/mock_reader.md | 0
.../{content => }/developers/rfid/mock_reader.png | Bin
.../{content => }/developers/rfid/pn532_i2c.md | 0
.../{content => }/developers/rfid/rdm6300.md | 0
.../developers/rfid/template_reader.md | 0
documentation/{content => }/developers/status.md | 0
33 files changed, 7 insertions(+), 7 deletions(-)
rename documentation/{content => }/builders/README.md (100%)
rename documentation/{content => }/builders/audio.md (100%)
rename documentation/{content => }/builders/autohotspot.md (100%)
rename documentation/{content => }/builders/bluetooth-audio-buttons.md (100%)
rename documentation/{content => }/builders/card-database.md (100%)
rename documentation/{content => }/builders/concepts.md (100%)
rename documentation/{content => }/builders/configuration.md (100%)
rename documentation/{content => }/builders/installation.md (100%)
rename documentation/{content => }/builders/mock_gpio.png (100%)
rename documentation/{content => }/builders/rfid.md (100%)
rename documentation/{content => }/builders/system.md (100%)
rename documentation/{content => }/builders/troubleshooting.md (100%)
rename documentation/{content => }/builders/update.md (100%)
rename documentation/{content => }/calendars/2019-Phoniebox-Calendar.jpg (100%)
rename documentation/{content => }/calendars/2020-Phoniebox-Calendar.jpg (100%)
rename documentation/{content => }/calendars/2021-Phoniebox-Calendar.jpg (100%)
rename documentation/{content => }/developers/README.md (93%)
rename documentation/{content => }/developers/coreapps.md (100%)
rename documentation/{content => }/developers/developer-issues.md (100%)
rename documentation/{content => }/developers/development-environment.md (100%)
rename documentation/{content => }/developers/docker.md (100%)
rename documentation/{content => }/developers/known-issues.md (100%)
rename documentation/{content => }/developers/rfid/README.md (100%)
rename documentation/{content => }/developers/rfid/basics.md (100%)
rename documentation/{content => }/developers/rfid/genericusb.md (100%)
rename documentation/{content => }/developers/rfid/mfrc522_spi.md (100%)
rename documentation/{content => }/developers/rfid/mock_reader.md (100%)
rename documentation/{content => }/developers/rfid/mock_reader.png (100%)
rename documentation/{content => }/developers/rfid/pn532_i2c.md (100%)
rename documentation/{content => }/developers/rfid/rdm6300.md (100%)
rename documentation/{content => }/developers/rfid/template_reader.md (100%)
rename documentation/{content => }/developers/status.md (100%)
diff --git a/documentation/README.md b/documentation/README.md
index 087b57ad8..d15d6c599 100644
--- a/documentation/README.md
+++ b/documentation/README.md
@@ -11,13 +11,13 @@ project check out the [documentation of Version 2](https://github.com/MiczFlor/R
## Quickstart
* For Builders: Building a Phoniebox
- * [Installing Phoniebox future3](./content/builders/installation.md)
- * [Builder Guides](./content/builders/README.md)
- * [Update](./content/builders/update.md)
+ * [Installing Phoniebox future3](./builders/installation.md)
+ * [Builder Guides](./builders/README.md)
+ * [Update](./builders/update.md)
* For Developers: Add features or fix bugs
- * [Developer Reference](./content/developers/README.md)
- * [Feature Status](./content/developers/status.md)
- * [Known Issues](./content/developers/known-issues.md)
+ * [Developer Guides](./developers/README.md)
+ * [Feature Status](./developers/status.md)
+ * [Known Issues](./developers/known-issues.md)
## future3
diff --git a/documentation/content/builders/README.md b/documentation/builders/README.md
similarity index 100%
rename from documentation/content/builders/README.md
rename to documentation/builders/README.md
diff --git a/documentation/content/builders/audio.md b/documentation/builders/audio.md
similarity index 100%
rename from documentation/content/builders/audio.md
rename to documentation/builders/audio.md
diff --git a/documentation/content/builders/autohotspot.md b/documentation/builders/autohotspot.md
similarity index 100%
rename from documentation/content/builders/autohotspot.md
rename to documentation/builders/autohotspot.md
diff --git a/documentation/content/builders/bluetooth-audio-buttons.md b/documentation/builders/bluetooth-audio-buttons.md
similarity index 100%
rename from documentation/content/builders/bluetooth-audio-buttons.md
rename to documentation/builders/bluetooth-audio-buttons.md
diff --git a/documentation/content/builders/card-database.md b/documentation/builders/card-database.md
similarity index 100%
rename from documentation/content/builders/card-database.md
rename to documentation/builders/card-database.md
diff --git a/documentation/content/builders/concepts.md b/documentation/builders/concepts.md
similarity index 100%
rename from documentation/content/builders/concepts.md
rename to documentation/builders/concepts.md
diff --git a/documentation/content/builders/configuration.md b/documentation/builders/configuration.md
similarity index 100%
rename from documentation/content/builders/configuration.md
rename to documentation/builders/configuration.md
diff --git a/documentation/content/builders/installation.md b/documentation/builders/installation.md
similarity index 100%
rename from documentation/content/builders/installation.md
rename to documentation/builders/installation.md
diff --git a/documentation/content/builders/mock_gpio.png b/documentation/builders/mock_gpio.png
similarity index 100%
rename from documentation/content/builders/mock_gpio.png
rename to documentation/builders/mock_gpio.png
diff --git a/documentation/content/builders/rfid.md b/documentation/builders/rfid.md
similarity index 100%
rename from documentation/content/builders/rfid.md
rename to documentation/builders/rfid.md
diff --git a/documentation/content/builders/system.md b/documentation/builders/system.md
similarity index 100%
rename from documentation/content/builders/system.md
rename to documentation/builders/system.md
diff --git a/documentation/content/builders/troubleshooting.md b/documentation/builders/troubleshooting.md
similarity index 100%
rename from documentation/content/builders/troubleshooting.md
rename to documentation/builders/troubleshooting.md
diff --git a/documentation/content/builders/update.md b/documentation/builders/update.md
similarity index 100%
rename from documentation/content/builders/update.md
rename to documentation/builders/update.md
diff --git a/documentation/content/calendars/2019-Phoniebox-Calendar.jpg b/documentation/calendars/2019-Phoniebox-Calendar.jpg
similarity index 100%
rename from documentation/content/calendars/2019-Phoniebox-Calendar.jpg
rename to documentation/calendars/2019-Phoniebox-Calendar.jpg
diff --git a/documentation/content/calendars/2020-Phoniebox-Calendar.jpg b/documentation/calendars/2020-Phoniebox-Calendar.jpg
similarity index 100%
rename from documentation/content/calendars/2020-Phoniebox-Calendar.jpg
rename to documentation/calendars/2020-Phoniebox-Calendar.jpg
diff --git a/documentation/content/calendars/2021-Phoniebox-Calendar.jpg b/documentation/calendars/2021-Phoniebox-Calendar.jpg
similarity index 100%
rename from documentation/content/calendars/2021-Phoniebox-Calendar.jpg
rename to documentation/calendars/2021-Phoniebox-Calendar.jpg
diff --git a/documentation/content/developers/README.md b/documentation/developers/README.md
similarity index 93%
rename from documentation/content/developers/README.md
rename to documentation/developers/README.md
index a2cb94c42..9136c5f31 100644
--- a/documentation/content/developers/README.md
+++ b/documentation/developers/README.md
@@ -1,4 +1,4 @@
-# Developers
+# Developer Guides
## Getting started
diff --git a/documentation/content/developers/coreapps.md b/documentation/developers/coreapps.md
similarity index 100%
rename from documentation/content/developers/coreapps.md
rename to documentation/developers/coreapps.md
diff --git a/documentation/content/developers/developer-issues.md b/documentation/developers/developer-issues.md
similarity index 100%
rename from documentation/content/developers/developer-issues.md
rename to documentation/developers/developer-issues.md
diff --git a/documentation/content/developers/development-environment.md b/documentation/developers/development-environment.md
similarity index 100%
rename from documentation/content/developers/development-environment.md
rename to documentation/developers/development-environment.md
diff --git a/documentation/content/developers/docker.md b/documentation/developers/docker.md
similarity index 100%
rename from documentation/content/developers/docker.md
rename to documentation/developers/docker.md
diff --git a/documentation/content/developers/known-issues.md b/documentation/developers/known-issues.md
similarity index 100%
rename from documentation/content/developers/known-issues.md
rename to documentation/developers/known-issues.md
diff --git a/documentation/content/developers/rfid/README.md b/documentation/developers/rfid/README.md
similarity index 100%
rename from documentation/content/developers/rfid/README.md
rename to documentation/developers/rfid/README.md
diff --git a/documentation/content/developers/rfid/basics.md b/documentation/developers/rfid/basics.md
similarity index 100%
rename from documentation/content/developers/rfid/basics.md
rename to documentation/developers/rfid/basics.md
diff --git a/documentation/content/developers/rfid/genericusb.md b/documentation/developers/rfid/genericusb.md
similarity index 100%
rename from documentation/content/developers/rfid/genericusb.md
rename to documentation/developers/rfid/genericusb.md
diff --git a/documentation/content/developers/rfid/mfrc522_spi.md b/documentation/developers/rfid/mfrc522_spi.md
similarity index 100%
rename from documentation/content/developers/rfid/mfrc522_spi.md
rename to documentation/developers/rfid/mfrc522_spi.md
diff --git a/documentation/content/developers/rfid/mock_reader.md b/documentation/developers/rfid/mock_reader.md
similarity index 100%
rename from documentation/content/developers/rfid/mock_reader.md
rename to documentation/developers/rfid/mock_reader.md
diff --git a/documentation/content/developers/rfid/mock_reader.png b/documentation/developers/rfid/mock_reader.png
similarity index 100%
rename from documentation/content/developers/rfid/mock_reader.png
rename to documentation/developers/rfid/mock_reader.png
diff --git a/documentation/content/developers/rfid/pn532_i2c.md b/documentation/developers/rfid/pn532_i2c.md
similarity index 100%
rename from documentation/content/developers/rfid/pn532_i2c.md
rename to documentation/developers/rfid/pn532_i2c.md
diff --git a/documentation/content/developers/rfid/rdm6300.md b/documentation/developers/rfid/rdm6300.md
similarity index 100%
rename from documentation/content/developers/rfid/rdm6300.md
rename to documentation/developers/rfid/rdm6300.md
diff --git a/documentation/content/developers/rfid/template_reader.md b/documentation/developers/rfid/template_reader.md
similarity index 100%
rename from documentation/content/developers/rfid/template_reader.md
rename to documentation/developers/rfid/template_reader.md
diff --git a/documentation/content/developers/status.md b/documentation/developers/status.md
similarity index 100%
rename from documentation/content/developers/status.md
rename to documentation/developers/status.md
From 12f4f92e15c26b719f702d8af49342d92b31867b Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Sat, 25 Nov 2023 23:36:44 +0100
Subject: [PATCH 025/121] Future3/documentation (#2127)
* fixed typo
* restored "rpc-commands"
* fixed broken links
* switched placed for leading documentation
* added docu for changing swap size
* unified links to source
---
documentation/README.md | 2 +-
documentation/builders/README.md | 2 +-
documentation/builders/audio.md | 2 +-
documentation/builders/card-database.md | 2 +-
documentation/builders/concepts.md | 6 +-
documentation/builders/configuration.md | 2 +-
documentation/builders/rpc-commands.md | 112 ++++++++++++++++++
documentation/developers/coreapps.md | 13 +-
documentation/developers/developer-issues.md | 12 ++
documentation/developers/rfid/basics.md | 2 +-
documentation/developers/rfid/genericusb.md | 2 +-
documentation/developers/rfid/mock_reader.md | 2 +-
.../developers/rfid/template_reader.md | 42 ++++++-
.../rfid/hardware/fake_reader_gui/README.md | 2 +-
.../rfid/hardware/generic_usb/README.md | 2 +-
.../rfid/hardware/pn532_i2c_py532/README.md | 2 +-
.../rfid/hardware/rc522_spi/README.md | 2 +-
.../rfid/hardware/rdm6300_serial/README.md | 2 +-
.../hardware/template_new_reader/README.md | 41 +------
19 files changed, 193 insertions(+), 59 deletions(-)
create mode 100644 documentation/builders/rpc-commands.md
diff --git a/documentation/README.md b/documentation/README.md
index d15d6c599..71ef9010f 100644
--- a/documentation/README.md
+++ b/documentation/README.md
@@ -6,7 +6,7 @@ The exciting, new Version 3 of the RPi Jukebox RFID. A complete rewrite of the J
> This documentation applies to the Version 3 which is developed in the branches `future3/main` and `future3/develop`. Currently the default Version is 2.x
To find out more about the RPi Jukebox RFID
-project check out the [documentation of Version 2](https://github.com/MiczFlor/RPi-Jukebox-RFID) or [www.phoniebox.de](https://www.phoniebox.de/).
+project check out the [documentation of Version 2](https://github.com/MiczFlor/RPi-Jukebox-RFID) or [www.phoniebox.de](https://phoniebox.de/).
## Quickstart
diff --git a/documentation/builders/README.md b/documentation/builders/README.md
index 22128308f..3d70bca15 100644
--- a/documentation/builders/README.md
+++ b/documentation/builders/README.md
@@ -21,4 +21,4 @@
* [System](./system.md)
* [Feature Status](../developers/status.md)
* [Known Issues](../developers/known-issues.md)
-* [Developer Reference](../developers)
+* [Developer Reference](../developers/README.md)
diff --git a/documentation/builders/audio.md b/documentation/builders/audio.md
index d4b06b481..07d24e40f 100644
--- a/documentation/builders/audio.md
+++ b/documentation/builders/audio.md
@@ -99,7 +99,7 @@ Rerun the config tool to register the Bluetooth device with the Jukebox core app
For other audio configuration options, please look at the `jukebox.yaml` for now.
-Directly edit `jukebox.yaml` following the steps: [Best practice procedure](configuraton.md#best-practice-procedure).
+Directly edit `jukebox.yaml` following the steps: [Best practice procedure](configuration.md#best-practice-procedure).
## Developer Information
diff --git a/documentation/builders/card-database.md b/documentation/builders/card-database.md
index 99c213571..67dbf5dae 100644
--- a/documentation/builders/card-database.md
+++ b/documentation/builders/card-database.md
@@ -4,7 +4,7 @@ In the card database, an RPC command is assigned to every card.
This RPC command is called every time when the card is swiped (or
placed) on the reader. Every RPC callable function can be called. See
-[RPC Commands](builders/rpc_commands.md) for an introduction.
+[RPC Commands](rpc-commands.md) for an introduction.
The card database is stored in `shared\settings\cards.yaml`. Here are
some examples for RPC command assignments to cards \'0001\' to \'0003\'
diff --git a/documentation/builders/concepts.md b/documentation/builders/concepts.md
index 70f285973..c08a33caa 100644
--- a/documentation/builders/concepts.md
+++ b/documentation/builders/concepts.md
@@ -16,12 +16,10 @@ The Remote Procedure Call (RPC) server allows remotely triggering actions (e.g.,
Why should you care? Because we use the same protocol when triggering actions from other inputs like a card swipe, a GPIO button press, etc. How that works is described in [RPC Commands](rpc-commands.md).
-You will find a full list of RPC callable functions in [RPC Command Reference](rpc-command-reference.md) and aliases for convenience in [RPC Command Alias Reference](rpc-command-alias-reference.md).
-
-We also have a tool to send RPC commands to the running Jukebox application: [run_rpc_tool.py](../../../src/jukebox/run_rpc_tool.py).
+We also have a tool to send RPC commands to the running Jukebox application: [run_rpc_tool.py](../developers/coreapps.md#run_rpc_toolpy)
## Publishing Message Queue
The Publishing Message Queue is the complementary part to the RPC where the core application publishes its status and status updates. As a user, you need not worry about it.
-If you want to interact with the Jukebox from your own application, this is where you get the current state from. Details about the protocol can be found here (TBD). A sniffer tool exists which listens and prints the incoming status messages: [run_publicity_sniffer.py](../../../src/jukebox/run_rpc_tool.py).
+If you want to interact with the Jukebox from your own application, this is where you get the current state from. Details about the protocol can be found here (TBD). A sniffer tool exists which listens and prints the incoming status messages: [run_publicity_sniffer.py](../developers/coreapps.md#run_publicity_snifferpy).
diff --git a/documentation/builders/configuration.md b/documentation/builders/configuration.md
index 2aaa3184b..e0240ddbe 100644
--- a/documentation/builders/configuration.md
+++ b/documentation/builders/configuration.md
@@ -10,7 +10,7 @@ Don't fear (overly), they contain commentaries.
For several aspects we have :ref:`developer/coreapps:Configuration Tools` and detailed guides:
* [Audio Configuration](./audio.md#audio-configuration)
-* [RFID Reader Configuration](./rfid/basics.md#reader-configuration)
+* [RFID Reader Configuration](../developers/rfid/basics.md#reader-configuration)
Even after running the tools, certain aspects can only be changed by modifying the configuration files directly.
diff --git a/documentation/builders/rpc-commands.md b/documentation/builders/rpc-commands.md
new file mode 100644
index 000000000..f578ccd99
--- /dev/null
+++ b/documentation/builders/rpc-commands.md
@@ -0,0 +1,112 @@
+# RPC Commands
+
+
+We use the RPC commands when triggering actions from different inputs like a card swipe,
+a GPIO button press, etc. Triggering an action is equal to sending an RPC function call.
+In many places the command to send when an input is triggered is configurable in a YAML-file.
+
+## Basics
+
+Consequently, you need to know how to specify the RPC command in the YAML file.
+Here is the essence of what you need to know:
+
+An RPC command consists of up to three parts
+
+ #. the function to execute (e.g. play_folder, change_volume)
+ #. the positional arguments (optional)
+ #. the keyword arguments (optional)
+
+The function specification consists of two (e.g., ``host.shutdown``) or three terms (e.g., ``volume.ctrl.change_volume``).
+In configuration files, this will look like this:
+
+.. code-block:: yaml
+
+ package: host
+ plugin: shutdown
+
+Or like this for a three part function with the argument set to ``5``:
+
+.. code-block:: yaml
+
+ package: volume
+ plugin: ctrl
+ method: change_volume
+ args: [5]
+
+The keyword ``method`` is optional. If needs to be used depends on the function you want to call.
+
+## Aliases
+
+
+Not so complicated, right? It will get even easier. For common commands we have defined aliases. An alias simply maps
+to a pre-defined RPC command, e.g. ``play_card`` maps to ``player.ctrl.play_card``.
+
+Instead of
+
+.. code-block:: yaml
+
+ package: player
+ plugin: ctrl
+ method: play_card
+ args: [path/to/folder]
+
+you can simply specify instead :
+
+.. code-block:: yaml
+
+ alias: play_card
+ args: [path/to/folder]
+
+Using in alias is optional. But if the keyword is present in the configuration it takes precedence over an explicit
+specified RPC command.
+
+## Arguments
+
+Arguments can be specified in similar fashion to Python function arguments: as positional arguments and / or
+keyword arguments. Let's check out play_card, which is defined as:
+
+.. py:function:: play_card(...) -> player.ctrl.play_card(folder: str, recursive: bool = False)
+ :noindex:
+
+ :param folder: Folder path relative to music library path
+ :param recursive: Add folder recursively
+
+This means it takes two arguments:
+
+ * folder of type string
+ * recursive of type bool
+
+In the following examples, we will always use the alias for smaller configuration text. All three examples
+do exactly the same, but use different ways of specifying the command.
+
+.. code-block:: yaml
+
+ alias: play_card
+ args: [path/to/folder, True]
+
+.. code-block:: yaml
+
+ alias: play_card
+ args: [path/to/folder]
+ kwargs:
+ recursive: True
+
+.. code-block:: yaml
+
+ alias: play_card
+ kwargs:
+ folder: path/to/folder
+ recursive: True
+
+
+.. important:: *args* must be a **list** of arguments to be passed! Even if only a single argument is passed.
+ So, use *args: [value]*. We try catch mis-uses but that might not always work.
+
+
+You will find some more examples the configuration of the [Card Database](card-database.md)
+
+## For developers
+
+To send RPC commands for testing and debugging purpose you can use the CLI Tool [`run_rpc_tool.py`](../developers/coreapps.md#run_rpc_toolpy)
+Also here is a ready-to-use decoding functions which decodes an RPC command (with or without alias)
+from a YAML entry:func:`jukebox.utils.decode_rpc_command`.
diff --git a/documentation/developers/coreapps.md b/documentation/developers/coreapps.md
index be15f133a..2fa8b84e9 100644
--- a/documentation/developers/coreapps.md
+++ b/documentation/developers/coreapps.md
@@ -11,6 +11,8 @@ $ ./run_app_name.py -h
### `run_jukebox.py`
+[run_jukebox.py](../../src/jukebox/run_jukebox.py)
+
This is the main app and starts the Jukebox Core.
Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../builders/configuration.md#jukebox-configuration).
@@ -24,6 +26,8 @@ See [Best practice procedure](../builders/configuration.md#best-practice-procedu
### `run_configure_audio.py`
+[run_configure_audio.py](../../src/jukebox/run_configure_audio.py)
+
Setup tool to register the PulseAudio sinks as primary and secondary audio outputs.
Will also setup equalizer and mono down mixer in the pulseaudio config file.
@@ -32,6 +36,8 @@ Run this once after installation. Can be re-run at any time to change the settin
### `run_register_rfid_reader.py`
+[run_register_rfid_reader.py](../../src/jukebox/run_register_rfid_reader.py)
+
Setup tool to configure the RFID Readers.
Run this once to register and configure the RFID readers with the Jukebox. Can be re-run at any time to change the settings. For more information see [RFID Readers](./rfid/README.md).
@@ -43,7 +49,9 @@ Run this once to register and configure the RFID readers with the Jukebox. Can b
### `run_rpc_tool.py`
-Command Line Interface to the Jukebox RPC Server
+[run_rpc_tool.py](../../src/jukebox/run_rpc_tool.py)
+
+Command Line Interface to the Jukebox RPC Server.
A command line tool for sending RPC commands to the running jukebox app. This uses the same interface as the WebUI. Can be used for additional control or for debugging.
@@ -51,6 +59,9 @@ The tool features auto-completion and command history.
The list of available commands is fetched from the running Jukebox service.
+
### `run_publicity_sniffer.py`
+ [run_publicity_sniffer.py](../../src/jukebox/run_publicity_sniffer.py)
+
A command line tool that monitors all messages being sent out from the Jukebox via the publishing interface. Received messages are printed in the console. Mainly used for debugging.
diff --git a/documentation/developers/developer-issues.md b/documentation/developers/developer-issues.md
index 4b1bd4794..1ed531738 100644
--- a/documentation/developers/developer-issues.md
+++ b/documentation/developers/developer-issues.md
@@ -49,6 +49,18 @@ Alternatively, use the provided script, which sets the variable for you
$ ./run_rebuild.sh
```
+**Changing Swap Size**
+
+This will set the swapsize to 1024 MB (and will deactivate swapfactor). Change accordingly if you have a SD Card with small capacity.
+
+```
+sudo dphys-swapfile swapoff
+sudo sed -i "s|.*CONF_SWAPSIZE=.*|CONF_SWAPSIZE=1024|g" /etc/dphys-swapfile
+sudo sed -i "s|^\s*CONF_SWAPFACTOR=|#CONF_SWAPFACTOR=|g" /etc/dphys-swapfile
+sudo dphys-swapfile setup
+sudo dphys-swapfile swapon
+```
+
### Process exited too early // kill -9
``` {.bash emphasize-lines="8,9"}
diff --git a/documentation/developers/rfid/basics.md b/documentation/developers/rfid/basics.md
index ec8844263..7a5aa37d9 100644
--- a/documentation/developers/rfid/basics.md
+++ b/documentation/developers/rfid/basics.md
@@ -79,7 +79,7 @@ For place-capable RFID readers enable dual action mode: a start action (e.g. pla
#### card_removal_action: Dictionary
-Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../builders/rpc-commands.md).
+Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../../builders/rpc-commands.md).
> [!NOTE]
> Developer's note: The reason for a unique removal action for all cards is that card triggering and card removal are happening in two separate threads. Removal needs to be in a time-out thread. Thus, we would need to transport information from one thread to another. This can be done of course but is not implemented (yet). Ignoring card removal is much easier and works for now.
diff --git a/documentation/developers/rfid/genericusb.md b/documentation/developers/rfid/genericusb.md
index a9a6565b5..23975cf14 100644
--- a/documentation/developers/rfid/genericusb.md
+++ b/documentation/developers/rfid/genericusb.md
@@ -4,7 +4,7 @@
This module covers all types of USB-based RFID input readers. If you
plan to connect multiple USB-based RFID readers to the Jukebox, make
-sure to connect all of them before running the registration tool [run_register_rfid_reader.py](../coreapps.md).
+sure to connect all of them before running the registration tool [run_register_rfid_reader.py](../coreapps.md#run_register_rfid_readerpy).
> [!NOTE]
> The user needs to be part of the group \'input\' for evdev to work. This should usually be the case. However, a user can be added with:
diff --git a/documentation/developers/rfid/mock_reader.md b/documentation/developers/rfid/mock_reader.md
index ece44f653..5daee0ab5 100644
--- a/documentation/developers/rfid/mock_reader.md
+++ b/documentation/developers/rfid/mock_reader.md
@@ -6,7 +6,7 @@ machine - probably in a Python virtual environment.
**place-capable**: yes
-If you [mock the GPIO pins](../builders/gpio.md), this GUI will show the GPIO devices.
+If you [mock the GPIO pins](../../../src/jukebox/components/gpio/gpioz/README.rst#use-mock-pins), this GUI will show the GPIO devices.
diff --git a/documentation/developers/rfid/template_reader.md b/documentation/developers/rfid/template_reader.md
index 48275d619..0f4c3e939 100644
--- a/documentation/developers/rfid/template_reader.md
+++ b/documentation/developers/rfid/template_reader.md
@@ -1,2 +1,42 @@
-For documentation see [src/jukebox/components/rfid/hardware/template_new_reader/README.md](../../../../src/jukebox/components/rfid/hardware/template_new_reader/README.md).
+# Template Reader
+
+*Template for creating and integrating a new RFID Reader*
+
+> [!NOTE]
+> For developers only
+
+This template provides the skeleton API for a new Reader. If you follow
+the conventions outlined below, your new reader will be picked up
+automatically There is no extra need to register the reader module with
+the Phoniebox. Just re-run `the reader config tool `.
+
+Follow the instructions in [template_new_reader.py]
+
+Also have a look at the other reader subpackages to see how stuff works
+with an example
+
+## File structure
+
+Your new reader is a python subpackage with these three mandatory files
+
+``` bash
+components/rfid/hardware/awesome_reader/
+ +- awesome_reader.py <-- The actual reader module
+ +- description.py <-- A description module w/o dependencies. Do not change the filename!
+ +- README.rst <-- The Readme
+```
+
+The module documentation must go into a separate file, called README.ME.
+
+## Conventions
+
+- Single reader per directory / subpackage
+- reader module directory name and reader module file name must be
+ identical
+- Obviously awesome_reader will be replaced with something more
+ descriptive. The naming scheme for the subpackage is
+ - \\_\\_\
+ - e.g. generic_usb/generic_usb.py
+ - e.g. pn532_spi/pn532_spi.py
+ - ...
diff --git a/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md b/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md
index 9ba73355a..6144ac1f5 100644
--- a/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md
+++ b/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md
@@ -1,2 +1,2 @@
-For documentation see [documentation/content/developers/rfid/mock_reader.md](../../../../../../documentation/content/developers/rfid/mock_reader.md).
+For documentation see [documentation/developers/rfid/mock_reader.md](../../../../../../documentation/developers/rfid/mock_reader.md).
diff --git a/src/jukebox/components/rfid/hardware/generic_usb/README.md b/src/jukebox/components/rfid/hardware/generic_usb/README.md
index e82e9005b..cf61d5822 100644
--- a/src/jukebox/components/rfid/hardware/generic_usb/README.md
+++ b/src/jukebox/components/rfid/hardware/generic_usb/README.md
@@ -1,2 +1,2 @@
-For documentation see [documentation/content/developers/rfid/genericusb.md](../../../../../../documentation/content/developers/rfid/genericusb.md).
+For documentation see [documentation/developers/rfid/genericusb.md](../../../../../../documentation/developers/rfid/genericusb.md).
diff --git a/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md b/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md
index d92a17c37..6a342e1d6 100644
--- a/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md
+++ b/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md
@@ -1,2 +1,2 @@
-For documentation see [documentation/content/developers/rfid/pn532_i2c.md](../../../../../../documentation/content/developers/rfid/pn532_i2c.md).
+For documentation see [documentation/developers/rfid/pn532_i2c.md](../../../../../../documentation/developers/rfid/pn532_i2c.md).
diff --git a/src/jukebox/components/rfid/hardware/rc522_spi/README.md b/src/jukebox/components/rfid/hardware/rc522_spi/README.md
index a78a7a890..8fcbb38a8 100644
--- a/src/jukebox/components/rfid/hardware/rc522_spi/README.md
+++ b/src/jukebox/components/rfid/hardware/rc522_spi/README.md
@@ -1,2 +1,2 @@
-For documentation see [documentation/content/developers/rfid/mfrc522_spi.md](../../../../../../documentation/content/developers/rfid/mfrc522_spi.md).
+For documentation see [documentation/developers/rfid/mfrc522_spi.md](../../../../../../documentation/developers/rfid/mfrc522_spi.md).
diff --git a/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md b/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md
index 895c24bbf..9f0f39fad 100644
--- a/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md
+++ b/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md
@@ -1,2 +1,2 @@
-For documentation see [documentation/content/developers/rfid/rdm6300.md](../../../../../../documentation/content/developers/rfid/rdm6300.md).
+For documentation see [documentation/developers/rfid/rdm6300.md](../../../../../../documentation/developers/rfid/rdm6300.md).
diff --git a/src/jukebox/components/rfid/hardware/template_new_reader/README.md b/src/jukebox/components/rfid/hardware/template_new_reader/README.md
index 77f3008c2..2ff93198c 100644
--- a/src/jukebox/components/rfid/hardware/template_new_reader/README.md
+++ b/src/jukebox/components/rfid/hardware/template_new_reader/README.md
@@ -1,41 +1,2 @@
-# Template Reader
-*Template for creating and integrating a new RFID Reader*
-
-> [!NOTE]
-> For developers only
-
-This template provides the skeleton API for a new Reader. If you follow
-the conventions outlined below, your new reader will be picked up
-automatically There is no extra need to register the reader module with
-the Phoniebox. Just re-run `the reader config tool `.
-
-Follow the instructions in [template_new_reader.py]
-
-Also have a look at the other reader subpackages to see how stuff works
-with an example
-
-## File structure
-
-Your new reader is a python subpackage with these three mandatory files
-
-``` bash
-components/rfid/hardware/awesome_reader/
- +- awesome_reader.py <-- The actual reader module
- +- description.py <-- A description module w/o dependencies. Do not change the filename!
- +- README.rst <-- The Readme
-```
-
-The module documentation must go into a separate file, called README.ME.
-
-## Conventions
-
-- Single reader per directory / subpackage
-- reader module directory name and reader module file name must be
- identical
-- Obviously awesome_reader will be replaced with something more
- descriptive. The naming scheme for the subpackage is
- - \\_\\_\
- - e.g. generic_usb/generic_usb.py
- - e.g. pn532_spi/pn532_spi.py
- - ...
+For documentation see [documentation/developers/rfid/template_reader.md](../../../../../../documentation/developers/rfid/template_reader.md).
From c0d5a20f5bb521d09a0b0d910fc2b83dcca79e61 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Sat, 25 Nov 2023 23:48:28 +0100
Subject: [PATCH 026/121] future3 V3.3 - reference webapp build (#2126)
---
installation/routines/setup_jukebox_webapp.sh | 2 +-
src/jukebox/jukebox/version.py | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index a0e195622..54be3119c 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# Constants
-GD_ID_COMPILED_WEBAPP="1EE_1MdneGtKL5V7GyYZC0nb6ODQWTsPb" # https://drive.google.com/file/d/1EE_1MdneGtKL5V7GyYZC0nb6ODQWTsPb/view?usp=sharing
+GD_ID_COMPILED_WEBAPP="1um-smyfsVPzVZn18hhwuFt97XR3PjAbB" # https://drive.google.com/file/d/1um-smyfsVPzVZn18hhwuFt97XR3PjAbB/view?usp=sharing
# For ARMv7+
NODE_MAJOR=20
diff --git a/src/jukebox/jukebox/version.py b/src/jukebox/jukebox/version.py
index ff86e01fc..de575e0b4 100644
--- a/src/jukebox/jukebox/version.py
+++ b/src/jukebox/jukebox/version.py
@@ -1,7 +1,7 @@
VERSION_MAJOR = 3
-VERSION_MINOR = 2
-VERSION_PATCH = 1
+VERSION_MINOR = 3
+VERSION_PATCH = 0
VERSION_EXTRA = ""
__version__ = '%i.%i.%i' % (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
From 234cc3c883951b822343c517a392c60e499cbc90 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Sat, 2 Dec 2023 17:32:53 +0100
Subject: [PATCH 027/121] Add installation checks + CI Workflow (#2119)
* add ci workflow
* add check for user home
* changes for docker tests
* added verify functions
* exit on failed update
* add check for samba setup
* add check for mpd setup
* add check for jukebox core setup
* add check for git setup
* add check for kiosk mode setup
* add check for optimize boot setup
* add check for webapp setup
* add check for autohotspot setup
* make rfid reader setup an optional step
* Add Option for No Rfid Reader
* moved setup checks to individual scripts
* fix missing iw package
* refactored get_reader_descriptions into function.
be more consistent by using same var for display and index access
* moved function to specific routine script
* make sure verify parameters are all set.
fix functionnames
* added fix for not available interface in CI runs
* check supported os type first
* moved exit_on_error function top level
* moved logging setup to function and added usage
* moved load sources to function
* change function name and var usage
* updated log output for better logfile readability
* harmonize log output
* refactored disable onboard audio.
only execute if flag is true. inlined function
* add restart nginx.service again. use HOME_PATH
* fix and check adding samba user
* fix logging mpd setup routine
* fix Disable boot logs error on existing file
* added timer to log frame
* add core package installation from file
used also for ci optimization
* Dont let remove packages fail install.
ignore for ci
* Update test scripts
use robust path determination
move noninteractive to dockerfile
* fix clear in mpd option
* fix bug in rfid configure
* fix error on uninitialized rfid_reader settings
* add checks for static ip config
* Added test for webapp download in prod.
Update test descriptions.
* renamend workflow files
to not interfere with develop branch
* Update install links
---
.dockerignore | 1 -
.../test_docker_debian_codename_sub_v3.yml | 183 ++++++++++++
.github/workflows/test_docker_debian_v3.yml | 31 +++
README.md | 6 +-
ci/ci-debian.Dockerfile | 100 +++++++
ci/installation/run_install_common.sh | 43 +++
ci/installation/run_install_faststartup.sh | 39 +++
ci/installation/run_install_user_not_pi.sh | 25 ++
.../run_install_webapp_download.sh | 41 +++
ci/installation/run_install_webapp_local.sh | 42 +++
installation/README.md | 8 +-
installation/includes/00_constants.sh | 4 +
installation/includes/01_default_config.sh | 2 +
installation/includes/02_helpers.sh | 261 ++++++++++++++++--
installation/includes/04_cleanup.sh | 8 +-
installation/includes/05_finish.sh | 25 +-
installation/install-jukebox.sh | 141 +++++++---
installation/routines/customize_options.sh | 74 ++++-
installation/routines/install.sh | 15 +-
installation/routines/optimize_boot_time.sh | 135 ++++++---
installation/routines/set_raspi_config.sh | 26 +-
installation/routines/set_ssh_qos.sh | 12 +-
installation/routines/setup_autohotspot.sh | 76 +++--
installation/routines/setup_git.sh | 32 ++-
installation/routines/setup_jukebox_core.sh | 80 ++++--
installation/routines/setup_jukebox_webapp.sh | 59 ++--
installation/routines/setup_kiosk_mode.sh | 59 +++-
installation/routines/setup_mpd.sh | 77 +++---
installation/routines/setup_rfid_reader.sh | 12 +-
installation/routines/setup_samba.sh | 48 +++-
installation/routines/update_raspi_os.sh | 15 +-
packages-core.txt | 17 ++
requirements.txt | 3 +-
.../components/rfid/configure/__init__.py | 78 ++++--
.../components/rfid/reader/__init__.py | 24 +-
35 files changed, 1439 insertions(+), 363 deletions(-)
create mode 100644 .github/workflows/test_docker_debian_codename_sub_v3.yml
create mode 100644 .github/workflows/test_docker_debian_v3.yml
create mode 100644 ci/ci-debian.Dockerfile
create mode 100644 ci/installation/run_install_common.sh
create mode 100644 ci/installation/run_install_faststartup.sh
create mode 100644 ci/installation/run_install_user_not_pi.sh
create mode 100644 ci/installation/run_install_webapp_download.sh
create mode 100644 ci/installation/run_install_webapp_local.sh
create mode 100644 packages-core.txt
diff --git a/.dockerignore b/.dockerignore
index 55fe62a70..a587de477 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -7,7 +7,6 @@
# Application
docker
docs
-installation
shared
# webapp
diff --git a/.github/workflows/test_docker_debian_codename_sub_v3.yml b/.github/workflows/test_docker_debian_codename_sub_v3.yml
new file mode 100644
index 000000000..54abd142a
--- /dev/null
+++ b/.github/workflows/test_docker_debian_codename_sub_v3.yml
@@ -0,0 +1,183 @@
+name: Subworkflow Test Install Scripts Debian V3
+
+on:
+ workflow_call:
+ inputs:
+ debian_codename:
+ required: true
+ type: string
+ docker_image_name:
+ required: false
+ type: string
+ default: rpi-jukebox-rfid-v3
+ platform:
+ required: false
+ type: string
+ default: linux/arm/v7
+ cache_scope:
+ required: false
+ type: string
+ default: ${{ github.ref }}-test-debian-v3
+ local_registry_port:
+ required: false
+ type: number
+ default: 5000
+ runs_on:
+ required: false
+ type: string
+ default: ubuntu-latest
+
+# let only one instance run the test so cache is not corrupted.
+# cancel already running instances as only the last run will be relevant
+concurrency:
+ group: ${{ inputs.cache_scope }}-${{ inputs.debian_codename }}
+ cancel-in-progress: true
+
+jobs:
+
+ # Build container for test execution
+ build:
+ runs-on: ${{ inputs.runs_on }}
+
+ outputs:
+ cache_key: ${{ steps.vars.outputs.cache_key }}
+ image_file_name: ${{ steps.vars.outputs.image_file_name }}
+ image_tag_name: ${{ steps.vars.outputs.image_tag_name }}
+
+ # create local docker registry to use locally build images
+ services:
+ registry:
+ image: registry:2
+ ports:
+ - ${{ inputs.local_registry_port }}:5000
+
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v3.0.0
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3.0.0
+ with:
+ # network=host driver-opt needed to push to local registry
+ driver-opts: network=host
+
+ - name: Set Output pre-vars
+ id: pre-vars
+ env:
+ DEBIAN_CODENAME: ${{ inputs.debian_codename }}
+ DOCKER_IMAGE_NAME: ${{ inputs.docker_image_name }}
+ CACHE_SCOPE: ${{ inputs.cache_scope }}
+ run: |
+ echo "image_tag_name=${{ env.DOCKER_IMAGE_NAME }}:${{ env.DEBIAN_CODENAME }}-test" >> $GITHUB_OUTPUT
+ echo "image_file_name=${{ env.DOCKER_IMAGE_NAME }}-${{ env.DEBIAN_CODENAME }}.tar" >> $GITHUB_OUTPUT
+ echo "cache_scope=${{ env.CACHE_SCOPE }}-${{ env.DEBIAN_CODENAME }}" >> $GITHUB_OUTPUT
+
+ - name: Set Output vars
+ id: vars
+ env:
+ LOCAL_REGISTRY_PORT: ${{ inputs.local_registry_port }}
+ run: |
+ echo "image_tag_name=${{ steps.pre-vars.outputs.image_tag_name }}" >> $GITHUB_OUTPUT
+ echo "image_tag_name_local_base=localhost:${{ env.LOCAL_REGISTRY_PORT }}/${{ steps.pre-vars.outputs.image_tag_name }}-base" >> $GITHUB_OUTPUT
+ echo "image_file_name=${{ steps.pre-vars.outputs.image_file_name }}" >> $GITHUB_OUTPUT
+ echo "image_file_path=./${{ steps.pre-vars.outputs.image_file_name }}" >> $GITHUB_OUTPUT
+ echo "cache_scope=${{ steps.pre-vars.outputs.cache_scope }}" >> $GITHUB_OUTPUT
+ echo "cache_key=${{ steps.pre-vars.outputs.cache_scope }}-${{ github.sha }}#${{ github.run_attempt }}" >> $GITHUB_OUTPUT
+
+ # Build base image for debian version name. Layers will be cached and image pushes to local registry
+ - name: Build Image - Base
+ uses: docker/build-push-action@v5
+ with:
+ context: .
+ load: false
+ push: true
+ file: ./ci/ci-debian.Dockerfile
+ target: test-code
+ platforms: ${{ inputs.platform }}
+ tags: ${{ steps.vars.outputs.image_tag_name_local_base }}
+ cache-from: type=gha,scope=${{ steps.vars.outputs.cache_scope }}
+ cache-to: type=gha,mode=max,scope=${{ steps.vars.outputs.cache_scope }}
+ build-args: |
+ DEBIAN_CODENAME=${{ inputs.debian_codename }}
+ GIT_BRANCH=${{ github.head_ref || github.ref_name }}
+ GIT_USER=${{ github.event.pull_request.head.user.login || github.repository_owner }}
+
+ # Build new image with updates packages based on base image. Layers will NOT be chached. Result is written to file.
+ - name: Build Image - Update
+ uses: docker/build-push-action@v5
+ with:
+ context: .
+ load: false
+ push: false
+ file: ./ci/ci-debian.Dockerfile
+ target: test-update
+ platforms: ${{ inputs.platform }}
+ tags: ${{ steps.vars.outputs.image_tag_name }}
+ cache-from: type=gha,scope=${{ steps.vars.outputs.cache_scope }}
+ # DON'T use 'cache-to' here as the layer is then cached and this build would be useless
+ outputs: type=docker,dest=${{ steps.vars.outputs.image_file_path }}
+ build-args: |
+ BASE_TEST_IMAGE=${{ steps.vars.outputs.image_tag_name_local_base }}
+
+ - name: Artifact Upload Docker Image
+ uses: actions/upload-artifact@v3
+ with:
+ name: ${{ steps.vars.outputs.image_file_name }}
+ path: ${{ steps.vars.outputs.image_file_path }}
+ retention-days: 1
+
+
+ # Run tests with build image
+ test:
+ needs: [build]
+ runs-on: ${{ inputs.runs_on }}
+
+ strategy:
+ fail-fast: false
+ matrix:
+ username: ['pi']
+ test_script: ['run_install_common.sh', 'run_install_faststartup.sh', 'run_install_webapp_local.sh', 'run_install_webapp_download.sh']
+ include:
+ - username: hans
+ test_script: run_install_user_not_pi.sh
+
+ steps:
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v3.0.0
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3.0.0
+
+ - name: Artifact Download Docker Image
+ uses: actions/download-artifact@v3
+ with:
+ name: ${{ needs.build.outputs.image_file_name }}
+
+ - name: Load Docker Image
+ run: |
+ docker load --input ${{ needs.build.outputs.image_file_name }}
+
+ # Run test
+ - name: Run Test ${{ inputs.debian_codename }}-${{ matrix.username }}-${{ matrix.test_script }}
+ uses: tj-actions/docker-run@v2
+ with:
+ image: ${{ needs.build.outputs.image_tag_name }}
+ options: --platform ${{ inputs.platform }} --user ${{ matrix.username }} --init
+ name: ${{ matrix.test_script }}
+ args: |
+ ./${{ matrix.test_script }}
+
+ # cleanup after test execution
+ cleanup:
+ # run only if tests didn't fail: keep the artifact to make job reruns possible
+ if: ${{ !failure() }}
+ needs: [build, test]
+ runs-on: ${{ inputs.runs_on }}
+
+ steps:
+ - name: Artifact Delete Docker Image
+ uses: geekyeggo/delete-artifact@v2
+ with:
+ name: ${{ needs.build.outputs.image_file_name }}
diff --git a/.github/workflows/test_docker_debian_v3.yml b/.github/workflows/test_docker_debian_v3.yml
new file mode 100644
index 000000000..6cf1648aa
--- /dev/null
+++ b/.github/workflows/test_docker_debian_v3.yml
@@ -0,0 +1,31 @@
+name: Test Install Scripts Debian v3
+
+on:
+ schedule:
+ # run at 17:00 every sunday
+ - cron: '0 17 * * 0'
+ push:
+ pull_request:
+ # The branches below must be a subset of the branches above
+ branches: [ future3/develop ]
+
+# let only one instance run the test so cache is not corrupted.
+# cancel already running instances as only the last run will be relevant
+concurrency:
+ group: ${{ github.ref }}-test-debian-v3
+ cancel-in-progress: true
+
+jobs:
+
+ # Build container and run tests. Duplication of job intended for better visualization.
+ run_bookworm:
+ name: 'bookworm'
+ uses: ./.github/workflows/test_docker_debian_codename_sub_v3.yml
+ with:
+ debian_codename: 'bookworm'
+
+ run_bullseye:
+ name: 'bullseye'
+ uses: ./.github/workflows/test_docker_debian_codename_sub_v3.yml
+ with:
+ debian_codename: 'bullseye'
diff --git a/README.md b/README.md
index 8b494698d..3731c7e06 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,4 @@ The documentation can be found [here](./documentation/README.md)
## Installation?
-Run the following one-liner in a shell and follow the instructions
-
-~~~bash
-cd; bash <(wget -qO- https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/future3/develop/installation/install-jukebox.sh)
-~~~
+[Install Phoniebox software](documentation/builders/installation.md#install-phoniebox-software)
diff --git a/ci/ci-debian.Dockerfile b/ci/ci-debian.Dockerfile
new file mode 100644
index 000000000..1a227755a
--- /dev/null
+++ b/ci/ci-debian.Dockerfile
@@ -0,0 +1,100 @@
+# Base Target to build and install all needed base configuration and packages. Specifie the needed platform with the docker '--platform XXX' option
+ARG DEBIAN_CODENAME=bookworm
+ARG BASE_TEST_IMAGE=test-code
+FROM debian:${DEBIAN_CODENAME}-slim as base
+ARG DEBIAN_CODENAME
+
+ENV TERM=xterm DEBIAN_FRONTEND=noninteractive
+ENV CI_RUNNING=true
+
+# create pi configs to test installation
+RUN touch /boot/config.txt
+RUN echo "logo.nologo" > /boot/cmdline.txt
+
+RUN echo "--- install packages (1) ---" \
+ && apt-get update \
+ && apt-get -y install \
+ apt-utils \
+ curl \
+ gnupg \
+ && echo "--- add sources ---" \
+ && curl -fsSL http://raspbian.raspberrypi.org/raspbian.public.key | gpg --dearmor > /usr/share/keyrings/raspberrypi-raspbian-keyring.gpg \
+ && curl -fsSL http://archive.raspberrypi.org/debian/raspberrypi.gpg.key | gpg --dearmor > /usr/share/keyrings/raspberrypi-archive-debian-keyring.gpg \
+ && echo "deb [signed-by=/usr/share/keyrings/raspberrypi-raspbian-keyring.gpg] http://raspbian.raspberrypi.org/raspbian/ ${DEBIAN_CODENAME} main contrib non-free rpi" > /etc/apt/sources.list.d/raspi.list \
+ && echo "deb [signed-by=/usr/share/keyrings/raspberrypi-archive-debian-keyring.gpg] http://archive.raspberrypi.org/debian/ ${DEBIAN_CODENAME} main" >> /etc/apt/sources.list.d/raspi.list \
+ && echo "--- install packages (2) ---" \
+ && apt-get update \
+ && apt-get -y upgrade \
+ && apt-get -y install \
+ build-essential \
+ iproute2 \
+ openssh-client \
+ sudo \
+ systemd \
+ wireless-tools \
+ wget \
+ wpasupplicant \
+ && rm -rf /var/lib/apt/lists/*
+
+# Set NonInteractive for sudo usage in container. 'sudo' package needed
+RUN echo 'debconf debconf/frontend select Noninteractive' | sudo debconf-set-selections
+# ------
+
+# Base Target for setting up the default user. user can be selected with the docker '--user YYY' option
+FROM base as user
+ARG USER_NAME=pi
+ARG USER_GROUP=$USER_NAME
+ARG USER_ID=1000
+
+ENV TEST_USER_GROUP=test
+RUN groupadd --gid 1002 $TEST_USER_GROUP
+
+RUN groupadd --gid 1000 $USER_GROUP \
+ && useradd -u $USER_ID -g $USER_GROUP -G sudo,$TEST_USER_GROUP -d /home/$USER_NAME -m -s /bin/bash -p '$1$iV7TOwOe$6ojkJQXyEA9bHd/SqNLNj0' $USER_NAME \
+ && echo "$USER_NAME ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/$USER_NAME
+
+ENV XDG_RUNTIME_DIR=/run/user/$USER_ID DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/$USER_ID/bus
+# ------
+
+
+# Target for setting up an alternativ user 'hans:wurst'. user can be selected with the docker '--user YYY' option
+FROM user as test-user
+
+RUN export USER_ALT=hans \
+ && export USER_ALT_GROUP=wurst \
+ && groupadd --gid 1001 $USER_ALT_GROUP \
+ && useradd -u 1001 -g $USER_ALT_GROUP -G sudo,$TEST_USER_GROUP -d /home/$USER_ALT -m -s /bin/bash -p '$1$iV7TOwOe$6ojkJQXyEA9bHd/SqNLNj0' $USER_ALT \
+ && echo "$USER_ALT ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/$USER_ALT
+# ------
+
+
+# Target for adding envs and scripts from the repo to test installation
+FROM test-user as test-code
+ARG GIT_BRANCH
+ARG GIT_USER
+
+ENV GIT_BRANCH=$GIT_BRANCH GIT_USER=$GIT_USER
+
+COPY --chown=root:$TEST_USER_GROUP --chmod=770 packages-core.txt ./
+
+RUN echo "--- install internal packages ---" \
+ && apt-get update \
+ && sed 's/#.*//g' packages-core.txt | xargs apt-get -y install \
+ && rm -rf /var/lib/apt/lists/*
+
+ENV INSTALL_SCRIPT_PATH=/code
+
+WORKDIR ${INSTALL_SCRIPT_PATH}
+COPY --chown=root:$TEST_USER_GROUP --chmod=770 installation/install-jukebox.sh ./
+
+WORKDIR ${INSTALL_SCRIPT_PATH}/tests
+COPY --chown=root:$TEST_USER_GROUP --chmod=770 ci/installation/*.sh ./
+# ------
+
+
+# Target for applying latest updates (should not be cached!)
+FROM $BASE_TEST_IMAGE as test-update
+RUN apt-get update \
+ && apt-get -y upgrade \
+ && rm -rf /var/lib/apt/lists/*
+# ------
diff --git a/ci/installation/run_install_common.sh b/ci/installation/run_install_common.sh
new file mode 100644
index 000000000..102c71aa4
--- /dev/null
+++ b/ci/installation/run_install_common.sh
@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective:
+# Test for a common installation path. Including autohotspot
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+export ENABLE_WEBAPP_PROD_DOWNLOAD=true
+# Run installation (in interactive mode)
+# y - start setup
+# n - use static ip
+# n - deactivate ipv6
+# y - setup autohotspot
+# n - use custom password
+# n - deactivate bluetooth
+# n - disable on-chip audio
+# - - mpd overwrite config (only with existing installation)
+# n - setup rfid reader
+# y - setup samba
+# y - setup webapp
+# n - setup kiosk mode
+# - - install node (forced WebApp Download)
+# n - reboot
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
+n
+n
+y
+n
+n
+n
+n
+y
+y
+n
+n
+'
diff --git a/ci/installation/run_install_faststartup.sh b/ci/installation/run_install_faststartup.sh
new file mode 100644
index 000000000..46cda25ec
--- /dev/null
+++ b/ci/installation/run_install_faststartup.sh
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective:
+# Test for disabling features (suggestions for faststartup). Skips installing all additionals.
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+# Run installation (in interactive mode)
+# y - start setup
+# y - use static ip
+# y - deactivate ipv6
+# n - setup autohotspot
+# y - deactivate bluetooth
+# y - disable on-chip audio
+# - - mpd overwrite config (only with existing installation)
+# n - setup rfid reader
+# n - setup samba
+# n - setup webapp
+# - - setup kiosk mode (only with webapp = y)
+# - - install node (only with webapp = y)
+# n - reboot
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
+y
+y
+n
+y
+y
+n
+n
+n
+n
+'
diff --git a/ci/installation/run_install_user_not_pi.sh b/ci/installation/run_install_user_not_pi.sh
new file mode 100644
index 000000000..76a8cd576
--- /dev/null
+++ b/ci/installation/run_install_user_not_pi.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective: Test installation with script using a simple configuration
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+# Run installation (in interactive mode)
+# - - Installation must abort early
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh"
+INSTALLATION_EXITCODE=$?
+
+# only count abortion due to "not user pi" as success
+if [ "${INSTALLATION_EXITCODE}" -eq 2 ]; then
+ INSTALLATION_EXITCODE=0
+else
+ INSTALLATION_EXITCODE=1
+fi
+exit "${INSTALLATION_EXITCODE}"
diff --git a/ci/installation/run_install_webapp_download.sh b/ci/installation/run_install_webapp_download.sh
new file mode 100644
index 000000000..69496e8e4
--- /dev/null
+++ b/ci/installation/run_install_webapp_download.sh
@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective:
+# Test for the WebApp (download) and dependent features path.
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+export ENABLE_WEBAPP_PROD_DOWNLOAD=true
+# Run installation (in interactive mode)
+# y - start setup
+# n - use static ip
+# n - deactivate ipv6
+# n - setup autohotspot
+# n - deactivate bluetooth
+# n - disable on-chip audio
+# - - mpd overwrite config (only with existing installation)
+# n - setup rfid reader
+# n - setup samba
+# y - setup webapp
+# y - setup kiosk mode
+# - - install node (forced webapp download)
+# n - reboot
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
+n
+n
+n
+n
+n
+n
+n
+y
+y
+n
+'
diff --git a/ci/installation/run_install_webapp_local.sh b/ci/installation/run_install_webapp_local.sh
new file mode 100644
index 000000000..d4f122fd5
--- /dev/null
+++ b/ci/installation/run_install_webapp_local.sh
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective:
+# Test for the WebApp (build locally) and dependent features path.
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+export ENABLE_WEBAPP_PROD_DOWNLOAD=false
+# Run installation (in interactive mode)
+# y - start setup
+# n - use static ip
+# n - deactivate ipv6
+# n - setup autohotspot
+# n - deactivate bluetooth
+# n - disable on-chip audio
+# - - mpd overwrite config (only with existing installation)
+# n - setup rfid reader
+# n - setup samba
+# y - setup webapp
+# y - setup kiosk mode
+# y - install node
+# n - reboot
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
+n
+n
+n
+n
+n
+n
+n
+y
+y
+y
+n
+'
diff --git a/installation/README.md b/installation/README.md
index aff262bd8..b2a496348 100644
--- a/installation/README.md
+++ b/installation/README.md
@@ -11,10 +11,6 @@ No output to both console and logfile: "$ command > /dev/null"
[Learn more about bash script outputs](https://stackoverflow.com/questions/18460186/writing-outputs-to-log-file-and-console)
-## Quick Installation
+## Installation
-Note: Replace the branch in this command to be the one you like to install depending on your needs. Release branch is preset.
-
-```bash
-cd; bash <(wget -qO- https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/future3/main/installation/install-jukebox.sh)
-```
+[Install Phoniebox software](../documentation/builders/installation.md#install-phoniebox-software)
diff --git a/installation/includes/00_constants.sh b/installation/includes/00_constants.sh
index e19dd1327..380e1de2e 100644
--- a/installation/includes/00_constants.sh
+++ b/installation/includes/00_constants.sh
@@ -1,7 +1,11 @@
RPI_BOOT_CONFIG_FILE="/boot/config.txt"
+RPI_BOOT_CMDLINE_FILE="/boot/cmdline.txt"
SHARED_PATH="${INSTALLATION_PATH}/shared"
SETTINGS_PATH="${SHARED_PATH}/settings"
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"
# The default upstream user, release branch, and develop branch
# These are used to prepare the repo for developers
diff --git a/installation/includes/01_default_config.sh b/installation/includes/01_default_config.sh
index eb6e45a91..b2f37a1de 100644
--- a/installation/includes/01_default_config.sh
+++ b/installation/includes/01_default_config.sh
@@ -11,7 +11,9 @@ 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
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index 9ad8e71b8..4a39ae07e 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
-# Helpers
+### Helpers
# $1->start, $2->end
calc_runtime_and_print() {
@@ -9,7 +9,7 @@ calc_runtime_and_print() {
((m=(${runtime}%3600)/60))
((s=${runtime}%60))
- echo "Done in ${h}h ${m}m ${s}s."
+ echo "Done in ${h}h ${m}m ${s}s"
}
run_with_timer() {
@@ -18,7 +18,20 @@ run_with_timer() {
$1; # Executes the function passed as an argument
calc_runtime_and_print time_start $(date +%s) | tee /dev/fd/3
- echo "--------------------------------------"
+}
+
+run_with_log_frame() {
+ local time_start=$(date +%s);
+ local description="$2"
+ echo -e "\n\n"
+ echo "#########################################################"
+ echo "${description}" | tee /dev/fd/3
+
+ $1; # Executes the function passed as an argument
+
+ local done_in=$(calc_runtime_and_print time_start $(date +%s))
+ echo -e "\n${done_in} - ${description}"
+ echo "#########################################################"
}
_download_file_from_google_drive() {
@@ -28,31 +41,231 @@ _download_file_from_google_drive() {
echo "Downloaded from Google Drive ID ${GD_SHARING_ID} into ${TAR_FILENAME}"
}
-get_onboard_audio() {
- if grep -q -E "^dtparam=([^,]*,)*audio=(on|true|yes|1).*" ${RPI_BOOT_CONFIG_FILE}
- then
- echo 1
- else
- echo 0
- fi
+
+### Verify helpers
+
+print_verify_installation() {
+ echo ""
+ echo " -------------------------------------------------------"
+ echo " Check installation"
+ echo ""
+}
+
+# Check if the file(s) exists
+verify_files_exists() {
+ local files="$@"
+ echo " Verify '${files}' exists"
+
+ if [[ -z "${files}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ for file in $files
+ do
+ test ! -f ${file} && exit_on_error "ERROR: '${file}' does not exists or is not a file!"
+ done
+ echo " CHECK"
+}
+
+# Check if the dir(s) exists
+verify_dirs_exists() {
+ local dirs="$@"
+ echo " Verify '${dirs}' exists"
+
+ if [[ -z "${dirs}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ for dir in $dirs
+ do
+ test ! -d ${dir} && exit_on_error "ERROR: '${dir}' does not exists or is not a dir!"
+ done
+ echo " CHECK"
+}
+
+# Check if the file(s) has/have the expected owner and modifications
+verify_files_chmod_chown() {
+ local mod_expected=$1
+ local user_expected=$2
+ local group_expected=$3
+ local files="${@:4}"
+ echo " Verify '${mod_expected}' '${user_expected}:${group_expected}' is set for '${files}'"
+
+ if [[ -z "${mod_expected}" || -z "${user_expected}" || -z "${group_expected}" || -z "${files}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ for file in $files
+ do
+ test ! -f ${file} && exit_on_error "ERROR: '${file}' does not exists or is not a file!"
+
+ mod_actual=$(stat --format '%a' "${file}")
+ user_actual=$(stat -c '%U' "${file}")
+ group_actual=$(stat -c '%G' "${file}")
+ test ! "${mod_expected}" -eq "${mod_actual}" && exit_on_error "ERROR: '${file}' actual mod '${mod_actual}' differs from expected '${mod_expected}'!"
+ test ! "${user_expected}" == "${user_actual}" && exit_on_error "ERROR: '${file}' actual owner '${user_actual}' differs from expected '${user_expected}'!"
+ test ! "${group_expected}" == "${group_actual}" && exit_on_error "ERROR: '${file}' actual group '${group_actual}' differs from expected '${group_expected}'!"
+ done
+ echo " CHECK"
+}
+
+# Check if the dir(s) has/have the expected owner and modifications
+verify_dirs_chmod_chown() {
+ local mod_expected=$1
+ local user_expected=$2
+ local group_expected=$3
+ local dirs="${@:4}"
+ echo " Verify '${mod_expected}' '${user_expected}:${group_expected}' is set for '${dirs}'"
+
+ if [[ -z "${mod_expected}" || -z "${user_expected}" || -z "${group_expected}" || -z "${dirs}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ for dir in $dirs
+ do
+ test ! -d ${dir} && exit_on_error "ERROR: '${dir}' does not exists or is not a dir!"
+
+ mod_actual=$(stat --format '%a' "${dir}")
+ user_actual=$(stat -c '%U' "${dir}")
+ group_actual=$(stat -c '%G' "${dir}")
+ test ! "${mod_expected}" -eq "${mod_actual}" && exit_on_error "ERROR: '${dir}' actual mod '${mod_actual}' differs from expected '${mod_expected}'!"
+ test ! "${user_expected}" == "${user_actual}" && exit_on_error "ERROR: '${dir}' actual owner '${user_actual}' differs from expected '${user_expected}'!"
+ test ! "${group_expected}" == "${group_actual}" && exit_on_error "ERROR: '${dir}' actual group '${group_actual}' differs from expected '${group_expected}'!"
+ done
+ echo " CHECK"
+}
+
+verify_file_contains_string() {
+ local string="$1"
+ local file="$2"
+ echo " Verify '${string}' found in '${file}'"
+
+ if [[ -z "${string}" || -z "${file}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ if [[ ! $(grep -iw "${string}" "${file}") ]]; then
+ exit_on_error "ERROR: '${string}' not found in '${file}'"
+ fi
+ echo " CHECK"
+}
+
+verify_file_contains_string_once() {
+ local string="$1"
+ local file="$2"
+ echo " Verify '${string}' found in '${file}'"
+
+ if [[ -z "${string}" || -z "${file}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ local file_contains_string_count=$(grep -oiw "${string}" "${file}" | wc -l)
+ if [ "$file_contains_string_count" -lt 1 ]; then
+ exit_on_error "ERROR: '${string}' not found in '${file}'"
+ elif [ "$file_contains_string_count" -gt 1 ]; then
+ exit_on_error "ERROR: '${string}' found more than once in '${file}'"
+ fi
+ echo " CHECK"
+}
+
+verify_service_state() {
+ local service="$1"
+ local desired_state="$2"
+ local option="${3:+$3 }" # optional, dont't quote in next call!
+ echo " Verify service '${option}${service}' is '${desired_state}'"
+
+ if [[ -z "${service}" || -z "${desired_state}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ local actual_state=$(systemctl is-active ${option}${service})
+ if [[ ! "${actual_state}" == "${desired_state}" ]]; then
+ exit_on_error "ERROR: service '${option}${service}' is not '${desired_state}' (state: '${actual_state}')."
+ fi
+ echo " CHECK"
+}
+
+verify_service_enablement() {
+ local service="$1"
+ local desired_enablement="$2"
+ local option="${3:+$3 }" # optional, dont't quote in next call!
+ echo " Verify service ${option}${service} is ${desired_enablement}"
+
+ if [[ -z "${service}" || -z "${desired_enablement}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ local actual_enablement=$(systemctl is-enabled ${option}${service})
+ if [[ ! "${actual_enablement}" == "${desired_enablement}" ]]; then
+ exit_on_error "ERROR: service ${option}${service} is not ${desired_enablement} (state: ${actual_enablement})."
+ fi
+ echo " CHECK"
+}
+
+verify_optional_service_enablement() {
+ local service="$1"
+ local desired_enablement="$2"
+ local option="${3:+$3 }" # optional, dont't quote in next call!
+ echo " Verify service ${option}${service} is ${desired_enablement}"
+
+ if [[ -z "${service}" || -z "${desired_enablement}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+
+ local actual_enablement=$(systemctl is-enabled ${option}${service}) 2>/dev/null
+ if [[ -z "${actual_enablement}" ]]; then
+ echo " INFO: optional service ${option}${service} is not installed."
+ elif [[ "${actual_enablement}" == "static" ]]; then
+ echo " INFO: optional service ${option}${service} is set static."
+ elif [[ ! "${actual_enablement}" == "${desired_enablement}" ]]; then
+ exit_on_error "ERROR: service ${option}${service} is not ${desired_enablement} (state: ${actual_enablement})."
+ fi
+ echo " CHECK"
+}
+
+# Reads a textfile and returns all lines as args.
+# Does filter out comments, egg-prefixes and version suffixes
+# Arguments:
+# 1 : textfile to read
+get_args_from_file() {
+ local package_file="$1"
+ sed 's/.*#egg=//g' ${package_file} | sed -E 's/(#|=|>|<).*//g' | xargs echo
}
-check_os_type() {
- # Check if current distro is a 32 bit version
- # Support for 64 bit Distros has not been checked (or precisely: is known not to work)
- # All RaspianOS versions report as machine "armv6l" or "armv7l", if 32 bit (even the ARMv8 cores!)
+# Check if all passed packages are installed. Fail on first missing.
+verify_apt_packages() {
+ local packages="$@"
+ echo " Verify packages are installed: '${packages}'"
+
+ if [[ -z "${packages}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
- local os_type
- os_type=$(uname -m)
+ local apt_list_installed=$(apt -qq list --installed 2>/dev/null)
+ for package in ${packages}
+ do
+ if [[ ! $(echo "${apt_list_installed}" | grep -i "^${package}/.*installed") ]]; then
+ exit_on_error "ERROR: ${package} is not installed"
+ fi
+ done
+ echo " CHECK"
+}
- echo -e "\nChecking OS type '$os_type'" | tee /dev/fd/3
+# Check if all passed modules are installed. Fail on first missing.
+verify_pip_modules() {
+ local modules="$@"
+ echo " Verify modules are installed: '${modules}'"
- if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then
- echo -e " ... OK!\n" | tee /dev/fd/3
- else
- echo "ERROR: Only 32 bit operating systems supported. Please use a 32bit version of RaspianOS!" | tee /dev/fd/3
- echo "You can fix this problem for 64bit kernels: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041" | tee /dev/fd/3
- exit 1
- fi
+ if [[ -z "${modules}" ]]; then
+ exit_on_error "ERROR: at least one parameter value is missing!"
+ fi
+ local pip_list_installed=$(pip list 2>/dev/null)
+ for module in ${modules}
+ do
+ if [[ ! $(echo "${pip_list_installed}" | grep -i "^${module} ") ]]; then
+ exit_on_error "ERROR: ${module} is not installed"
+ fi
+ done
+ echo " CHECK"
}
diff --git a/installation/includes/04_cleanup.sh b/installation/includes/04_cleanup.sh
index fd714132f..d6e39266c 100644
--- a/installation/includes/04_cleanup.sh
+++ b/installation/includes/04_cleanup.sh
@@ -1,7 +1,9 @@
#!/usr/bin/env bash
-cleanup() {
- sudo rm -rf /var/lib/apt/lists/*
+_run_cleanup() {
+ sudo rm -rf /var/lib/apt/lists/*
+}
- echo "DONE: cleanup"
+cleanup() {
+ run_with_log_frame _run_cleanup "Cleanup"
}
diff --git a/installation/includes/05_finish.sh b/installation/includes/05_finish.sh
index 50c2f6d9d..55489ff46 100644
--- a/installation/includes/05_finish.sh
+++ b/installation/includes/05_finish.sh
@@ -14,8 +14,8 @@ Your SSH connection will disconnect.
After the reboot, you can access the WebApp in your browser at
http://${local_hostname}.local or http://${CURRENT_IP_ADDRESS}
Don't forget to upload files.
-
-Do you want to reboot now? [Y/n]" 1>&3
+" | tee /dev/fd/3
+echo "Do you want to reboot now? [Y/n]" 1>&3
read -r response
case "$response" in
@@ -31,24 +31,3 @@ Do you want to reboot now? [Y/n]" 1>&3
;;
esac
}
-
-# Generic emergency error handler that exits the script immediately
-# Print additional custom message if passed as first argument
-# Examples:
-# cd some-dir || exit_on_error
-# cd some-dir || exit_on_error "During installation of some"
-exit_on_error () {
-
- echo -e "\n****************************************" | tee /dev/fd/3
- echo "ERROR OCCURRED!
-A non-recoverable error occurred.
-Check install log for details:" | tee /dev/fd/3
- echo "$INSTALLATION_LOGFILE" | tee /dev/fd/3
- echo "****************************************" | tee /dev/fd/3
- if [[ -n $1 ]]; then
- echo "$1" | tee /dev/fd/3
- echo "****************************************" | tee /dev/fd/3
- fi
- echo "Abort!"
- exit 1
-}
diff --git a/installation/install-jukebox.sh b/installation/install-jukebox.sh
index 44b03fca0..b72dd32ff 100755
--- a/installation/install-jukebox.sh
+++ b/installation/install-jukebox.sh
@@ -20,17 +20,36 @@ GIT_URL="https://github.com/${GIT_USER}/${GIT_REPO_NAME}"
echo GIT_BRANCH $GIT_BRANCH
echo GIT_URL $GIT_URL
-CURRENT_USER="${SUDO_USER:-$USER}"
+CURRENT_USER="${SUDO_USER:-$(whoami)}"
+CURRENT_USER_GROUP=$(id -gn "$CURRENT_USER")
HOME_PATH=$(getent passwd "$CURRENT_USER" | cut -d: -f6)
echo "Current User: $CURRENT_USER"
echo "User home dir: $HOME_PATH"
INSTALLATION_PATH="${HOME_PATH}/${GIT_REPO_NAME}"
INSTALL_ID=$(date +%s)
+INSTALLATION_LOGFILE="${HOME_PATH}/INSTALL-${INSTALL_ID}.log"
+
+# Check if current distro is a 32 bit version
+# Support for 64 bit Distros has not been checked (or precisely: is known not to work)
+# All RaspianOS versions report as machine "armv6l" or "armv7l", if 32 bit (even the ARMv8 cores!)
+_check_os_type() {
+ local os_type=$(uname -m)
+
+ echo -e "\nChecking OS type '$os_type'"
+
+ if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then
+ echo -e " ... OK!\n"
+ else
+ echo "ERROR: Only 32 bit operating systems supported. Please use a 32bit version of RaspianOS!"
+ echo "You can fix this problem for 64bit kernels: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041"
+ exit 1
+ fi
+}
-checkPrerequisite() {
- #currently the user 'pi' is mandatory
- #https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/1785
+# currently the user 'pi' is mandatory
+# https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/1785
+_check_user() {
if [ "${CURRENT_USER}" != "pi" ]; then
echo
echo "ERROR: User must be 'pi'!"
@@ -46,52 +65,104 @@ checkPrerequisite() {
echo " Please check the wiki for further information"
exit 2
fi
+
+ if [ ! -d "${HOME_PATH}" ]; then
+ echo
+ echo "ERROR: HomeDir ${HOME_PATH} does not exist."
+ echo " Please create it and start again."
+ exit 2
+ fi
+}
+
+# Manipulate file descriptor for logging
+# Behavior:
+# Write To logfile:
+# default stdout will only write to logfile
+# default stderr will only write to logfile
+# e.g echo "write only to logfile"
+# Write To console (user window):
+# redirect to fd 3 will only write to the console
+# e.g. echo "write only to console" 1>&3
+# Write To both:
+# use tee to write output to logfile and console
+# e.g. echo "write to both" | tee /dev/fd/3
+_setup_logging(){
+ if [ "$CI_RUNNING" == "true" ]; then
+ exec 3>&1 2>&1
+ else
+ exec 3>&1 1>>"${INSTALLATION_LOGFILE}" 2>&1 || { echo "ERROR: Cannot create log file."; exit 1; }
+ fi
+ echo "Log start: ${INSTALL_ID}"
+}
+
+# Generic emergency error handler that exits the script immediately
+# Print additional custom message if passed as first argument
+# Examples:
+# a command || exit_on_error
+# a command || exit_on_error "Execution of command failed"
+exit_on_error () {
+ echo -e "\n****************************************" | tee /dev/fd/3
+ echo "ERROR OCCURRED!
+A non-recoverable error occurred.
+Check install log for details:" | tee /dev/fd/3
+ echo "$INSTALLATION_LOGFILE" | tee /dev/fd/3
+ echo "****************************************" | tee /dev/fd/3
+ if [[ -n $1 ]]; then
+ echo "$1" | tee /dev/fd/3
+ echo "****************************************" | tee /dev/fd/3
+ fi
+ echo "Abort!"
+ exit 1
}
-download_jukebox_source() {
+_download_jukebox_source() {
+ echo -e "\n\n"
+ echo "#########################################################"
+ echo "Downloading Phoniebox software from Github ..." 1>&3
+ echo "Download Source: ${GIT_URL}/${GIT_BRANCH}" | tee /dev/fd/3
+
+ cd "${HOME_PATH}" || exit_on_error "ERROR: Changing to home dir failed."
wget -qO- "${GIT_URL}/tarball/${GIT_BRANCH}" | tar xz
# Use case insensitive search/sed because user names in Git Hub are case insensitive
- GIT_REPO_DOWNLOAD=$(find . -maxdepth 1 -type d -iname "${GIT_USER}-${GIT_REPO_NAME}-*")
- echo "GIT REPO DOWNLOAD = $GIT_REPO_DOWNLOAD"
- GIT_HASH=$(echo "$GIT_REPO_DOWNLOAD" | sed -rn "s/.*${GIT_USER}-${GIT_REPO_NAME}-([0-9a-fA-F]+)/\1/ip")
+ local git_repo_download=$(find . -maxdepth 1 -type d -iname "${GIT_USER}-${GIT_REPO_NAME}-*")
+ echo "GIT REPO DOWNLOAD = $git_repo_download"
+ GIT_HASH=$(echo "$git_repo_download" | sed -rn "s/.*${GIT_USER}-${GIT_REPO_NAME}-([0-9a-fA-F]+)/\1/ip")
# Save the git hash for this particular download for later git repo initialization
echo "GIT HASH = $GIT_HASH"
- if [[ -z ${GIT_REPO_DOWNLOAD} ]]; then
- echo "ERROR in finding git download. Panic."
- exit 1
+ if [[ -z "${git_repo_download}" ]]; then
+ exit_on_error "ERROR: Couldn't find git download."
fi
- if [[ -z ${GIT_HASH} ]]; then
- echo "ERROR in determining git hash from download. Panic."
- exit 1
+ if [[ -z "${GIT_HASH}" ]]; then
+ exit_on_error "ERROR: Couldn't determine git hash from download."
fi
- mv "$GIT_REPO_DOWNLOAD" "$GIT_REPO_NAME"
- unset GIT_REPO_DOWNLOAD
+ mv "$git_repo_download" "$GIT_REPO_NAME"
+ echo -e "\nDONE: Downloading Phoniebox software from Github"
+ echo "#########################################################"
}
+_load_sources() {
+ # Load / Source dependencies
+ for i in "${INSTALLATION_PATH}"/installation/includes/*; do
+ source "$i"
+ done
-### CHECK PREREQUISITE
-checkPrerequisite
-
-### RUN INSTALLATION
-INSTALLATION_LOGFILE="${HOME_PATH}/INSTALL-${INSTALL_ID}.log"
-exec 3>&1 1>>"${INSTALLATION_LOGFILE}" 2>&1 || { echo "Cannot create log file. Panic."; exit 1; }
-echo "Log start: ${INSTALL_ID}"
+ for j in "${INSTALLATION_PATH}"/installation/routines/*; do
+ source "$j"
+ done
+}
-clear 1>&3
-echo "Downloading Phoniebox software from Github ..." 1>&3
-echo "Download Source: ${GIT_URL}/${GIT_BRANCH}" | tee /dev/fd/3
-download_jukebox_source
-cd "${INSTALLATION_PATH}" || { echo "ERROR in changing to install dir. Panic."; exit 1; }
+### CHECK PREREQUISITE
+_check_os_type
+_check_user
-# Load / Source dependencies
-for i in "${INSTALLATION_PATH}"/installation/includes/*; do
- source "$i"
-done
+### SETUP LOGGING
+_setup_logging
-for j in "${INSTALLATION_PATH}"/installation/routines/*; do
- source "$j"
-done
+### RUN INSTALLATION
+_download_jukebox_source
+cd "${INSTALLATION_PATH}" || exit_on_error "ERROR: Changing to install dir failed."
+_load_sources
welcome
run_with_timer install
diff --git a/installation/routines/customize_options.sh b/installation/routines/customize_options.sh
index d5ac7c547..50df075fe 100644
--- a/installation/routines/customize_options.sh
+++ b/installation/routines/customize_options.sh
@@ -118,6 +118,54 @@ Do you want to disable Bluetooth? [Y/n]" 1>&3
echo "DISABLE_BLUETOOTH=${DISABLE_BLUETOOTH}"
}
+_option_mpd() {
+ clear 1>&3
+ if [[ "$SETUP_MPD" == true ]]; then
+ if [[ -f "${MPD_CONF_PATH}" || -f "${SYSTEMD_USR_PATH}/mpd.service" ]]; then
+ echo "-------------------------- MPD --------------------------
+
+It seems there is a MPD already installed.
+Note: It is important that MPD runs as a user service!
+Would you like to overwrite your configuration? [Y/n]" 1>&3
+ read -r response
+ case "$response" in
+ [nN][oO]|[nN])
+ ENABLE_MPD_OVERWRITE_INSTALL=false
+ ;;
+ *)
+ ;;
+ esac
+ fi
+ fi
+
+ echo "SETUP_MPD=${SETUP_MPD}"
+ if [ "$SETUP_MPD" == true ]; then
+ echo "ENABLE_MPD_OVERWRITE_INSTALL=${ENABLE_MPD_OVERWRITE_INSTALL}"
+ fi
+}
+
+_option_rfid_reader() {
+ # ENABLE_RFID_READER
+ clear 1>&3
+ echo "---------------------- RFID READER ----------------------
+
+Phoniebox can be controlled with rfid cards/tags, if you
+have a rfid reader connected.
+Choose yes to setup a reader. You get prompted for
+the type selection and configuration later on.
+
+Do you want to setup a rfid reader? [Y/n]" 1>&3
+ read -r response
+ case "$response" in
+ [nN][oO]|[nN])
+ ENABLE_RFID_READER=false
+ ;;
+ *)
+ ;;
+ esac
+ echo "ENABLE_RFID_READER=${ENABLE_RFID_READER}"
+}
+
_option_samba() {
# ENABLE_SAMBA
clear 1>&3
@@ -133,7 +181,6 @@ Do you want to install Samba? [Y/n]" 1>&3
case "$response" in
[nN][oO]|[nN])
ENABLE_SAMBA=false
- ENABLE_KIOSK_MODE=false
;;
*)
;;
@@ -237,13 +284,13 @@ Disable Pi's on-chip audio (headphone / jack output)? [y/N]" 1>&3
_option_webapp_devel_build() {
# Let's detect if we are on the official release branch
- if [[ "$GIT_BRANCH" != "${GIT_BRANCH_RELEASE}" || "$GIT_USER" != "$GIT_UPSTREAM_USER" ]]; then
+ if [[ "$GIT_BRANCH" != "${GIT_BRANCH_RELEASE}" || "$GIT_USER" != "$GIT_UPSTREAM_USER" || "$CI_RUNNING" == "true" ]]; then
ENABLE_INSTALL_NODE=true
# Unless ENABLE_WEBAPP_PROD_DOWNLOAD is forced to true by user override, do not download a potentially stale build
- if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" = "release-only" ]]; then
+ if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" == "release-only" ]]; then
ENABLE_WEBAPP_PROD_DOWNLOAD=false
fi
- if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" = false ]]; then
+ if [[ "$ENABLE_WEBAPP_PROD_DOWNLOAD" == false ]]; then
clear 1>&3
echo "--------------------- WEBAPP NODE ---------------------
@@ -261,22 +308,23 @@ Do you want to install Node? [Y/n]" 1>&3
;;
esac
# This message will be displayed at the end of the installation process
- FIN_MESSAGE="$FIN_MESSAGE\nATTENTION: You need to build the web app locally with
- $ cd ~/RPi-Jukebox-RFID/src/webapp && ./run_rebuild.sh -u
- This must be done after reboot, due to memory restrictions.
- Read the documentation regarding local Web App builds!"
+ local tmp_fin_message="ATTENTION: You need to build the web app locally with
+ $ cd ~/RPi-Jukebox-RFID/src/webapp && ./run_rebuild.sh -u
+ This must be done after reboot, due to memory restrictions.
+ Read the documentation regarding local Web App builds!"
+ FIN_MESSAGE="${FIN_MESSAGE:+$FIN_MESSAGE\n}${tmp_fin_message}"
fi
fi
}
-customize_options() {
- echo "Customize Options starts"
-
+_run_customize_options() {
_option_ipv6
_option_static_ip
_option_autohotspot
_option_bluetooth
_option_disable_onboard_audio
+ _option_mpd
+ _option_rfid_reader
_option_samba
_option_webapp
if [[ $ENABLE_WEBAPP == true ]] ; then
@@ -286,6 +334,8 @@ customize_options() {
# Bullseye is currently under active development and should be updated in any case.
# Hence, removing the step below as it becomse mandatory
# _options_update_raspi_os
+}
- echo "Customize Options ends"
+customize_options() {
+ run_with_log_frame _run_customize_options "Customize Options"
}
diff --git a/installation/routines/install.sh b/installation/routines/install.sh
index ca25a17a3..d241658b6 100644
--- a/installation/routines/install.sh
+++ b/installation/routines/install.sh
@@ -1,19 +1,18 @@
install() {
- check_os_type
clear 1>&3
customize_options
clear 1>&3
set_raspi_config
- if [ "$DISABLE_SSH_QOS" = true ] ; then set_ssh_qos; fi;
- if [ "$UPDATE_RASPI_OS" = true ] ; then update_raspi_os; fi;
+ set_ssh_qos
+ update_raspi_os
init_git_repo_from_tardir
setup_jukebox_core
- if [ "$SETUP_MPD" = true ] ; then setup_mpd; fi;
- if [ "$ENABLE_SAMBA" = true ] ; then setup_samba; fi;
- if [ "$ENABLE_WEBAPP" = true ] ; then setup_jukebox_webapp; fi;
- if [ "$ENABLE_KIOSK_MODE" = true ] ; then setup_kiosk_mode; fi;
+ setup_mpd
+ setup_samba
+ setup_jukebox_webapp
+ setup_kiosk_mode
setup_rfid_reader
optimize_boot_time
- if [ "$ENABLE_AUTOHOTSPOT" = true ] ; then setup_autohotspot; fi;
+ setup_autohotspot
cleanup
}
diff --git a/installation/routines/optimize_boot_time.sh b/installation/routines/optimize_boot_time.sh
index 2fea66a86..383f790c0 100644
--- a/installation/routines/optimize_boot_time.sh
+++ b/installation/routines/optimize_boot_time.sh
@@ -2,18 +2,24 @@
# Reference: https://panther.software/configuration-code/raspberry-pi-3-4-faster-boot-time-in-few-easy-steps/
+OPTIMIZE_DHCP_CONF="/etc/dhcpcd.conf"
+OPTIMIZE_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"
+OPTIMIZE_DHCP_CONF_HEADER="## Jukebox DHCP Config"
+OPTIMIZE_IPV6_CONF_HEADER="## Jukebox IPV6 Config"
+OPTIMIZE_BOOT_CONF_HEADER="## Jukebox Boot Config"
+
_optimize_disable_irrelevant_services() {
- echo " * Disable keyboard-setup.service"
+ echo " Disable keyboard-setup.service"
sudo systemctl disable keyboard-setup.service
- echo " * Disable triggerhappy.service"
+ echo " Disable triggerhappy.service"
sudo systemctl disable triggerhappy.service
sudo systemctl disable triggerhappy.socket
- echo " * Disable raspi-config.service"
+ echo " Disable raspi-config.service"
sudo systemctl disable raspi-config.service
- echo " * Disable apt-daily.service & apt-daily-upgrade.service"
+ echo " Disable apt-daily.service & apt-daily-upgrade.service"
sudo systemctl disable apt-daily.service
sudo systemctl disable apt-daily-upgrade.service
sudo systemctl disable apt-daily.timer
@@ -23,30 +29,28 @@ _optimize_disable_irrelevant_services() {
# TODO: If false, actually make sure bluetooth is enabled
_optimize_handle_bluetooth() {
if [ "$DISABLE_BLUETOOTH" = true ] ; then
- echo " * Disable hciuart.service and bluetooth"
+ echo " Disable bluetooth" | tee /dev/fd/3
sudo systemctl disable hciuart.service
sudo systemctl disable bluetooth.service
fi
}
# TODO: Allow options to enable/disable wifi, Dynamic/Static IP etc.
-_optimize_handle_network_connection() {
+_optimize_static_ip() {
# Static IP Address and DHCP optimizations
- local DHCP_CONF="/etc/dhcpcd.conf"
-
if [ "$ENABLE_STATIC_IP" = true ] ; then
- echo " * Set static IP address" | tee /dev/fd/3
- if grep -q "## Jukebox DHCP Config" "$DHCP_CONF"; then
- echo " Skipping. Already set up!" | tee /dev/fd/3
+ echo " Set static IP address" | tee /dev/fd/3
+ if grep -q "${OPTIMIZE_DHCP_CONF_HEADER}" "$OPTIMIZE_DHCP_CONF"; then
+ echo " Skipping. Already set up!"
else
# DHCP has not been configured
- echo " * ${CURRENT_INTERFACE} is the default network interface" | tee /dev/fd/3
- echo " * ${CURRENT_GATEWAY} is the Router Gateway address" | tee /dev/fd/3
- echo " * Using ${CURRENT_IP_ADDRESS} as the static IP for now" | tee /dev/fd/3
+ echo " ${CURRENT_INTERFACE} is the default network interface"
+ echo " ${CURRENT_GATEWAY} is the Router Gateway address"
+ echo " Using ${CURRENT_IP_ADDRESS} as the static IP for now"
- sudo tee -a $DHCP_CONF <<-EOF
+ sudo tee -a $OPTIMIZE_DHCP_CONF <<-EOF
-## Jukebox DHCP Config
+${OPTIMIZE_DHCP_CONF_HEADER}
interface ${CURRENT_INTERFACE}
static ip_address=${CURRENT_IP_ADDRESS}/24
static routers=${CURRENT_GATEWAY}
@@ -55,59 +59,114 @@ static domain_name_servers=${CURRENT_GATEWAY}
EOF
fi
- else
- echo " * Skipped static IP address"
fi
}
# TODO: Allow both Enable and Disable
_optimize_ipv6_arp() {
if [ "$DISABLE_IPv6" = true ] ; then
- echo " * Disabling IPV6 and ARP"
- sudo tee -a $DHCP_CONF <<-EOF
+ echo " Disabling IPV6" | tee /dev/fd/3
+ if grep -q "${OPTIMIZE_IPV6_CONF_HEADER}" "$OPTIMIZE_DHCP_CONF"; then
+ echo " Skipping. Already set up!"
+ else
+ sudo tee -a $OPTIMIZE_DHCP_CONF <<-EOF
-## Jukebox boot speed-up settings
+${OPTIMIZE_IPV6_CONF_HEADER}
noarp
ipv4only
noipv6
EOF
-
+ fi
fi
}
# TODO: Allow both Enable and Disable
_optimize_handle_boot_screen() {
if [ "$DISABLE_BOOT_SCREEN" = true ] ; then
- echo " * Disable RPi rainbow screen"
- BOOT_CONFIG='/boot/config.txt'
- sudo tee -a $BOOT_CONFIG <<-EOF
+ echo " Disable RPi rainbow screen"
+ if grep -q "${OPTIMIZE_BOOT_CONF_HEADER}" "$RPI_BOOT_CONFIG_FILE"; then
+ echo " Skipping. Already set up!"
+ else
+ sudo tee -a $RPI_BOOT_CONFIG_FILE <<-EOF
-## Jukebox Settings
+${OPTIMIZE_BOOT_CONF_HEADER}
disable_splash=1
EOF
+ fi
fi
}
# TODO: Allow both Enable and Disable
_optimize_handle_boot_logs() {
if [ "$DISABLE_BOOT_LOGS_PRINT" = true ] ; then
- echo " * Disable boot logs"
- BOOT_CMDLINE='/boot/cmdline.txt'
- sudo sed -i "$ s/$/ consoleblank=1 logo.nologo quiet loglevel=0 plymouth.enable=0 vt.global_cursor_default=0 plymouth.ignore-serial-consoles splash fastboot noatime nodiratime noram/" $BOOT_CMDLINE
+ echo " Disable boot logs"
+
+ if [ ! -s "${RPI_BOOT_CMDLINE_FILE}" ];then
+ sudo tee "${RPI_BOOT_CMDLINE_FILE}" <<-EOF
+${OPTIMIZE_BOOT_CMDLINE_OPTIONS}
+EOF
+ else
+ for option in $OPTIMIZE_BOOT_CMDLINE_OPTIONS
+ do
+ if ! grep -qiw "$option" "${RPI_BOOT_CMDLINE_FILE}" ; then
+ sudo sed -i "s/$/ $option/" "${RPI_BOOT_CMDLINE_FILE}"
+ fi
+ done
+ fi
fi
}
-optimize_boot_time() {
- echo "Optimize boot time" | tee /dev/fd/3
- _optimize_disable_irrelevant_services
- _optimize_handle_bluetooth
- _optimize_handle_network_connection
- _optimize_ipv6_arp
- _optimize_handle_boot_screen
- _optimize_handle_boot_logs
+_optimize_check() {
+ print_verify_installation
+
+ verify_optional_service_enablement keyboard-setup.service disabled
+ verify_optional_service_enablement triggerhappy.service disabled
+ verify_optional_service_enablement triggerhappy.socket disabled
+ verify_optional_service_enablement raspi-config.service disabled
+ verify_optional_service_enablement apt-daily.service disabled
+ verify_optional_service_enablement apt-daily-upgrade.service disabled
+ verify_optional_service_enablement apt-daily.timer disabled
+ verify_optional_service_enablement apt-daily-upgrade.timer disabled
- echo "DONE: optimize_boot_time"
+ if [ "$DISABLE_BLUETOOTH" = true ] ; then
+ verify_optional_service_enablement hciuart.service disabled
+ verify_optional_service_enablement bluetooth.service disabled
+ fi
+
+ if [ "$ENABLE_STATIC_IP" = true ] ; then
+ verify_file_contains_string_once "${OPTIMIZE_DHCP_CONF_HEADER}" "${OPTIMIZE_DHCP_CONF}"
+ verify_file_contains_string "${CURRENT_INTERFACE}" "${OPTIMIZE_DHCP_CONF}"
+ verify_file_contains_string "${CURRENT_IP_ADDRESS}" "${OPTIMIZE_DHCP_CONF}"
+ verify_file_contains_string "${CURRENT_GATEWAY}" "${OPTIMIZE_DHCP_CONF}"
+ fi
+ if [ "$DISABLE_IPv6" = true ] ; then
+ verify_file_contains_string_once "${OPTIMIZE_IPV6_CONF_HEADER}" "${OPTIMIZE_DHCP_CONF}"
+ fi
+ if [ "$DISABLE_BOOT_SCREEN" = true ] ; then
+ verify_file_contains_string_once "${OPTIMIZE_BOOT_CONF_HEADER}" "${RPI_BOOT_CONFIG_FILE}"
+ fi
+
+ if [ "$DISABLE_BOOT_LOGS_PRINT" = true ] ; then
+ for option in $OPTIMIZE_BOOT_CMDLINE_OPTIONS
+ do
+ verify_file_contains_string_once $option "${RPI_BOOT_CMDLINE_FILE}"
+ done
+ fi
+}
+
+_run_optimize_boot_time() {
+ _optimize_disable_irrelevant_services
+ _optimize_handle_bluetooth
+ _optimize_static_ip
+ _optimize_ipv6_arp
+ _optimize_handle_boot_screen
+ _optimize_handle_boot_logs
+ _optimize_check
+}
+
+optimize_boot_time() {
+ run_with_log_frame _run_optimize_boot_time "Optimize boot time"
}
diff --git a/installation/routines/set_raspi_config.sh b/installation/routines/set_raspi_config.sh
index 1b1c3ee55..a9cb7b6f1 100644
--- a/installation/routines/set_raspi_config.sh
+++ b/installation/routines/set_raspi_config.sh
@@ -1,33 +1,33 @@
#!/usr/bin/env bash
-
-set_raspi_config() {
- echo "Set default raspi-config" | tee /dev/fd/3
+_run_set_raspi_config() {
# Source: https://raspberrypi.stackexchange.com/a/66939
# Autologin
- echo " * Enable Autologin for user"
+ echo " Enable Autologin for user"
sudo raspi-config nonint do_boot_behaviour B2
# Wait for network at boot
- # echo " * Enable 'Wait for network at boot'"
+ # echo " Enable 'Wait for network at boot'"
# sudo raspi-config nonint do_boot_wait 1
# power management of wifi: switch off to avoid disconnecting
- echo " * Disable Wifi power management to avoid disconnecting"
+ echo " Disable Wifi power management to avoid disconnecting"
sudo iwconfig wlan0 power off
# On-board audio
- if [[ $(get_onboard_audio) -eq 1 ]]; then
- DISABLE_ONBOARD_AUDIO=${DISABLE_ONBOARD_AUDIO:-false}
- if [[ $DISABLE_ONBOARD_AUDIO = true ]]; then
- echo " * Disable on-chip BCM audio"
- echo "Backup ${RPI_BOOT_CONFIG_FILE} --> ${DISABLE_ONBOARD_AUDIO_BACKUP}"
+ if [ "$DISABLE_ONBOARD_AUDIO" == true ]; then
+ echo " Disable on-chip BCM audio"
+ if grep -q -E "^dtparam=([^,]*,)*audio=(on|true|yes|1).*" "${RPI_BOOT_CONFIG_FILE}" ; then
+ echo " Backup ${RPI_BOOT_CONFIG_FILE} --> ${DISABLE_ONBOARD_AUDIO_BACKUP}"
sudo cp "${RPI_BOOT_CONFIG_FILE}" "${DISABLE_ONBOARD_AUDIO_BACKUP}"
sudo sed -i "s/^\(dtparam=\([^,]*,\)*\)audio=\(on\|true\|yes\|1\)\(.*\)/\1audio=off\4/g" "${RPI_BOOT_CONFIG_FILE}"
+ else
+ echo " On board audio seems to be off already. Not touching ${RPI_BOOT_CONFIG_FILE}"
fi
- else
- echo "On board audio seems to be off already. Not touching ${RPI_BOOT_CONFIG_FILE}"
fi
+}
+set_raspi_config() {
+ run_with_log_frame _run_set_raspi_config "Set default raspi-config"
}
diff --git a/installation/routines/set_ssh_qos.sh b/installation/routines/set_ssh_qos.sh
index ad67ddc41..eaca62fed 100644
--- a/installation/routines/set_ssh_qos.sh
+++ b/installation/routines/set_ssh_qos.sh
@@ -1,9 +1,11 @@
#!/usr/bin/env bash
set_ssh_qos() {
- # 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.
- echo " * Set SSH QoS to best effort"
- 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
+ if [ "$DISABLE_SSH_QOS" == true ] ; then
+ # 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.
+ echo " Set SSH QoS to best effort"
+ 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
}
diff --git a/installation/routines/setup_autohotspot.sh b/installation/routines/setup_autohotspot.sh
index 214a90e0f..a385352dd 100644
--- a/installation/routines/setup_autohotspot.sh
+++ b/installation/routines/setup_autohotspot.sh
@@ -1,14 +1,34 @@
#!/usr/bin/env bash
+# inspired by
+# https://www.raspberryconnect.com/projects/65-raspberrypi-hotspot-accesspoints/158-raspberry-pi-auto-wifi-hotspot-switch-direct-connection
+
+
+AUTOHOTSPOT_HOSTAPD_CONF_FILE="/etc/hostapd/hostapd.conf"
+AUTOHOTSPOT_HOSTAPD_DAEMON_CONF_FILE="/etc/default/hostapd"
+AUTOHOTSPOT_DNSMASQ_CONF_FILE="/etc/dnsmasq.conf"
+AUTOHOTSPOT_DHCPD_CONF_FILE="/etc/dhcpcd.conf"
+
+AUTOHOTSPOT_TARGET_PATH="/usr/bin/autohotspot"
+
_get_interface() {
# interfaces may vary
WIFI_INTERFACE=$(iw dev | grep "Interface"| awk '{ print $2 }')
WIFI_REGION=$(iw reg get | grep country | awk '{ print $2}' | cut -d: -f1)
-}
+ # fix for CI runs on docker
+ if [ "${CI_RUNNING}" == "true" ]; then
+ if [ -z "${WIFI_INTERFACE}" ]; then
+ WIFI_INTERFACE="CI TEST INTERFACE"
+ fi
+ if [ -z "${WIFI_REGION}" ]; then
+ WIFI_REGION="CI TEST REGION"
+ fi
+ fi
+}
_install_packages() {
- sudo apt-get -y install hostapd dnsmasq
+ sudo apt-get -y install hostapd dnsmasq iw
# disable services. We want to start them manually
sudo systemctl unmask hostapd
@@ -17,18 +37,18 @@ _install_packages() {
}
_configure_hostapd() {
- HOSTAPD_CUSTOM_FILE="${INSTALLATION_PATH}"/resources/autohotspot/hostapd.conf
- HOSTAPD_CONF_FILE="/etc/hostapd/hostapd.conf"
+ local HOSTAPD_CUSTOM_FILE="${INSTALLATION_PATH}"/resources/autohotspot/hostapd.conf
+
sed -i "s/WIFI_INTERFACE/${WIFI_INTERFACE}/g" "${HOSTAPD_CUSTOM_FILE}"
sed -i "s/AUTOHOTSPOT_PASSWORD/${AUTOHOTSPOT_PASSWORD}/g" "${HOSTAPD_CUSTOM_FILE}"
sed -i "s/WIFI_REGION/${WIFI_REGION}/g" "${HOSTAPD_CUSTOM_FILE}"
- sudo cp "${HOSTAPD_CUSTOM_FILE}" "${HOSTAPD_CONF_FILE}"
+ sudo cp "${HOSTAPD_CUSTOM_FILE}" "${AUTOHOTSPOT_HOSTAPD_CONF_FILE}"
- sudo sed -i "s@^#DAEMON_CONF=.*@DAEMON_CONF=\"${HOSTAPD_CONF_FILE}\"@g" /etc/default/hostapd
+ sudo sed -i "s@^#DAEMON_CONF=.*@DAEMON_CONF=\"${AUTOHOTSPOT_HOSTAPD_CONF_FILE}\"@g" "${AUTOHOTSPOT_HOSTAPD_DAEMON_CONF_FILE}"
}
_configure_dnsmasq() {
- sudo tee -a /etc/dnsmasq.conf <<-EOF
+ sudo tee -a "${AUTOHOTSPOT_DNSMASQ_CONF_FILE}" <<-EOF
#AutoHotspot Config
#stop DNSmasq from using resolv.conf
no-resolv
@@ -42,7 +62,7 @@ EOF
_other_configuration() {
sudo mv /etc/network/interfaces /etc/network/interfaces.bak
sudo touch /etc/network/interfaces
- echo nohook wpa_supplicant | sudo tee -a /etc/dhcpcd.conf
+ echo nohook wpa_supplicant | sudo tee -a "${AUTOHOTSPOT_DHCPD_CONF_FILE}"
}
_install_service_and_timer() {
@@ -52,23 +72,45 @@ _install_service_and_timer() {
}
_install_autohotspot_script() {
- TARGET_PATH="/usr/bin/autohotspot"
- sudo cp "${INSTALLATION_PATH}"/resources/autohotspot/autohotspot "${TARGET_PATH}"
- sudo chmod +x "${TARGET_PATH}"
+ sudo cp "${INSTALLATION_PATH}"/resources/autohotspot/autohotspot "${AUTOHOTSPOT_TARGET_PATH}"
+ sudo chmod +x "${AUTOHOTSPOT_TARGET_PATH}"
}
-setup_autohotspot() {
- echo "Install AutoHotspot functionality" | tee /dev/fd/3
- # inspired by
- # https://www.raspberryconnect.com/projects/65-raspberrypi-hotspot-accesspoints/158-raspberry-pi-auto-wifi-hotspot-switch-direct-connection
- _get_interface
+_autohotspot_check() {
+ print_verify_installation
+
+ verify_apt_packages hostapd dnsmasq iw
+
+ verify_service_enablement hostapd.service disabled
+ verify_service_enablement dnsmasq.service disabled
+ verify_service_enablement autohotspot.service enabled
+
+ verify_files_exists "/etc/cron.d/autohotspot"
+ verify_files_exists "${AUTOHOTSPOT_TARGET_PATH}"
+
+ verify_file_contains_string "${WIFI_INTERFACE}" "${AUTOHOTSPOT_HOSTAPD_CONF_FILE}"
+ verify_file_contains_string "${AUTOHOTSPOT_PASSWORD}" "${AUTOHOTSPOT_HOSTAPD_CONF_FILE}"
+ verify_file_contains_string "${WIFI_REGION}" "${AUTOHOTSPOT_HOSTAPD_CONF_FILE}"
+ verify_file_contains_string "${AUTOHOTSPOT_HOSTAPD_CONF_FILE}" "${AUTOHOTSPOT_HOSTAPD_DAEMON_CONF_FILE}"
+
+ verify_file_contains_string "${WIFI_INTERFACE}" "${AUTOHOTSPOT_DNSMASQ_CONF_FILE}"
+ verify_file_contains_string "nohook wpa_supplicant" "${AUTOHOTSPOT_DHCPD_CONF_FILE}"
+}
+
+_run_setup_autohotspot() {
_install_packages
+ _get_interface
_configure_hostapd
_configure_dnsmasq
_other_configuration
_install_autohotspot_script
_install_service_and_timer
+ _autohotspot_check
+}
- echo "DONE: setup_autohotspot"
+setup_autohotspot() {
+ if [ "$ENABLE_AUTOHOTSPOT" == true ] ; then
+ run_with_log_frame _run_setup_autohotspot "Install AutoHotspot"
+ fi
}
diff --git a/installation/routines/setup_git.sh b/installation/routines/setup_git.sh
index 740d43ae3..613062f43 100644
--- a/installation/routines/setup_git.sh
+++ b/installation/routines/setup_git.sh
@@ -2,7 +2,7 @@ GIT_ABORT_MSG="Aborting dir to git repo conversion.
Your directory content is untouched, you simply cannot use git for updating / developing"
_git_install_os_dependencies() {
- echo "Install Git dependencies"
+ echo " Install Git dependencies"
sudo apt-get -y update; sudo apt-get -y install \
git \
--no-install-recommends \
@@ -30,6 +30,7 @@ _git_convert_tardir_git_repo() {
# We simply get everything from the beginning of future 3 development but excluding Version 2.X
if [[ $GIT_USE_SSH == true ]]; then
git remote add origin "git@github.com:${GIT_USER}/${GIT_REPO_NAME}.git"
+ echo ""
echo "*** Git fetch (SSH) *******************************"
# Prevent: The authenticity of host 'github.com (140.82.121.4)' can't be established.
# Do only for this one command, so we do not disable the checks forever
@@ -43,6 +44,7 @@ _git_convert_tardir_git_repo() {
echo "* Defaulting to HTTPS protocol. You can change back to SSH later with"
echo "* git remote set-url origin git@github.com:${GIT_USER}/${GIT_REPO_NAME}.git"
echo "* git remote set-url upstream git@github.com:${GIT_UPSTREAM_USER}/${GIT_REPO_NAME}.git"
+ echo ""
git remote remove origin
GIT_USE_SSH=false
else
@@ -58,7 +60,8 @@ _git_convert_tardir_git_repo() {
if [[ "$GIT_USER" != "$GIT_UPSTREAM_USER" ]]; then
git remote add upstream "https://github.com/${GIT_UPSTREAM_USER}/${GIT_REPO_NAME}.git"
fi
- echo "*** Git fetch (HTTPS) *****************************"
+ echo ""
+ echo "*** Git fetch (HTTPS) *****************************"
if ! git fetch origin --set-upstream --shallow-since=2021-04-21 --tags "${GIT_BRANCH}"; then
echo "Error: Could not fetch repository!"
echo -e "$GIT_ABORT_MSG"
@@ -66,6 +69,7 @@ _git_convert_tardir_git_repo() {
fi
fi
HASH_BRANCH=$(git rev-parse FETCH_HEAD) || { echo -e "$GIT_ABORT_MSG"; return; }
+ echo ""
echo "*** FETCH_HEAD ($GIT_BRANCH) = $HASH_BRANCH"
git add .
@@ -113,12 +117,14 @@ _git_convert_tardir_git_repo() {
# Provide some status outputs to the user
if [[ "${HASH_BRANCH}" != "${HASH_HEAD}" ]]; then
+ echo ""
echo "*** IMPORTANT NOTICE *******************************"
echo "* Your requested branch has moved on while you were installing."
- echo "* Don't worry! We will stay within the the exact download version!"
+ echo "* Don't worry! We will stay within the exact download version!"
echo "* But we set up the git repo to be ready for updating."
echo "* To start updating (observe updating guidelines!), do:"
echo "* $ git pull origin $GIT_BRANCH"
+ echo ""
fi
echo "*** Git remotes ************************************"
@@ -137,12 +143,20 @@ _git_convert_tardir_git_repo() {
unset HASH_BRANCH
}
-init_git_repo_from_tardir() {
- echo "Install Git & init repository" | tee /dev/fd/3
+_git_repo_check() {
+ print_verify_installation
+
+ verify_apt_packages git
+ verify_dirs_chmod_chown 755 "${CURRENT_USER}" "${CURRENT_USER_GROUP}" "${INSTALLATION_PATH}/.git"
+}
- cd "${INSTALLATION_PATH}" || exit_on_error
- _git_install_os_dependencies
- _git_convert_tardir_git_repo
+_run_init_git_repo_from_tardir() {
+ cd "${INSTALLATION_PATH}" || exit_on_error
+ _git_install_os_dependencies
+ _git_convert_tardir_git_repo
+ _git_repo_check
+}
- echo "DONE: init_git_repo_from_tardir"
+init_git_repo_from_tardir() {
+ run_with_log_frame _run_init_git_repo_from_tardir "Install Git & init repository"
}
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index e6dfa6d8f..3daa53081 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -9,6 +9,9 @@ GD_ID_COMPILED_PYZMQ_ARMV6="1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n" # https://drive.g
ZMQ_TMP_DIR="libzmq"
ZMQ_PREFIX="/usr/local"
+JUKEBOX_PULSE_CONFIG="${HOME_PATH}"/.config/pulse/default.pa
+JUKEBOX_SERVICE_NAME="${SYSTEMD_USR_PATH}/jukebox-daemon.service"
+
_show_slow_hardware_message() {
echo " --------------------------------------------------------------------
| Your hardware is a little slower so this step will take a while. |
@@ -19,14 +22,11 @@ echo " --------------------------------------------------------------------
# Functions
_jukebox_core_install_os_dependencies() {
- echo " Install Jukebox OS dependencies"
+ echo " Install Jukebox OS dependencies" | tee /dev/fd/3
+
+ local apt_packages=$(get_args_from_file "${INSTALLATION_PATH}/packages-core.txt")
sudo apt-get -y update && sudo apt-get -y install \
- at \
- alsa-utils \
- python3 python3-venv python3-dev \
- espeak ffmpeg mpg123 \
- pulseaudio pulseaudio-module-bluetooth pulseaudio-utils caps \
- libasound2-dev \
+ $apt_packages \
--no-install-recommends \
--allow-downgrades \
--allow-remove-essential \
@@ -34,11 +34,10 @@ _jukebox_core_install_os_dependencies() {
}
_jukebox_core_install_python_requirements() {
- echo " Install Python requirements"
+ echo " Install Python requirements" | tee /dev/fd/3
cd "${INSTALLATION_PATH}" || exit_on_error
- VIRTUAL_ENV="${INSTALLATION_PATH}/.venv"
python3 -m venv $VIRTUAL_ENV
source "$VIRTUAL_ENV/bin/activate"
@@ -47,9 +46,9 @@ _jukebox_core_install_python_requirements() {
}
_jukebox_core_configure_pulseaudio() {
- echo "Copy PulseAudio configuration"
- mkdir -p ~/.config/pulse
- cp -f "${INSTALLATION_PATH}/resources/default-settings/pulseaudio.default.pa" ~/.config/pulse/default.pa
+ echo " Copy PulseAudio configuration" | tee /dev/fd/3
+ mkdir -p $(dirname "$JUKEBOX_PULSE_CONFIG")
+ cp -f "${INSTALLATION_PATH}/resources/default-settings/pulseaudio.default.pa" "${JUKEBOX_PULSE_CONFIG}"
}
_jukebox_core_build_libzmq_with_drafts() {
@@ -87,7 +86,7 @@ _jukebox_core_build_and_install_pyzmq() {
# Sources:
# https://pyzmq.readthedocs.io/en/latest/howto/draft.html
# https://github.com/MonsieurV/ZeroMQ-RPi/blob/master/README.md
- echo " Build and install pyzmq with WebSockets Support"
+ echo " Build and install pyzmq with WebSockets Support" | tee /dev/fd/3
if ! pip list | grep -F pyzmq >> /dev/null; then
# Download pre-compiled libzmq from Google Drive because RPi has trouble compiling it
@@ -112,37 +111,60 @@ _jukebox_core_build_and_install_pyzmq() {
ZMQ_PREFIX="${ZMQ_PREFIX}" ZMQ_DRAFT_API=1 \
pip install --no-cache-dir --no-binary "pyzmq" --pre pyzmq
else
- echo " Skipping. pyzmq already installed"
+ echo " Skipping. pyzmq already installed" | tee /dev/fd/3
fi
}
_jukebox_core_install_settings() {
- echo " Register Jukebox settings"
+ echo " Register Jukebox settings" | tee /dev/fd/3
cp -f "${INSTALLATION_PATH}/resources/default-settings/jukebox.default.yaml" "${SETTINGS_PATH}/jukebox.yaml"
cp -f "${INSTALLATION_PATH}/resources/default-settings/logger.default.yaml" "${SETTINGS_PATH}/logger.yaml"
}
_jukebox_core_register_as_service() {
- echo " Register Jukebox Core user service"
+ echo " Register Jukebox Core user service" | tee /dev/fd/3
- local jukebox_service="${SYSTEMD_USR_PATH}/jukebox-daemon.service"
- sudo cp -f "${INSTALLATION_PATH}/resources/default-services/jukebox-daemon.service" "${jukebox_service}"
- sudo sed -i "s|%%INSTALLATION_PATH%%|${INSTALLATION_PATH}|g" "${jukebox_service}"
- sudo chmod 644 "${jukebox_service}"
+ sudo cp -f "${INSTALLATION_PATH}/resources/default-services/jukebox-daemon.service" "${JUKEBOX_SERVICE_NAME}"
+ sudo sed -i "s|%%INSTALLATION_PATH%%|${INSTALLATION_PATH}|g" "${JUKEBOX_SERVICE_NAME}"
+ sudo chmod 644 "${JUKEBOX_SERVICE_NAME}"
systemctl --user daemon-reload
systemctl --user enable jukebox-daemon.service
}
-setup_jukebox_core() {
- echo "Install Jukebox Core" | tee /dev/fd/3
+_jukebox_core_check() {
+ print_verify_installation
+
+ local apt_packages=$(get_args_from_file "${INSTALLATION_PATH}/packages-core.txt")
+ verify_apt_packages $apt_packages
+
+ verify_dirs_exists "${VIRTUAL_ENV}"
+
+ local pip_modules=$(get_args_from_file "${INSTALLATION_PATH}/requirements.txt")
+ verify_pip_modules pyzmq $pip_modules
+
+ verify_files_chmod_chown 644 "${CURRENT_USER}" "${CURRENT_USER_GROUP}" "${JUKEBOX_PULSE_CONFIG}"
- _jukebox_core_install_os_dependencies
- _jukebox_core_install_python_requirements
- _jukebox_core_configure_pulseaudio
- _jukebox_core_build_and_install_pyzmq
- _jukebox_core_install_settings
- _jukebox_core_register_as_service
+ verify_files_chmod_chown 644 "${CURRENT_USER}" "${CURRENT_USER_GROUP}" "${SETTINGS_PATH}/jukebox.yaml"
+ verify_files_chmod_chown 644 "${CURRENT_USER}" "${CURRENT_USER_GROUP}" "${SETTINGS_PATH}/logger.yaml"
- echo "DONE: setup_jukebox_core"
+ verify_files_chmod_chown 644 root root "${SYSTEMD_USR_PATH}/jukebox-daemon.service"
+
+ verify_file_contains_string "${INSTALLATION_PATH}" "${JUKEBOX_SERVICE_NAME}"
+
+ verify_service_enablement jukebox-daemon.service enabled --user
+}
+
+_run_setup_jukebox_core() {
+ _jukebox_core_install_os_dependencies
+ _jukebox_core_install_python_requirements
+ _jukebox_core_configure_pulseaudio
+ _jukebox_core_build_and_install_pyzmq
+ _jukebox_core_install_settings
+ _jukebox_core_register_as_service
+ _jukebox_core_check
+}
+
+setup_jukebox_core() {
+ run_with_log_frame _run_setup_jukebox_core "Install Jukebox Core"
}
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index 54be3119c..df58188fb 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -2,6 +2,7 @@
# Constants
GD_ID_COMPILED_WEBAPP="1um-smyfsVPzVZn18hhwuFt97XR3PjAbB" # https://drive.google.com/file/d/1um-smyfsVPzVZn18hhwuFt97XR3PjAbB/view?usp=sharing
+WEBAPP_NGINX_SITE_DEFAULT_CONF="/etc/nginx/sites-available/default"
# For ARMv7+
NODE_MAJOR=20
@@ -39,14 +40,13 @@ _jukebox_webapp_install_node() {
sudo apt-get update
sudo apt-get install -y nodejs
fi
-
fi
}
# TODO: Avoid building the app locally
# Instead implement a Github Action that prebuilds on commititung a git tag
_jukebox_webapp_build() {
- echo " Building web application"
+ echo " Building web application" | tee /dev/fd/3
cd "${INSTALLATION_PATH}/src/webapp" || exit_on_error
npm ci --prefer-offline --no-audit --production
rm -rf build
@@ -70,30 +70,47 @@ _jukebox_webapp_register_as_system_service_with_nginx() {
sudo apt-get -y purge apache2
sudo apt-get -y install nginx
- sudo service nginx start
-
- sudo mv -f /etc/nginx/sites-available/default /etc/nginx/sites-available/default.orig
- sudo cp -f "${INSTALLATION_PATH}/resources/default-settings/nginx.default" /etc/nginx/sites-available/default
+ sudo mv -f "${WEBAPP_NGINX_SITE_DEFAULT_CONF}" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}.orig"
+ sudo cp -f "${INSTALLATION_PATH}/resources/default-settings/nginx.default" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
# make sure nginx can access the home directory of the user
- sudo chmod o+x /home/pi
+ sudo chmod o+x "${HOME_PATH}"
- sudo service nginx restart
+ sudo systemctl restart nginx.service
}
-setup_jukebox_webapp() {
- echo "Install web application" | tee /dev/fd/3
+_jukebox_webapp_check() {
+ print_verify_installation
- if [[ $ENABLE_WEBAPP_PROD_DOWNLOAD == true || $ENABLE_WEBAPP_PROD_DOWNLOAD == release-only ]] ; then
- _jukebox_webapp_download
- fi
- if [[ $ENABLE_INSTALL_NODE == true ]] ; then
- _jukebox_webapp_install_node
- # Local Web App build during installation does not work at the moment
- # Needs to be done after reboot! There will be a message at the end of the installation process
- # _jukebox_webapp_build
- fi
- _jukebox_webapp_register_as_system_service_with_nginx
+ if [[ $ENABLE_WEBAPP_PROD_DOWNLOAD == true || $ENABLE_WEBAPP_PROD_DOWNLOAD == release-only ]] ; then
+ verify_dirs_exists "${INSTALLATION_PATH}/src/webapp/build"
+ fi
+ if [[ $ENABLE_INSTALL_NODE == true ]] ; then
+ verify_apt_packages nodejs
+ fi
+
+ verify_apt_packages nginx
+ verify_files_exists "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
- echo "DONE: setup_jukebox_webapp"
+ verify_service_enablement nginx.service enabled
+}
+
+_run_setup_jukebox_webapp() {
+ if [[ $ENABLE_WEBAPP_PROD_DOWNLOAD == true || $ENABLE_WEBAPP_PROD_DOWNLOAD == release-only ]] ; then
+ _jukebox_webapp_download
+ fi
+ if [[ $ENABLE_INSTALL_NODE == true ]] ; then
+ _jukebox_webapp_install_node
+ # Local Web App build during installation does not work at the moment
+ # Needs to be done after reboot! There will be a message at the end of the installation process
+ # _jukebox_webapp_build
+ fi
+ _jukebox_webapp_register_as_system_service_with_nginx
+ _jukebox_webapp_check
+}
+
+setup_jukebox_webapp() {
+ if [ "$ENABLE_WEBAPP" == true ] ; then
+ run_with_log_frame _run_setup_jukebox_webapp "Install web application"
+ fi
}
diff --git a/installation/routines/setup_kiosk_mode.sh b/installation/routines/setup_kiosk_mode.sh
index b2857b624..f8d07971c 100644
--- a/installation/routines/setup_kiosk_mode.sh
+++ b/installation/routines/setup_kiosk_mode.sh
@@ -1,6 +1,13 @@
#!/usr/bin/env bash
+KIOSK_MODE_CONF_HEADER="## Jukebox Kiosk Mode"
+KIOSK_MODE_XINITRC='/etc/xdg/openbox/autostart'
+KIOSK_MODE_BASHRC="${HOME_PATH}/.bashrc"
+KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK='/etc/chromium-browser/customizations/01-disable-update-check'
+KIOSK_MODE_CHROMIUM_FLAG_UPDATE_INTERVAL='--check-for-update-interval=31536000'
+
_kiosk_mode_install_os_dependencies() {
+ echo " Install Kiosk Mode dependencies" | tee /dev/fd/3
# Resource:
# https://blog.r0b.io/post/minimal-rpi-kiosk/
sudo apt-get -qq -y install --no-install-recommends \
@@ -12,19 +19,20 @@ _kiosk_mode_install_os_dependencies() {
}
_kiosk_mode_set_autostart() {
+ echo " Configure Kiosk Mode" | tee /dev/fd/3
local _DISPLAY='$DISPLAY'
local _XDG_VTNR='$XDG_VTNR'
- cat << EOF >> /home/pi/.bashrc
-## Jukebox kiosk autostart
+ tee -a "${KIOSK_MODE_BASHRC}" <<-EOF
+
+${KIOSK_MODE_CONF_HEADER}
[[ -z $_DISPLAY && $_XDG_VTNR -eq 1 ]] && startx -- -nocursor
EOF
- local XINITRC='/etc/xdg/openbox/autostart'
- cat << EOF | sudo tee -a $XINITRC
+ sudo tee -a "${KIOSK_MODE_XINITRC}" <<-EOF
-## Jukebox Kiosk Mode
+${KIOSK_MODE_CONF_HEADER}
# Disable any form of screen saver / screen blanking / power management
xset s off
xset s noblank
@@ -46,16 +54,43 @@ EOF
_kiosk_mode_update_settings() {
# Resource: https://github.com/Thyraz/Sonos-Kids-Controller/blob/d1f061f4662c54ae9b8dc8b545f9c3ba39f670eb/README.md#kiosk-mode-installation
- sudo touch /etc/chromium-browser/customizations/01-disable-update-check;echo CHROMIUM_FLAGS=\"\$\{CHROMIUM_FLAGS\} --check-for-update-interval=31536000\" | sudo tee /etc/chromium-browser/customizations/01-disable-update-check
+ sudo mkdir -p $(dirname "${KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK}")
+ sudo rm -f "${KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK}"
+ sudo tee -a "${KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK}" <<-EOF
+${KIOSK_MODE_CONF_HEADER}
+CHROMIUM_FLAGS=\"\$\{CHROMIUM_FLAGS\} --check-for-update-interval=31536000\"
+EOF
+}
+
+_kiosk_mode_check() {
+ print_verify_installation
+
+ verify_apt_packages xserver-xorg \
+ x11-xserver-utils \
+ xinit \
+ openbox \
+ chromium-browser
+ verify_files_exists "${KIOSK_MODE_BASHRC}"
+ verify_file_contains_string "${KIOSK_MODE_CONF_HEADER}" "${KIOSK_MODE_BASHRC}"
+
+ verify_files_exists "${KIOSK_MODE_XINITRC}"
+ verify_file_contains_string "${KIOSK_MODE_CONF_HEADER}" "${KIOSK_MODE_XINITRC}"
+
+ verify_files_exists "${KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK}"
+ verify_file_contains_string "${KIOSK_MODE_CONF_HEADER}" "${KIOSK_MODE_CHROMIUM_CUSTOM_DISABLE_UPDATE_CHECK}"
}
-setup_kiosk_mode() {
- echo "Setup Kiosk Mode" | tee /dev/fd/3
+_run_setup_kiosk_mode() {
+ _kiosk_mode_install_os_dependencies
+ _kiosk_mode_set_autostart
+ _kiosk_mode_update_settings
+ _kiosk_mode_check
+}
- _kiosk_mode_install_os_dependencies
- _kiosk_mode_set_autostart
- _kiosk_mode_update_settings
- echo "DONE: setup_kiosk_mode"
+setup_kiosk_mode() {
+ if [ "$ENABLE_KIOSK_MODE" == true ] ; then
+ run_with_log_frame _run_setup_kiosk_mode "Setup Kiosk Mode"
+ fi
}
diff --git a/installation/routines/setup_mpd.sh b/installation/routines/setup_mpd.sh
index 53b9ac01b..40ffe8aac 100644
--- a/installation/routines/setup_mpd.sh
+++ b/installation/routines/setup_mpd.sh
@@ -3,13 +3,11 @@
AUDIOFOLDERS_PATH="${SHARED_PATH}/audiofolders"
PLAYLISTS_PATH="${SHARED_PATH}/playlists"
-# Do not change this directory! It must match MPDs expectation where to find the user configuration
-MPD_CONF_PATH="$HOME/.config/mpd/mpd.conf"
-
_mpd_install_os_dependencies() {
+ echo " Install MPD OS dependencies"
sudo apt-get -y update
- echo "Install MPD OS dependencies"
- echo "Note: Installing MPD will cause a message: 'Job failed. See journalctl -xe for details'"
+
+ echo "Note: Installing MPD might cause a message: 'Job failed. See journalctl -xe for details'"
echo "It can be ignored! It's an artefact of the MPD installation - nothing we can do about it."
sudo apt-get -y install \
mpd mpc \
@@ -20,8 +18,15 @@ _mpd_install_os_dependencies() {
}
_mpd_configure() {
+ echo " Configure MPD as user local service" | tee /dev/fd/3
+
+ # Make sure system-wide mpd is disabled
+ sudo systemctl stop mpd.socket
+ sudo systemctl stop mpd.service
+ sudo systemctl disable mpd.socket
+ sudo systemctl disable mpd.service
# MPD will be setup as user process (rather than a system-wide process)
- mkdir -p ~/.config/mpd
+ mkdir -p $(dirname "$MPD_CONF_PATH")
cp -f "${INSTALLATION_PATH}/resources/default-settings/mpd.default.conf" "${MPD_CONF_PATH}"
@@ -29,48 +34,38 @@ _mpd_configure() {
sed -i 's|%%JUKEBOX_AUDIOFOLDERS_PATH%%|'"$AUDIOFOLDERS_PATH"'|' "${MPD_CONF_PATH}"
sed -i 's|%%JUKEBOX_PLAYLISTS_PATH%%|'"$PLAYLISTS_PATH"'|' "${MPD_CONF_PATH}"
+ # Prepare user-service MPD to be started at next boot
+ systemctl --user daemon-reload
+ systemctl --user enable mpd.socket
+ systemctl --user enable mpd.service
}
-setup_mpd() {
- echo "Install MPD" | tee /dev/fd/3
+_mpd_check() {
+ print_verify_installation
- local MPD_EXECUTE_INSTALL=true
+ verify_apt_packages mpd mpc
- if [[ -f ${MPD_CONF_PATH} || -f ${SYSTEMD_USR_PATH}/mpd.service ]]; then
- echo "It seems there is a MPD already installed.
-Note: It is important that MPD runs as a user service!
-Would you like to overwrite your configuration? [Y/n]" 1>&3
- read -r response
- case "$response" in
- [nN][oO]|[nN])
- MPD_EXECUTE_INSTALL=false
- ;;
- *)
- ;;
- esac
- fi
+ verify_files_chmod_chown 755 "${CURRENT_USER}" "${CURRENT_USER_GROUP}" "${MPD_CONF_PATH}"
- echo "MPD_EXECUTE_INSTALL=${MPD_EXECUTE_INSTALL}"
+ verify_file_contains_string "${AUDIOFOLDERS_PATH}" "${MPD_CONF_PATH}"
+ verify_file_contains_string "${PLAYLISTS_PATH}" "${MPD_CONF_PATH}"
- if [[ $MPD_EXECUTE_INSTALL == true ]] ; then
+ verify_service_enablement mpd.socket disabled
+ verify_service_enablement mpd.service disabled
- # Install/update only if enabled: do not stuff up any existing configuration
- _mpd_install_os_dependencies
+ verify_service_enablement mpd.socket enabled --user
+ verify_service_enablement mpd.service enabled --user
+}
- # Make sure system-wide mpd is disabled
- echo "Configure MPD as user local service" | tee /dev/fd/3
- sudo systemctl stop mpd.socket
- sudo systemctl stop mpd
- sudo systemctl disable mpd.socket
- sudo systemctl disable mpd
+_run_setup_mpd() {
+ _mpd_install_os_dependencies
_mpd_configure
- # Prepare user-service MPD to be started at next boot
- systemctl --user daemon-reload
- systemctl --user enable mpd.socket
- systemctl --user enable mpd
- # Start MPD now, but not the socket: MPD is already started and we expect a reboot anyway
- systemctl --user start mpd
- fi
-
- echo "DONE: setup_mpd"
+ _mpd_check
+}
+
+setup_mpd() {
+ # Install/update only if enabled: do not stuff up any existing configuration
+ if [[ "$SETUP_MPD" == true && $ENABLE_MPD_OVERWRITE_INSTALL == true ]] ; then
+ run_with_log_frame _run_setup_mpd "Install MPD"
+ fi
}
diff --git a/installation/routines/setup_rfid_reader.sh b/installation/routines/setup_rfid_reader.sh
index 4ae693076..b5e8b4bbc 100644
--- a/installation/routines/setup_rfid_reader.sh
+++ b/installation/routines/setup_rfid_reader.sh
@@ -1,9 +1,11 @@
#!/usr/bin/env bash
-setup_rfid_reader() {
- echo "Install RFID Reader" | tee /dev/fd/3
-
- python "${INSTALLATION_PATH}/src/jukebox/run_register_rfid_reader.py" | tee /dev/fd/3
+_run_setup_rfid_reader() {
+ python "${INSTALLATION_PATH}/src/jukebox/run_register_rfid_reader.py" | tee /dev/fd/3
+}
- echo "DONE: setup_rfid_reader"
+setup_rfid_reader() {
+ if [ "$ENABLE_RFID_READER" == true ] ; then
+ run_with_log_frame _run_setup_rfid_reader "Install RFID Reader"
+ fi
}
diff --git a/installation/routines/setup_samba.sh b/installation/routines/setup_samba.sh
index 0914439b7..4b45b54e1 100644
--- a/installation/routines/setup_samba.sh
+++ b/installation/routines/setup_samba.sh
@@ -1,7 +1,10 @@
#!/usr/bin/env bash
+SMB_CONF="/etc/samba/smb.conf"
+SMB_CONF_HEADER="## Jukebox Samba Config"
+
_samba_install_os_dependencies() {
- echo "Install Samba Core dependencies"
+ echo " Install Samba Core dependencies"
sudo apt-get -qq -y update; sudo apt-get -qq -y install \
samba samba-common-bin \
--no-install-recommends \
@@ -11,23 +14,22 @@ _samba_install_os_dependencies() {
}
_samba_set_user() {
- local SMB_CONF="/etc/samba/smb.conf"
- local SMB_USER="pi"
+ echo " Configure Samba" | tee /dev/fd/3
local SMB_PASSWD="raspberry"
# Samba has not been configured
- if grep -q "## Jukebox Samba Config" "$SMB_CONF"; then
- echo " Skipping. Already set up!" | tee /dev/fd/3
+ if grep -q "$SMB_CONF_HEADER" "$SMB_CONF"; then
+ echo " Skipping. Already set up!" | tee /dev/fd/3
else
# Create Samba user
- (echo "${SMB_PASSWD}"; echo "${SMB_PASSWD}") | sudo smbpasswd -s -a $SMB_USER
+ (echo "${SMB_PASSWD}"; echo "${SMB_PASSWD}") | sudo smbpasswd -s -a "${CURRENT_USER}"
sudo chown root:root $SMB_CONF
sudo chmod 777 $SMB_CONF
# Create Samba Mount Points
sudo cat << EOF >> $SMB_CONF
-## Jukebox Samba Config
+${SMB_CONF_HEADER}
[phoniebox]
comment= Pi Jukebox
path=${SHARED_PATH}
@@ -43,13 +45,31 @@ EOF
fi
}
-setup_samba() {
- echo "Install Samba and configure user" | tee /dev/fd/3
+_samba_check() {
+ print_verify_installation
+
+ verify_apt_packages samba samba-common-bin
- # Skip interactive Samba WINS config dialog
- echo "samba-common samba-common/dhcp boolean false" | sudo debconf-set-selections
- _samba_install_os_dependencies
- _samba_set_user
+ verify_files_chmod_chown 644 root root "${SMB_CONF}"
- echo "DONE: setup_samba"
+ verify_file_contains_string "${SMB_CONF_HEADER}" "${SMB_CONF}"
+ verify_file_contains_string "${SHARED_PATH}" "${SMB_CONF}"
+
+ if ! (sudo pdbedit -L | grep -qw "^${CURRENT_USER}") ; then
+ exit_on_error "ERROR: samba user not found"
+ fi
+}
+
+_run_setup_samba() {
+ # Skip interactive Samba WINS config dialog
+ echo "samba-common samba-common/dhcp boolean false" | sudo debconf-set-selections
+ _samba_install_os_dependencies
+ _samba_set_user
+ _samba_check
+}
+
+setup_samba() {
+ if [ "$ENABLE_SAMBA" == true ] ; then
+ run_with_log_frame _run_setup_samba "Install Samba"
+ fi
}
diff --git a/installation/routines/update_raspi_os.sh b/installation/routines/update_raspi_os.sh
index b7c356454..f38e975ed 100644
--- a/installation/routines/update_raspi_os.sh
+++ b/installation/routines/update_raspi_os.sh
@@ -1,9 +1,14 @@
#!/usr/bin/env bash
-update_raspi_os() {
- echo "Updating Raspberry Pi OS" | tee /dev/fd/3
-
- sudo apt-get -qq -y update; sudo apt-get -qq -y full-upgrade; sudo apt-get -qq -y autoremove
+_run_update_raspi_os() {
+ sudo apt-get -qq -y update && sudo apt-get -qq -y full-upgrade || exit_on_error "Failed to Update Raspberry Pi OS"
+ if [ "$CI_RUNNING" != "true" ]; then
+ sudo apt-get -qq -y autoremove
+ fi
+}
- echo "DONE: update_raspi_os"
+update_raspi_os() {
+ if [ "$UPDATE_RASPI_OS" == true ] ; then
+ run_with_log_frame _run_update_raspi_os "Updating Raspberry Pi OS"
+ fi
}
diff --git a/packages-core.txt b/packages-core.txt
new file mode 100644
index 000000000..b2f6779a2
--- /dev/null
+++ b/packages-core.txt
@@ -0,0 +1,17 @@
+# Define packages for apt-get. These can be installed with
+# 'sed 's/#.*//g' packages.txt | xargs sudo apt-get install'
+
+at
+alsa-utils
+caps
+espeak
+ffmpeg
+libasound2-dev
+mpg123
+pulseaudio
+pulseaudio-module-bluetooth
+pulseaudio-utils
+python3
+python3-venv
+python3-dev
+rsync
diff --git a/requirements.txt b/requirements.txt
index f9f452799..0f8c8c86d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -12,7 +12,7 @@ wheel
evdev
pyalsaaudio
pulsectl
-python_mpd2
+python-mpd2
ruamel.yaml
# For playlistgenerator
requests
@@ -28,7 +28,6 @@ gpiozero
# On regular Linux PCs, Websocket is enabled in the Python package
# pyzmq
-
# Code quality
flake8>=4.0.0
pytest
diff --git a/src/jukebox/components/rfid/configure/__init__.py b/src/jukebox/components/rfid/configure/__init__.py
index 7f9e232f2..0a8ff7aca 100755
--- a/src/jukebox/components/rfid/configure/__init__.py
+++ b/src/jukebox/components/rfid/configure/__init__.py
@@ -10,6 +10,8 @@
logger = logging.getLogger()
+NO_RFID_READER = 'No RFID Reader'
+
def reader_install_dependencies(reader_path: str, dependency_install: str) -> None:
"""
@@ -80,6 +82,40 @@ def reader_load_module(reader_name):
return reader_module
+def _get_reader_descriptions(reader_dirs: list[str]) -> dict[str, tuple[str, str]]:
+ # Try to load the description modules from all valid directories (as this has no dependencies)
+ # If unavailable, use placeholder description
+ reader_descriptions = {}
+ for reader_type in reader_dirs:
+ reader_description_module_name = ''
+ reader_description = ''
+ if reader_type == NO_RFID_READER:
+ # Add Option to not add a RFid Reader
+ reader_description_module_name = reader_type
+ reader_description = reader_type
+ else:
+ reader_description_module_name = f"{reader_type + '/' + reader_type + '.py'}"
+ try:
+ reader_description_module = (importlib.import_module('components.rfid.hardware.' + reader_type
+ + '.description', 'pkg.subpkg'))
+ reader_description = reader_description_module.DESCRIPTION
+ except ModuleNotFoundError:
+ # The developer for this reader simply omitted to provide a description module
+ # Or there is no valid module in this directory, despite correct naming scheme.
+ # But this we will only find out later, because we want to be as lenient as possible
+ # and don't already load and check reader modules the user is
+ # not selecting (and thus no interested in)
+ logger.warning(f"No module 'description.py' available for reader subpackage '{reader_type}'")
+ reader_description = '(No description provided!)'
+ except AttributeError:
+ # The module loaded ok, but has no identifier 'DESCRIPTION'
+ logger.warning(f"Module 'description.py' of reader subpackage '{reader_type}' is missing 'DESCRIPTION'. "
+ f"Spelling error?")
+ reader_description = '(No description provided!)'
+ reader_descriptions[reader_type] = (reader_description, reader_description_module_name)
+ return reader_descriptions
+
+
def query_user_for_reader(dependency_install='query') -> dict:
"""
Ask the user to select a RFID reader and prompt for the reader's configuration
@@ -115,39 +151,20 @@ def query_user_for_reader(dependency_install='query') -> dict:
package_dir = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/../hardware')
logger.debug(f"Package location: {package_dir}")
# For known included readers, specify manual order
- included_readers = ['generic_usb', 'rdm6300_serial', 'rc522_spi', 'pn532_i2c_py532', 'fake_reader_gui']
+ included_readers = [NO_RFID_READER, 'generic_usb', 'rdm6300_serial', 'rc522_spi', 'pn532_i2c_py532', 'fake_reader_gui']
# Get all local directories (i.e subpackages) that conform to naming/structuring convention (except known readers)
# Naming convention: modname/modname.py
- reader_dirs = [x for x in os.listdir(package_dir)
+ additional_readers = [x for x in os.listdir(package_dir)
if (os.path.isdir(package_dir + '/' + x)
and os.path.exists(package_dir + '/' + x + '/' + x + '.py')
and os.path.isfile(package_dir + '/' + x + '/' + x + '.py')
and not x.endswith('template_new_reader')
and x not in included_readers)]
- reader_dirs = [*included_readers, *sorted(reader_dirs, key=lambda x: x.casefold())]
+ reader_dirs = [*included_readers, *sorted(additional_readers, key=lambda x: x.casefold())]
+
logger.debug(f"reader_dirs = {reader_dirs}")
- # Try to load the description modules from all valid directories (as this has no dependencies)
- # If unavailable, use placeholder description
- reader_description_modules = []
- reader_descriptions = []
- for reader_type in reader_dirs:
- try:
- reader_description_modules.append(importlib.import_module('components.rfid.hardware.' + reader_type
- + '.description', 'pkg.subpkg'))
- reader_descriptions.append(reader_description_modules[-1].DESCRIPTION)
- except ModuleNotFoundError:
- # The developer for this reader simply omitted to provide a description module
- # Or there is no valid module in this directory, despite correct naming scheme. But this we will only find out
- # later, because we want to be as lenient as possible and don't already load and check reader modules the user is
- # not selecting (and thus no interested in)
- logger.warning(f"No module 'description.py' available for reader subpackage '{reader_type}'")
- reader_descriptions.append('(No description provided!)')
- except AttributeError:
- # The module loaded ok, but has no identifier 'DESCRIPTION'
- logger.warning(f"Module 'description.py' of reader subpackage '{reader_type}' is missing 'DESCRIPTION'. "
- f"Spelling error?")
- reader_descriptions.append('(No description provided!)')
+ reader_descriptions = _get_reader_descriptions(reader_dirs)
# Prepare the configuration collector with the base values
config_dict = {'rfid': {'readers': {}}}
@@ -157,14 +174,21 @@ def query_user_for_reader(dependency_install='query') -> dict:
while True:
# List all modules and query user
print("Choose Reader Module from list:\n")
- for idx, (des, mod) in enumerate(zip(reader_descriptions, reader_dirs)):
+ for idx, (des, mod) in enumerate(reader_descriptions.values()):
print(f" {Colors.lightgreen}{idx:2d}{Colors.reset}: {Colors.lightcyan}{Colors.bold}{des:40s}{Colors.reset} "
- f"(Module: {mod + '/' + mod + '.py'})")
+ f"(Module: {mod})")
print("")
reader_id = pyil.input_int("Reader module number?", min=0, max=len(reader_descriptions) - 1,
prompt_color=Colors.lightgreen, prompt_hint=True)
+
# The (short) name of the selected reader module, which is identical to the directory name
- reader_select_name.append(reader_dirs[reader_id])
+ reader_selected = list(reader_descriptions.keys())[reader_id]
+ print(f"Reader selected: '{reader_selected}'")
+ if reader_selected == NO_RFID_READER:
+ logger.debug(f"Entry '{NO_RFID_READER}' selected. skip")
+ break
+
+ reader_select_name.append(reader_selected)
# If this reader has not been selected before, auto install dependencies
if reader_select_name[-1] not in reader_select_name[:-1]:
diff --git a/src/jukebox/components/rfid/reader/__init__.py b/src/jukebox/components/rfid/reader/__init__.py
index 9245a127a..db0ccb1da 100644
--- a/src/jukebox/components/rfid/reader/__init__.py
+++ b/src/jukebox/components/rfid/reader/__init__.py
@@ -239,14 +239,22 @@ def run(self): # noqa: C901
@plugs.finalize
def finalize():
- jukebox.cfghandler.load_yaml(cfg_rfid, cfg_main.getn('rfid', 'reader_config'))
-
- # Load all the required modules
- # Start a ReaderRunner-Thread for each Reader
- for reader_cfg_key in cfg_rfid['rfid']['readers'].keys():
- _READERS[reader_cfg_key] = ReaderRunner(reader_cfg_key)
- for reader_cfg_key in cfg_rfid['rfid']['readers'].keys():
- _READERS[reader_cfg_key].start()
+ try:
+ reader_config_file = cfg_main.getn('rfid', 'reader_config')
+ jukebox.cfghandler.load_yaml(cfg_rfid, reader_config_file)
+ except FileNotFoundError:
+ cfg_rfid.config_dict({'rfid': {'readers': {}}})
+ log.warning(f"rfid reader database file not found. Creating empty database: '{reader_config_file}'")
+ # Save the empty rfid reader database, to make sure we can create the file and have access to it
+ cfg_rfid.save(only_if_changed=False)
+
+ if 'rfid' in cfg_rfid and 'readers' in cfg_rfid['rfid']:
+ # Load all the required modules
+ # Start a ReaderRunner-Thread for each Reader
+ for reader_cfg_key in cfg_rfid['rfid']['readers'].keys():
+ _READERS[reader_cfg_key] = ReaderRunner(reader_cfg_key)
+ for reader_cfg_key in cfg_rfid['rfid']['readers'].keys():
+ _READERS[reader_cfg_key].start()
@plugs.atexit
From dbfd58ab7beff1907317534ecc6ed77ae6b6fc54 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Sun, 3 Dec 2023 13:18:03 +0100
Subject: [PATCH 028/121] Bump libzmq version to 4.3.5 for armv7
---
installation/routines/setup_jukebox_core.sh | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index e6dfa6d8f..272901de1 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# Constants
-GD_ID_COMPILED_LIBZMQ_ARMV7="1KP6BqLF-i2dCUsHhOUpOwwuOmKsB5GKY" # ARMv7: https://drive.google.com/file/d/1KP6BqLF-i2dCUsHhOUpOwwuOmKsB5GKY/view?usp=sharing
+GD_ID_COMPILED_LIBZMQ_ARMV7="1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F" # ARMv7: https://drive.google.com/file/d/1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F/view?usp=sharing
GD_ID_COMPILED_LIBZMQ_ARMV6="1iygOm-G1cg_3YERuVRT6FhGBE34ZkwgV" # ARMv6: https://drive.google.com/file/d/1iygOm-G1cg_3YERuVRT6FhGBE34ZkwgV/view?usp=sharing
GD_ID_COMPILED_PYZMQ_ARMV7=""
GD_ID_COMPILED_PYZMQ_ARMV6="1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n" # https://drive.google.com/file/d/1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n/view?usp=sharing
From f1558a2f2cc9d4c9d5adc6d9bf6956c0e72a51bf Mon Sep 17 00:00:00 2001
From: s-martin
Date: Mon, 4 Dec 2023 08:20:55 +0100
Subject: [PATCH 029/121] Add badges to future3 (#2133)
* Add badges to future3
* Add python action badge
---
README.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README.md b/README.md
index 3731c7e06..1ada3e8b3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
# RFID Jukebox Version 3 (aka future3)
+
+
+[](https://github.com/MiczFlor/RPi-Jukebox-RFID/actions/workflows/test_docker_debian_v3.yml) [](https://github.com/MiczFlor/RPi-Jukebox-RFID/actions/workflows/pythonpackage_future3.yml)
+
+[](https://matrix.to/#/#phoniebox_community:gitter.im)
+
## What is this?
The exiting, new **Version 3** of the RPi Jukebox RFID. A complete re-write of the Jukebox.
From cf5aa6c92de88396d00a576f6497a6944138c1ab Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Mon, 4 Dec 2023 23:21:24 +0100
Subject: [PATCH 030/121] allow custom username (#2132)
* removed hardcoded references to user "pi"
* removed check userNotPi
* change testuser in workflow and container
* updated docs
* updated comments and docs
* updated comments and docs
* remove extra home_path check
* changes testuser name and group
---
.github/ISSUE_TEMPLATE/bug_template.md | 2 +-
.../test_docker_debian_codename_sub_v3.yml | 14 ++++++----
CONTRIBUTING.md | 6 ++--
ci/ci-debian.Dockerfile | 18 ++----------
ci/installation/run_install_user_not_pi.sh | 25 -----------------
documentation/builders/autohotspot.md | 2 +-
documentation/builders/installation.md | 4 +--
documentation/builders/system.md | 7 ++---
documentation/developers/known-issues.md | 4 +--
installation/install-jukebox.sh | 28 -------------------
installation/routines/setup_autohotspot.sh | 5 +++-
installation/routines/setup_jukebox_webapp.sh | 1 +
resources/autohotspot/autohotspot.timer | 4 +--
.../default-settings/jukebox.default.yaml | 2 +-
resources/default-settings/nginx.default | 8 +++---
src/webapp/src/config.js | 4 +--
16 files changed, 36 insertions(+), 98 deletions(-)
delete mode 100644 ci/installation/run_install_user_not_pi.sh
diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md
index 1be942778..508cf50b9 100644
--- a/.github/ISSUE_TEMPLATE/bug_template.md
+++ b/.github/ISSUE_TEMPLATE/bug_template.md
@@ -50,7 +50,7 @@ Otherwise the output of `cat /etc/os-release`
i.e. `master`
the following command will help with that
-`cd /home/pi/RPi-Jukebox-RFID/ && git status | head -2`
+`cd ~/RPi-Jukebox-RFID/ && git status | head -2`
-->
### Installscript
diff --git a/.github/workflows/test_docker_debian_codename_sub_v3.yml b/.github/workflows/test_docker_debian_codename_sub_v3.yml
index 54abd142a..97924c4bf 100644
--- a/.github/workflows/test_docker_debian_codename_sub_v3.yml
+++ b/.github/workflows/test_docker_debian_codename_sub_v3.yml
@@ -27,6 +27,10 @@ on:
type: string
default: ubuntu-latest
+env:
+ TEST_USER_NAME: testuser
+ TEST_USER_GROUP: testusergroup
+
# let only one instance run the test so cache is not corrupted.
# cancel already running instances as only the last run will be relevant
concurrency:
@@ -101,6 +105,8 @@ jobs:
cache-to: type=gha,mode=max,scope=${{ steps.vars.outputs.cache_scope }}
build-args: |
DEBIAN_CODENAME=${{ inputs.debian_codename }}
+ USER_NAME=${{ env.TEST_USER_NAME }}
+ USER_GROUP=${{ env.TEST_USER_GROUP }}
GIT_BRANCH=${{ github.head_ref || github.ref_name }}
GIT_USER=${{ github.event.pull_request.head.user.login || github.repository_owner }}
@@ -137,11 +143,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- username: ['pi']
test_script: ['run_install_common.sh', 'run_install_faststartup.sh', 'run_install_webapp_local.sh', 'run_install_webapp_download.sh']
- include:
- - username: hans
- test_script: run_install_user_not_pi.sh
steps:
- name: Set up QEMU
@@ -160,11 +162,11 @@ jobs:
docker load --input ${{ needs.build.outputs.image_file_name }}
# Run test
- - name: Run Test ${{ inputs.debian_codename }}-${{ matrix.username }}-${{ matrix.test_script }}
+ - name: Run Test ${{ inputs.debian_codename }}-${{ env.TEST_USER_NAME }}-${{ matrix.test_script }}
uses: tj-actions/docker-run@v2
with:
image: ${{ needs.build.outputs.image_tag_name }}
- options: --platform ${{ inputs.platform }} --user ${{ matrix.username }} --init
+ options: --platform ${{ inputs.platform }} --user ${{ env.TEST_USER_NAME }} --init
name: ${{ matrix.test_script }}
args: |
./${{ matrix.test_script }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c3bc03705..dbf12f84d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -63,7 +63,7 @@ For bug fixes and improvements just open an issue or PR as described below. If y
* By default this will get you to the `future3/main` branch. You will move to the `future3/develop` branch, do this:
~~~bash
-cd /home/pi/RPi-Jukebox-RFID
+cd ~/RPi-Jukebox-RFID
git checkout future3/develop
git fetch origin
git reset --hard origin/future3/develop
@@ -122,7 +122,7 @@ If you touched *any* Python file (even if only for fixing spelling errors), run
It contains out setup file.
~~~bash
-cd /home/pi/RPi-Jukebox-RFID
+cd ~/RPi-Jukebox-RFID
./run_flake8.sh
~~~
@@ -135,7 +135,7 @@ Tests are very few at the moment, but it cannot hurt to run them. If you have te
them.
~~~bash
-cd /home/pi/RPi-Jukebox-RFID/
+cd ~/RPi-Jukebox-RFID/
./run_pytest.sh
~~~
diff --git a/ci/ci-debian.Dockerfile b/ci/ci-debian.Dockerfile
index 1a227755a..5228d83d5 100644
--- a/ci/ci-debian.Dockerfile
+++ b/ci/ci-debian.Dockerfile
@@ -7,7 +7,7 @@ ARG DEBIAN_CODENAME
ENV TERM=xterm DEBIAN_FRONTEND=noninteractive
ENV CI_RUNNING=true
-# create pi configs to test installation
+# create RPi configs to test installation
RUN touch /boot/config.txt
RUN echo "logo.nologo" > /boot/cmdline.txt
@@ -40,8 +40,8 @@ RUN echo "--- install packages (1) ---" \
RUN echo 'debconf debconf/frontend select Noninteractive' | sudo debconf-set-selections
# ------
-# Base Target for setting up the default user. user can be selected with the docker '--user YYY' option
-FROM base as user
+# Base Target for setting up a test user. user can be selected with the docker '--user YYY' option
+FROM base as test-user
ARG USER_NAME=pi
ARG USER_GROUP=$USER_NAME
ARG USER_ID=1000
@@ -56,18 +56,6 @@ RUN groupadd --gid 1000 $USER_GROUP \
ENV XDG_RUNTIME_DIR=/run/user/$USER_ID DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/$USER_ID/bus
# ------
-
-# Target for setting up an alternativ user 'hans:wurst'. user can be selected with the docker '--user YYY' option
-FROM user as test-user
-
-RUN export USER_ALT=hans \
- && export USER_ALT_GROUP=wurst \
- && groupadd --gid 1001 $USER_ALT_GROUP \
- && useradd -u 1001 -g $USER_ALT_GROUP -G sudo,$TEST_USER_GROUP -d /home/$USER_ALT -m -s /bin/bash -p '$1$iV7TOwOe$6ojkJQXyEA9bHd/SqNLNj0' $USER_ALT \
- && echo "$USER_ALT ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/$USER_ALT
-# ------
-
-
# Target for adding envs and scripts from the repo to test installation
FROM test-user as test-code
ARG GIT_BRANCH
diff --git a/ci/installation/run_install_user_not_pi.sh b/ci/installation/run_install_user_not_pi.sh
deleted file mode 100644
index 76a8cd576..000000000
--- a/ci/installation/run_install_user_not_pi.sh
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-
-# Install Phoniebox and test it
-# Used e.g. for tests on Docker
-
-# Objective: Test installation with script using a simple configuration
-
-SOURCE="${BASH_SOURCE[0]}"
-SCRIPT_DIR="$(dirname "$SOURCE")"
-LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
-LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
-
-# Run installation (in interactive mode)
-# - - Installation must abort early
-
-"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh"
-INSTALLATION_EXITCODE=$?
-
-# only count abortion due to "not user pi" as success
-if [ "${INSTALLATION_EXITCODE}" -eq 2 ]; then
- INSTALLATION_EXITCODE=0
-else
- INSTALLATION_EXITCODE=1
-fi
-exit "${INSTALLATION_EXITCODE}"
diff --git a/documentation/builders/autohotspot.md b/documentation/builders/autohotspot.md
index 7f064cb53..69e6f4d6a 100644
--- a/documentation/builders/autohotspot.md
+++ b/documentation/builders/autohotspot.md
@@ -28,7 +28,7 @@ After connecting to the `Phoniebox_Hotspot` you are able to connect via
ssh to your Jukebox
``` bash
-ssh pi@10.0.0.5
+ssh @10.0.0.5
```
## Changing basic configuration of the hotspot
diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md
index d0befca29..fadc77aac 100644
--- a/documentation/builders/installation.md
+++ b/documentation/builders/installation.md
@@ -16,7 +16,7 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr
* Click `Edit Settings`
* Switch to the `General` tab
* Provide a hostname. (When on Mac, you will be able to use it to connect via SSH)
- * Username currently MUST be `pi`. Other usernames are currently not supported.
+ * Username
* Password
* Wifi
* Set locale settings
@@ -72,7 +72,7 @@ You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to
7. Eject your SD card and insert it into your Raspberry Pi.
8. Start your Raspberry Pi by attaching a power supply.
-9. Login into your Raspberry Pi, username is `pi` and password is `raspberry`.
+9. Login into your Raspberry Pi
If `raspberrypi.local` does not work, find out your Raspberry Pi's IP address from your router.
diff --git a/documentation/builders/system.md b/documentation/builders/system.md
index 5b1ce5c0c..873d489f6 100644
--- a/documentation/builders/system.md
+++ b/documentation/builders/system.md
@@ -10,9 +10,8 @@ The system consists of
4. [Web UI](system.md#web-ui) which is served through an Nginx web server
5. A set of [Configuration Tools](../developers/coreapps.md#configuration-tools) and a set of [Developer Tools](../developers/coreapps.md#developer-tools)
-.. note:: The default install puts everything into the folder `/home/pi/RPi-Jukebox-RFID`.
- Another folder might work, but is certainly not tested. Things are installed for the default user `pi`. Again,
- another user might work, but is not tested.
+.. note:: The default install puts everything into the users home folder `~/RPi-Jukebox-RFID`.
+ Another folder might work, but is certainly not tested.
## Music Player Daemon (MPD)
@@ -102,7 +101,7 @@ Starting and stopping the service can be useful for debugging or configuration c
The Web UI is served using nginx. Nginx runs as a system service. The home directory is localed at
```
-/home/pi/RPi-Jukebox-RFID/src/webapp/build
+~/RPi-Jukebox-RFID/src/webapp/build
```
The Nginx configuration is located at
diff --git a/documentation/developers/known-issues.md b/documentation/developers/known-issues.md
index 598ecd791..2ec52c3c2 100644
--- a/documentation/developers/known-issues.md
+++ b/documentation/developers/known-issues.md
@@ -7,7 +7,7 @@ browser for now.
## Configuration
-In `jukebox.yaml` (and all other config files): do not use relative paths with `~/some/dir`.
-Always use entire explicit path, e.g. `/home/pi/some/dir`.
+In `jukebox.yaml` (and all other config files):
+Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
**Sole** exception is in `playermpd.mpd_conf`.
diff --git a/installation/install-jukebox.sh b/installation/install-jukebox.sh
index b72dd32ff..90f78800f 100755
--- a/installation/install-jukebox.sh
+++ b/installation/install-jukebox.sh
@@ -47,33 +47,6 @@ _check_os_type() {
fi
}
-# currently the user 'pi' is mandatory
-# https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/1785
-_check_user() {
- if [ "${CURRENT_USER}" != "pi" ]; then
- echo
- echo "ERROR: User must be 'pi'!"
- echo " Other usernames are currently not supported."
- echo " Please check the wiki for further information"
- exit 2
- fi
-
- if [ "${HOME_PATH}" != "/home/pi" ]; then
- echo
- echo "ERROR: HomeDir must be '/home/pi'!"
- echo " Other usernames are currently not supported."
- echo " Please check the wiki for further information"
- exit 2
- fi
-
- if [ ! -d "${HOME_PATH}" ]; then
- echo
- echo "ERROR: HomeDir ${HOME_PATH} does not exist."
- echo " Please create it and start again."
- exit 2
- fi
-}
-
# Manipulate file descriptor for logging
# Behavior:
# Write To logfile:
@@ -154,7 +127,6 @@ _load_sources() {
### CHECK PREREQUISITE
_check_os_type
-_check_user
### SETUP LOGGING
_setup_logging
diff --git a/installation/routines/setup_autohotspot.sh b/installation/routines/setup_autohotspot.sh
index a385352dd..cc40b7794 100644
--- a/installation/routines/setup_autohotspot.sh
+++ b/installation/routines/setup_autohotspot.sh
@@ -68,7 +68,10 @@ _other_configuration() {
_install_service_and_timer() {
sudo cp "${INSTALLATION_PATH}"/resources/autohotspot/autohotspot.service /etc/systemd/system/autohotspot.service
sudo systemctl enable autohotspot.service
- sudo cp "${INSTALLATION_PATH}"/resources/autohotspot/autohotspot.timer /etc/cron.d/autohotspot
+
+ local cron_autohotspot_file="/etc/cron.d/autohotspot"
+ sudo cp "${INSTALLATION_PATH}"/resources/autohotspot/autohotspot.timer "${cron_autohotspot_file}"
+ sudo sed -i "s|%%USER%%|${CURRENT_USER}|g" "${cron_autohotspot_file}"
}
_install_autohotspot_script() {
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index df58188fb..54c573654 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -72,6 +72,7 @@ _jukebox_webapp_register_as_system_service_with_nginx() {
sudo mv -f "${WEBAPP_NGINX_SITE_DEFAULT_CONF}" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}.orig"
sudo cp -f "${INSTALLATION_PATH}/resources/default-settings/nginx.default" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
+ sudo sed -i "s|%%INSTALLATION_PATH%%|${INSTALLATION_PATH}|g" "${WEBAPP_NGINX_SITE_DEFAULT_CONF}"
# make sure nginx can access the home directory of the user
sudo chmod o+x "${HOME_PATH}"
diff --git a/resources/autohotspot/autohotspot.timer b/resources/autohotspot/autohotspot.timer
index a35f15757..eb2acaebe 100644
--- a/resources/autohotspot/autohotspot.timer
+++ b/resources/autohotspot/autohotspot.timer
@@ -1,3 +1,3 @@
# cron timer for autohotspot
-*/5 * * * * pi sudo /usr/bin/autohotspot 2>&1 | logger -t autohotspot
-@reboot pi sudo /usr/bin/autohotspot 2>&1 | logger -t autohotspot
+*/5 * * * * %%USER%% sudo /usr/bin/autohotspot 2>&1 | logger -t autohotspot
+@reboot %%USER%% sudo /usr/bin/autohotspot 2>&1 | logger -t autohotspot
diff --git a/resources/default-settings/jukebox.default.yaml b/resources/default-settings/jukebox.default.yaml
index 6e565c684..91ada74c6 100644
--- a/resources/default-settings/jukebox.default.yaml
+++ b/resources/default-settings/jukebox.default.yaml
@@ -1,5 +1,5 @@
# IMPORTANT:
-# Do not use paths with '~/some/dir' - always use '/home/pi/some/dir'
+# Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
# Sole (!) exception is in playermpd.mpd_conf
system:
box_name: Jukebox
diff --git a/resources/default-settings/nginx.default b/resources/default-settings/nginx.default
index b949beb26..d664f4cdd 100644
--- a/resources/default-settings/nginx.default
+++ b/resources/default-settings/nginx.default
@@ -2,7 +2,7 @@ server {
listen 80 default_server;
listen [::]:80 default_server;
- root /home/pi/RPi-Jukebox-RFID/src/webapp/build;
+ root %%INSTALLATION_PATH%%/src/webapp/build;
index index.html index.htm;
@@ -21,7 +21,7 @@ server {
}
location /logs {
- root /home/pi/RPi-Jukebox-RFID/shared;
+ root %%INSTALLATION_PATH%%/shared;
autoindex on;
autoindex_exact_size off;
@@ -31,14 +31,14 @@ server {
}
location @buildwebui {
- root /home/pi/RPi-Jukebox-RFID/resources/html;
+ root %%INSTALLATION_PATH%%/resources/html;
try_files /runbuildui.html =404;
internal;
}
error_page 404 = /404.html;
location /404.html {
- root /home/pi/RPi-Jukebox-RFID/resources/html;
+ root %%INSTALLATION_PATH%%/resources/html;
internal;
}
}
diff --git a/src/webapp/src/config.js b/src/webapp/src/config.js
index 4383a7897..35b5a980e 100644
--- a/src/webapp/src/config.js
+++ b/src/webapp/src/config.js
@@ -17,9 +17,7 @@ const SUBSCRIPTIONS = [
'volume.level',
];
-// TODO: This is not optimal, we should not know about this path here!
-// Let's try to work with relatives paths in the RPC only!
-const DEFAULT_AUDIO_DIR = '/home/pi/RPi-Jukebox-RFID/shared/audiofolders';
+const DEFAULT_AUDIO_DIR = '../../shared/audiofolders';
const ROOT_DIRS = ['./', DEFAULT_AUDIO_DIR];
From 01ec0bca88c974f672175562b5fcbb6d60d219be Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 08:20:39 +0100
Subject: [PATCH 031/121] Allow download of prebuild libzmq-v4.3.5 for Docker
---
docker/jukebox.Dockerfile | 17 ++++--
documentation/developers/known-issues.md | 15 ++++-
documentation/developers/libzmq.md | 68 +++++++++++++++++++++
installation/routines/setup_jukebox_core.sh | 6 +-
4 files changed, 96 insertions(+), 10 deletions(-)
create mode 100644 documentation/developers/libzmq.md
diff --git a/docker/jukebox.Dockerfile b/docker/jukebox.Dockerfile
index 5e7a08915..44c66cc24 100644
--- a/docker/jukebox.Dockerfile
+++ b/docker/jukebox.Dockerfile
@@ -1,7 +1,5 @@
FROM debian:bullseye-slim
-# Prepare Raspberry Pi like environment
-
# These are only dependencies that are required to get as close to the
# Raspberry Pi environment as possible.
RUN apt-get update && apt-get install -y \
@@ -25,7 +23,7 @@ RUN apt-get update && apt-get install -qq -y \
--allow-downgrades --allow-remove-essential --allow-change-held-packages \
gcc at wget \
espeak mpc mpg123 git ffmpeg spi-tools netcat \
- python3 python3-venv python3-dev python3-mutagen
+ python3 python3-venv python3-dev python3-mutagen build-essential
ENV VIRTUAL_ENV=${INSTALLATION_PATH}/.venv
RUN python3 -m venv $VIRTUAL_ENV
@@ -36,7 +34,18 @@ WORKDIR ${HOME}
COPY --chown=${USER}:${USER} . ${INSTALLATION_PATH}/
RUN pip install --no-cache-dir -r ${INSTALLATION_PATH}/requirements.txt
-RUN pip install pyzmq
+
+ENV ZMQ_TMP_DIR libzmq
+ENV ZMQ_VERSION 4.3.5
+ENV ZMQ_PREFIX /usr/local
+
+RUN [ "$(uname -m)" = "aarch64" ] && ARCH="arm64" || ARCH="$(uname -m)"; \
+ wget https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz; \
+ tar -xzf libzmq.tar.gz -C ${ZMQ_PREFIX}; \
+ rm -f libzmq.tar.gz;
+
+RUN export ZMQ_PREFIX=${PREFIX} && export ZMQ_DRAFT_API=1
+RUN pip install -v --no-binary pyzmq --pre pyzmq
EXPOSE 5555 5556
diff --git a/documentation/developers/known-issues.md b/documentation/developers/known-issues.md
index 598ecd791..aec5c027b 100644
--- a/documentation/developers/known-issues.md
+++ b/documentation/developers/known-issues.md
@@ -1,9 +1,18 @@
# Known Issues
-## Browsers
+## Installing limzmq in Docker fails
-The Web UI will **not** work with Firefox, due to an issue with websockets and pyzmq. Please use a different
-browser for now.
+To speed up the Docker build process, we are distributing pre-build versions of libzmq with drafts flag at the latest version. In case the download fails because the respective architecture build does not exist, you can build the version yourself. Just replace the command to download the pre-built library with the following command
+
+```
+# Compile ZMQ
+RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
+ wget https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz; \
+ tar -xzf libzmq.tar.gz; \
+ rm -f libzmq.tar.gz; \
+ zeromq-${ZMQ_VERSION}/configure --prefix=${ZMQ_PREFIX} --enable-drafts; \
+ make && make install
+```
## Configuration
diff --git a/documentation/developers/libzmq.md b/documentation/developers/libzmq.md
new file mode 100644
index 000000000..f4a58f550
--- /dev/null
+++ b/documentation/developers/libzmq.md
@@ -0,0 +1,68 @@
+# `libzmq` for Raspberry Pi
+
+## `libzmp` Releases
+
+The Jukebox requires `libzmq` to work properly. We provide downloadable builds to speed up the installation process of the Phoniebox.
+
+* https://github.com/pabera/libzmq/releases
+
+> [!NOTE]
+> We can't use stable builds that are distributed by zeromq directly because the Jukebox requires draft builds to support WebSockets. These draft builds are not officially provided through zeromq for Raspberry Pi architecture (e.g. `armv6` or `armv7`).
+
+## Building `libzmp`
+
+If you need to update the `libzmq` version in the future, follow these steps.
+
+### Install Cross-Compilation Environment
+
+First, you need to install Dockcross. Dockcross provides Docker images for cross-compilation.
+
+1. **Pull the Dockcross Image**: For Raspberry Pi B, 4 or Zero 2 we need `linux-armv7`, for older models `linux-armv6`. The following example shows how to compile for `armv7` (32 bit, `arm32v7`). If you want to compile for another target, change the commands accordingly. For Docker Development environments, other targets like `arm64` or `x86_64` become relevant.
+
+```bash
+docker pull dockcross/linux-armv7
+```
+
+3. **Create a Dockcross Script**: After pulling the image, you create a Dockcross script which will be used to run the cross-compilation tools in the Docker container.
+
+```bash
+docker run --rm dockcross/linux-armv7 > ./dockcross-linux-armv7
+chmod +x ./dockcross-linux-armv7
+```
+
+This command creates a script named `dockcross-linux-armv7` in your current directory.
+
+### Cross-Compiling libzmq
+
+With Dockcross installed, you can now modify your `libzmq` compilation process to use the Dockcross environment.
+
+1. **Download `libzmq` Source**: Similar to your original process, download the `libzmq` source code:
+
+```bash
+ZMQ_VERSION=4.3.5
+wget https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz
+tar -xzf libzmq.tar.gz
+```
+
+2. **Cross-Compilation using Dockcross**:
+
+Modify your build process to run inside the Dockcross environment:
+
+```bash
+./dockcross-linux-armv7 bash -c '\
+cd zeromq-${ZMQ_VERSION} && \
+./configure --prefix=/usr/local --enable-drafts && \
+make -j$(nproc) && \
+make install DESTDIR=$(pwd)/../installed'
+```
+
+> [!NOTE]
+> In the script above, you need to update ${ZMQ_VERSION} to the actual value as the script does not jave access to your host machine ENV variables.
+
+This command configures and builds `libzmq` inside the Docker container. The `DESTDIR` variable is used to specify where to install the files inside the container.
+
+3. **Compress the Compiled Binaries**: After compilation, the binaries are located in the `installed` directory inside your `zeromq-${ZMQ_VERSION}` directory.
+
+```
+tar -czvf libzmq5-armv7-${ZMQ_VERSION}.tar.gz -C installed/usr/local --exclude='.' include lib
+```
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index 272901de1..2ef0a0a04 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -1,10 +1,10 @@
#!/usr/bin/env bash
# Constants
-GD_ID_COMPILED_LIBZMQ_ARMV7="1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F" # ARMv7: https://drive.google.com/file/d/1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F/view?usp=sharing
-GD_ID_COMPILED_LIBZMQ_ARMV6="1iygOm-G1cg_3YERuVRT6FhGBE34ZkwgV" # ARMv6: https://drive.google.com/file/d/1iygOm-G1cg_3YERuVRT6FhGBE34ZkwgV/view?usp=sharing
-GD_ID_COMPILED_PYZMQ_ARMV7=""
+GD_ID_COMPILED_LIBZMQ_ARMV6="17VTgriCsYmAm72YKkga97jO0nExtq6G-" # armv6: https://drive.google.com/file/d/17VTgriCsYmAm72YKkga97jO0nExtq6G-/view?usp=sharing
+GD_ID_COMPILED_LIBZMQ_ARMV7="1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F" # armv7: https://drive.google.com/file/d/1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F/view?usp=sharing
GD_ID_COMPILED_PYZMQ_ARMV6="1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n" # https://drive.google.com/file/d/1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n/view?usp=sharing
+GD_ID_COMPILED_PYZMQ_ARMV7=""
ZMQ_TMP_DIR="libzmq"
ZMQ_PREFIX="/usr/local"
From 8ea49cf49508f389d6ba83d50787539950532e79 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 08:31:40 +0100
Subject: [PATCH 032/121] Remove unnecessary build-essentials from apt-get in
Dockerfile
---
docker/jukebox.Dockerfile | 2 +-
documentation/developers/known-issues.md | 6 ++++--
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/docker/jukebox.Dockerfile b/docker/jukebox.Dockerfile
index 44c66cc24..f842a7394 100644
--- a/docker/jukebox.Dockerfile
+++ b/docker/jukebox.Dockerfile
@@ -23,7 +23,7 @@ RUN apt-get update && apt-get install -qq -y \
--allow-downgrades --allow-remove-essential --allow-change-held-packages \
gcc at wget \
espeak mpc mpg123 git ffmpeg spi-tools netcat \
- python3 python3-venv python3-dev python3-mutagen build-essential
+ python3 python3-venv python3-dev python3-mutagen
ENV VIRTUAL_ENV=${INSTALLATION_PATH}/.venv
RUN python3 -m venv $VIRTUAL_ENV
diff --git a/documentation/developers/known-issues.md b/documentation/developers/known-issues.md
index 32c3e2cd2..25e8b73d2 100644
--- a/documentation/developers/known-issues.md
+++ b/documentation/developers/known-issues.md
@@ -2,7 +2,9 @@
## Installing limzmq in Docker fails
-To speed up the Docker build process, we are distributing pre-build versions of libzmq with drafts flag at the latest version. In case the download fails because the respective architecture build does not exist, you can build the version yourself. Just replace the command to download the pre-built library with the following command
+To speed up the Docker build process, we are distributing pre-build versions of libzmq with drafts flag at the latest version. In case the download fails because the respective architecture build does not exist, you can build the version yourself.
+
+Add `build-essential` to tbe installed additionally with `apt-get`. Additionally, replace the command to download the pre-built library with the following command.
```
# Compile ZMQ
@@ -16,7 +18,7 @@ RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
## Configuration
-In `jukebox.yaml` (and all other config files):
+In `jukebox.yaml` (and all other config files):
Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
**Sole** exception is in `playermpd.mpd_conf`.
From a32b771014d6a9ee666326ec865b86a1f8bc527e Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 08:42:03 +0100
Subject: [PATCH 033/121] Fix a few typos
---
documentation/developers/known-issues.md | 2 +-
documentation/developers/libzmq.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/developers/known-issues.md b/documentation/developers/known-issues.md
index 25e8b73d2..cdaf35d4f 100644
--- a/documentation/developers/known-issues.md
+++ b/documentation/developers/known-issues.md
@@ -4,7 +4,7 @@
To speed up the Docker build process, we are distributing pre-build versions of libzmq with drafts flag at the latest version. In case the download fails because the respective architecture build does not exist, you can build the version yourself.
-Add `build-essential` to tbe installed additionally with `apt-get`. Additionally, replace the command to download the pre-built library with the following command.
+Add `build-essential` to be installed additionally with `apt-get`. Additionally, replace the command to download the pre-built library with the following command.
```
# Compile ZMQ
diff --git a/documentation/developers/libzmq.md b/documentation/developers/libzmq.md
index f4a58f550..3407d971e 100644
--- a/documentation/developers/libzmq.md
+++ b/documentation/developers/libzmq.md
@@ -7,7 +7,7 @@ The Jukebox requires `libzmq` to work properly. We provide downloadable builds t
* https://github.com/pabera/libzmq/releases
> [!NOTE]
-> We can't use stable builds that are distributed by zeromq directly because the Jukebox requires draft builds to support WebSockets. These draft builds are not officially provided through zeromq for Raspberry Pi architecture (e.g. `armv6` or `armv7`).
+> We can't use stable builds that are distributed by [zeromq](https://github.com/zeromq/libzmq/releases) directly because the Jukebox requires draft builds to support WebSockets. These [draft builds](https://pyzmq.readthedocs.io/en/latest/howto/draft.html) are not officially provided through zeromq for Raspberry Pi architecture (e.g. `armv6` or `armv7`).
## Building `libzmp`
From 78eb0c45e5aac46f707ecc862f24e663dcc0b208 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 09:04:39 +0100
Subject: [PATCH 034/121] Use wget to download pre-built libzmq from github
---
documentation/developers/known-issues.md | 2 +-
installation/includes/02_helpers.sh | 15 +++++++++++++++
installation/routines/setup_jukebox_core.sh | 18 +++++++++---------
3 files changed, 25 insertions(+), 10 deletions(-)
diff --git a/documentation/developers/known-issues.md b/documentation/developers/known-issues.md
index cdaf35d4f..1460c1cb4 100644
--- a/documentation/developers/known-issues.md
+++ b/documentation/developers/known-issues.md
@@ -1,6 +1,6 @@
# Known Issues
-## Installing limzmq in Docker fails
+## Installing `libzmq` in Docker fails
To speed up the Docker build process, we are distributing pre-build versions of libzmq with drafts flag at the latest version. In case the download fails because the respective architecture build does not exist, you can build the version yourself.
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index 4a39ae07e..2da629468 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -34,6 +34,21 @@ run_with_log_frame() {
echo "#########################################################"
}
+get_architecture() {
+ ARCH=""
+ if [ "$(uname -m)" = "armv7l" ]; then
+ ARCH="armv7"
+ elif [ "$(uname -m)" = "armv6l" ]; then
+ ARCH="armv6"
+ elif [ "$(uname -m)" = "aarch64" ]; then
+ ARCH="arm64"
+ else
+ ARCH="$(uname -m)"
+ fi
+
+ echo $ARCH
+}
+
_download_file_from_google_drive() {
GD_SHARING_ID=${1}
TAR_FILENAME=${2}
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index dbe5d9115..a62b398ca 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -8,6 +8,7 @@ GD_ID_COMPILED_PYZMQ_ARMV7=""
ZMQ_TMP_DIR="libzmq"
ZMQ_PREFIX="/usr/local"
+ZMQ_VERSION="4.3.5"
JUKEBOX_PULSE_CONFIG="${HOME_PATH}"/.config/pulse/default.pa
JUKEBOX_SERVICE_NAME="${SYSTEMD_USR_PATH}/jukebox-daemon.service"
@@ -52,9 +53,10 @@ _jukebox_core_configure_pulseaudio() {
}
_jukebox_core_build_libzmq_with_drafts() {
- LIBSODIUM_VERSION="1.0.18"
- ZMQ_VERSION="4.3.4"
+ echo " Building libzmq with drafts support" | tee /dev/fd/3
+ LIBSODIUM_VERSION="1.0.18"
+ echo " Building libsodium v${LIBSODIUM_VERSION}" | tee /dev/fd/3
{ cd "${HOME_PATH}" && mkdir "${ZMQ_TMP_DIR}" && cd "${ZMQ_TMP_DIR}"; } || exit_on_error
wget --quiet https://github.com/jedisct1/libsodium/releases/download/${LIBSODIUM_VERSION}-RELEASE/libsodium-${LIBSODIUM_VERSION}.tar.gz
tar -zxvf libsodium-${LIBSODIUM_VERSION}.tar.gz
@@ -62,6 +64,7 @@ _jukebox_core_build_libzmq_with_drafts() {
./configure
make && make install
+ echo " Building libzmq v${ZMQ_VERSION}" | tee /dev/fd/3
cd "${HOME}/${ZMQ_TMP_DIR}" || exit_on_error
wget https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz
tar -xzf libzmq.tar.gz
@@ -71,8 +74,9 @@ _jukebox_core_build_libzmq_with_drafts() {
_jukebox_core_download_prebuilt_libzmq_with_drafts() {
local ZMQ_TAR_FILENAME="libzmq.tar.gz"
+ ARCH=$(get_architecture)
- _download_file_from_google_drive "${LIBZMQ_GD_DOWNLOAD_ID}" "${ZMQ_TAR_FILENAME}"
+ wget https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O ${ZMQ_TAR_FILENAME}
tar -xzf ${ZMQ_TAR_FILENAME}
rm -f ${ZMQ_TAR_FILENAME}
sudo rsync -a ./* ${ZMQ_PREFIX}/
@@ -86,7 +90,7 @@ _jukebox_core_build_and_install_pyzmq() {
# Sources:
# https://pyzmq.readthedocs.io/en/latest/howto/draft.html
# https://github.com/MonsieurV/ZeroMQ-RPi/blob/master/README.md
- echo " Build and install pyzmq with WebSockets Support" | tee /dev/fd/3
+ echo " Install pyzmq with WebSockets Support" | tee /dev/fd/3
if ! pip list | grep -F pyzmq >> /dev/null; then
# Download pre-compiled libzmq from Google Drive because RPi has trouble compiling it
@@ -94,11 +98,7 @@ _jukebox_core_build_and_install_pyzmq() {
{ cd "${HOME_PATH}" && mkdir "${ZMQ_TMP_DIR}" && cd "${ZMQ_TMP_DIR}"; } || exit_on_error
- # ARMv7 as default
- LIBZMQ_GD_DOWNLOAD_ID=${GD_ID_COMPILED_LIBZMQ_ARMV7}
if [[ $(uname -m) == "armv6l" ]]; then
- # ARMv6 as fallback
- LIBZMQ_GD_DOWNLOAD_ID=${GD_ID_COMPILED_LIBZMQ_ARMV6}
_show_slow_hardware_message
fi
@@ -109,7 +109,7 @@ _jukebox_core_build_and_install_pyzmq() {
fi
ZMQ_PREFIX="${ZMQ_PREFIX}" ZMQ_DRAFT_API=1 \
- pip install --no-cache-dir --no-binary "pyzmq" --pre pyzmq
+ pip install -v --no-binary pyzmq --pre pyzmq
else
echo " Skipping. pyzmq already installed" | tee /dev/fd/3
fi
From 5a875b87116a3e3151173d1acc271073c30b0a55 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 09:05:39 +0100
Subject: [PATCH 035/121] Remove unused constants
---
installation/routines/setup_jukebox_core.sh | 5 -----
1 file changed, 5 deletions(-)
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index a62b398ca..0568feb64 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -1,11 +1,6 @@
#!/usr/bin/env bash
# Constants
-GD_ID_COMPILED_LIBZMQ_ARMV6="17VTgriCsYmAm72YKkga97jO0nExtq6G-" # armv6: https://drive.google.com/file/d/17VTgriCsYmAm72YKkga97jO0nExtq6G-/view?usp=sharing
-GD_ID_COMPILED_LIBZMQ_ARMV7="1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F" # armv7: https://drive.google.com/file/d/1950psO7Mbs4GdWBMqIzdTAZPLnKhDg7F/view?usp=sharing
-GD_ID_COMPILED_PYZMQ_ARMV6="1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n" # https://drive.google.com/file/d/1lDsV_pVcXbg6YReHb9AldMkyRZCpc6-n/view?usp=sharing
-GD_ID_COMPILED_PYZMQ_ARMV7=""
-
ZMQ_TMP_DIR="libzmq"
ZMQ_PREFIX="/usr/local"
ZMQ_VERSION="4.3.5"
From 54681dabf22de96e2c17dbc37003b123c8091785 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Tue, 5 Dec 2023 11:24:50 +0100
Subject: [PATCH 036/121] Make variable local to its function
---
installation/includes/02_helpers.sh | 12 ++++++------
installation/routines/setup_jukebox_core.sh | 6 ++----
2 files changed, 8 insertions(+), 10 deletions(-)
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index 2da629468..1294d5bc6 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -35,18 +35,18 @@ run_with_log_frame() {
}
get_architecture() {
- ARCH=""
+ local arch=""
if [ "$(uname -m)" = "armv7l" ]; then
- ARCH="armv7"
+ arch="armv7"
elif [ "$(uname -m)" = "armv6l" ]; then
- ARCH="armv6"
+ arch="armv6"
elif [ "$(uname -m)" = "aarch64" ]; then
- ARCH="arm64"
+ arch="arm64"
else
- ARCH="$(uname -m)"
+ arch="$(uname -m)"
fi
- echo $ARCH
+ echo $arch
}
_download_file_from_google_drive() {
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index 0568feb64..353607c12 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -68,6 +68,7 @@ _jukebox_core_build_libzmq_with_drafts() {
}
_jukebox_core_download_prebuilt_libzmq_with_drafts() {
+ echo " Download pre-compiled libzmq"
local ZMQ_TAR_FILENAME="libzmq.tar.gz"
ARCH=$(get_architecture)
@@ -85,12 +86,9 @@ _jukebox_core_build_and_install_pyzmq() {
# Sources:
# https://pyzmq.readthedocs.io/en/latest/howto/draft.html
# https://github.com/MonsieurV/ZeroMQ-RPi/blob/master/README.md
- echo " Install pyzmq with WebSockets Support" | tee /dev/fd/3
+ echo " Install pyzmq with libzmq-drafts to support WebSockets" | tee /dev/fd/3
if ! pip list | grep -F pyzmq >> /dev/null; then
- # Download pre-compiled libzmq from Google Drive because RPi has trouble compiling it
- echo " Download pre-compiled libzmq from Google Drive because RPi has trouble compiling it"
-
{ cd "${HOME_PATH}" && mkdir "${ZMQ_TMP_DIR}" && cd "${ZMQ_TMP_DIR}"; } || exit_on_error
if [[ $(uname -m) == "armv6l" ]]; then
From ade28940c9da12e187ec5f58bf9762ebf5e05bd9 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Thu, 7 Dec 2023 17:23:49 +0100
Subject: [PATCH 037/121] Install webapp from release build if Node.JS download
is aborted
---
installation/routines/customize_options.sh | 1 +
1 file changed, 1 insertion(+)
diff --git a/installation/routines/customize_options.sh b/installation/routines/customize_options.sh
index 50df075fe..1590383d1 100644
--- a/installation/routines/customize_options.sh
+++ b/installation/routines/customize_options.sh
@@ -303,6 +303,7 @@ Do you want to install Node? [Y/n]" 1>&3
case "$response" in
[nN][oO]|[nN])
ENABLE_INSTALL_NODE=false
+ ENABLE_WEBAPP_PROD_DOWNLOAD=true
;;
*)
;;
From c3d08977b93c99733d86fda9c9e839e8231105d4 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Thu, 7 Dec 2023 22:32:30 +0100
Subject: [PATCH 038/121] Use GH release downloads for webapp
---
installation/includes/02_helpers.sh | 22 ++++++++++++++-----
installation/routines/setup_jukebox_core.sh | 4 ++--
installation/routines/setup_jukebox_webapp.sh | 5 +++--
installation/routines/setup_samba.sh | 2 +-
4 files changed, 22 insertions(+), 11 deletions(-)
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index 1294d5bc6..92d6754e0 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -49,14 +49,24 @@ get_architecture() {
echo $arch
}
-_download_file_from_google_drive() {
- GD_SHARING_ID=${1}
- TAR_FILENAME=${2}
- wget --load-cookies /tmp/cookies.txt "https://docs.google.com/uc?export=download&confirm=$(wget --save-cookies /tmp/cookies.txt --keep-session-cookies --no-check-certificate 'https://docs.google.com/uc?export=download&id=${GD_SHARING_ID}' -O- | sed -rn 's/.*confirm=([0-9A-Za-z_]+).*/\1\n/p')&id=${GD_SHARING_ID}" -O ${TAR_FILENAME} && rm -rf /tmp/cookies.txt
- echo "Downloaded from Google Drive ID ${GD_SHARING_ID} into ${TAR_FILENAME}"
+get_version_string() {
+ local python_file="$1"
+ local version_major
+ local version_minor
+ local version_patch
+
+ version_major=$(grep 'VERSION_MAJOR\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
+ version_minor=$(grep 'VERSION_MINOR\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
+ version_patch=$(grep 'VERSION_PATCH\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
+
+ if [ -n "$version_major" ] && [ -n "$version_minor" ] && [ -n "$version_patch" ]; then
+ local version_string="${version_major}.${version_minor}.${version_patch}"
+ echo "$version_string"
+ else
+ echo "Unable to extract version information from $python_file"
+ fi
}
-
### Verify helpers
print_verify_installation() {
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index 353607c12..efdb6c168 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -61,7 +61,7 @@ _jukebox_core_build_libzmq_with_drafts() {
echo " Building libzmq v${ZMQ_VERSION}" | tee /dev/fd/3
cd "${HOME}/${ZMQ_TMP_DIR}" || exit_on_error
- wget https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz
+ wget --quiet https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz
tar -xzf libzmq.tar.gz
zeromq-${ZMQ_VERSION}/configure --prefix=${ZMQ_PREFIX} --enable-drafts
make && make install
@@ -72,7 +72,7 @@ _jukebox_core_download_prebuilt_libzmq_with_drafts() {
local ZMQ_TAR_FILENAME="libzmq.tar.gz"
ARCH=$(get_architecture)
- wget https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O ${ZMQ_TAR_FILENAME}
+ wget --quiet https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O ${ZMQ_TAR_FILENAME}
tar -xzf ${ZMQ_TAR_FILENAME}
rm -f ${ZMQ_TAR_FILENAME}
sudo rsync -a ./* ${ZMQ_PREFIX}/
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index 54c573654..b7837c29a 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -1,7 +1,6 @@
#!/usr/bin/env bash
# Constants
-GD_ID_COMPILED_WEBAPP="1um-smyfsVPzVZn18hhwuFt97XR3PjAbB" # https://drive.google.com/file/d/1um-smyfsVPzVZn18hhwuFt97XR3PjAbB/view?usp=sharing
WEBAPP_NGINX_SITE_DEFAULT_CONF="/etc/nginx/sites-available/default"
# For ARMv7+
@@ -56,9 +55,11 @@ _jukebox_webapp_build() {
_jukebox_webapp_download() {
echo " Downloading web application" | tee /dev/fd/3
+ local JUKEBOX_VERSION==$(get_version_string "${INSTALLATION_PATH}/src/jukebox/jukebox/version.py")
local TAR_FILENAME="webapp-build.tar.gz"
+
cd "${INSTALLATION_PATH}/src/webapp" || exit_on_error
- _download_file_from_google_drive ${GD_ID_COMPILED_WEBAPP} ${TAR_FILENAME}
+ wget --quiet ${GIT_URL}/releases/download/v${JUKEBOX_VERSION}/webapp-v${JUKEBOX_VERSION}.tar.gz -O ${TAR_FILENAME}
tar -xzf ${TAR_FILENAME}
rm -f ${TAR_FILENAME}
cd "${INSTALLATION_PATH}" || exit_on_error
diff --git a/installation/routines/setup_samba.sh b/installation/routines/setup_samba.sh
index 4b45b54e1..100d7370d 100644
--- a/installation/routines/setup_samba.sh
+++ b/installation/routines/setup_samba.sh
@@ -31,7 +31,7 @@ _samba_set_user() {
sudo cat << EOF >> $SMB_CONF
${SMB_CONF_HEADER}
[phoniebox]
- comment= Pi Jukebox
+ comment=Pi Jukebox
path=${SHARED_PATH}
browseable=Yes
writeable=Yes
From 3ffe8a3598b3f328152aff2bb492d4ca0b12d274 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Thu, 7 Dec 2023 22:55:57 +0100
Subject: [PATCH 039/121] Bugfix: wrong variable assignment
---
installation/includes/02_helpers.sh | 11 +++++------
installation/routines/setup_jukebox_webapp.sh | 2 +-
2 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index 92d6754e0..c0a9aa0d1 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -55,20 +55,19 @@ get_version_string() {
local version_minor
local version_patch
- version_major=$(grep 'VERSION_MAJOR\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
- version_minor=$(grep 'VERSION_MINOR\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
- version_patch=$(grep 'VERSION_PATCH\s*=\s*[0-9]*' "$python_file" | awk -F= '{print $2}' | tr -d ' ')
+ version_major=$(grep 'VERSION_MAJOR\s*=\s*[0-9]*' "${python_file}" | awk -F= '{print $2}' | tr -d ' ')
+ version_minor=$(grep 'VERSION_MINOR\s*=\s*[0-9]*' "${python_file}" | awk -F= '{print $2}' | tr -d ' ')
+ version_patch=$(grep 'VERSION_PATCH\s*=\s*[0-9]*' "${python_file}" | awk -F= '{print $2}' | tr -d ' ')
if [ -n "$version_major" ] && [ -n "$version_minor" ] && [ -n "$version_patch" ]; then
local version_string="${version_major}.${version_minor}.${version_patch}"
- echo "$version_string"
+ echo "Jukebox Version: ${version_string}"
else
- echo "Unable to extract version information from $python_file"
+ echo "Unable to extract version information from ${python_file}"
fi
}
### Verify helpers
-
print_verify_installation() {
echo ""
echo " -------------------------------------------------------"
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index b7837c29a..881b27468 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -55,7 +55,7 @@ _jukebox_webapp_build() {
_jukebox_webapp_download() {
echo " Downloading web application" | tee /dev/fd/3
- local JUKEBOX_VERSION==$(get_version_string "${INSTALLATION_PATH}/src/jukebox/jukebox/version.py")
+ local JUKEBOX_VERSION=$(get_version_string "${INSTALLATION_PATH}/src/jukebox/jukebox/version.py")
local TAR_FILENAME="webapp-build.tar.gz"
cd "${INSTALLATION_PATH}/src/webapp" || exit_on_error
From bdb1dd1b7c30260b681508c112b38755c7644002 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Fri, 8 Dec 2023 09:07:00 +0100
Subject: [PATCH 040/121] Static release download url
---
installation/routines/setup_jukebox_webapp.sh | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh
index 881b27468..9dc74bf12 100644
--- a/installation/routines/setup_jukebox_webapp.sh
+++ b/installation/routines/setup_jukebox_webapp.sh
@@ -57,9 +57,12 @@ _jukebox_webapp_download() {
echo " Downloading web application" | tee /dev/fd/3
local JUKEBOX_VERSION=$(get_version_string "${INSTALLATION_PATH}/src/jukebox/jukebox/version.py")
local TAR_FILENAME="webapp-build.tar.gz"
+ local DOWNLOAD_URL="https://github.com/MiczFlor/RPi-Jukebox-RFID/releases/download/v${JUKEBOX_VERSION}/webapp-v${JUKEBOX_VERSION}.tar.gz"
+ echo " DOWNLOAD_URL: ${DOWNLOAD_URL}"
cd "${INSTALLATION_PATH}/src/webapp" || exit_on_error
- wget --quiet ${GIT_URL}/releases/download/v${JUKEBOX_VERSION}/webapp-v${JUKEBOX_VERSION}.tar.gz -O ${TAR_FILENAME}
+ # URL must be set to default repo as installation can be run from different repos as well where releases may not exist
+ wget --quiet ${DOWNLOAD_URL} -O ${TAR_FILENAME}
tar -xzf ${TAR_FILENAME}
rm -f ${TAR_FILENAME}
cd "${INSTALLATION_PATH}" || exit_on_error
From caf4a5525fa3f4d50a0ecff1870abb9d5b9f21d3 Mon Sep 17 00:00:00 2001
From: pabera <1260686+pabera@users.noreply.github.com>
Date: Fri, 8 Dec 2023 09:33:09 +0100
Subject: [PATCH 041/121] Fix version funtion return value
---
installation/includes/02_helpers.sh | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh
index c0a9aa0d1..a8deca9c3 100644
--- a/installation/includes/02_helpers.sh
+++ b/installation/includes/02_helpers.sh
@@ -61,9 +61,9 @@ get_version_string() {
if [ -n "$version_major" ] && [ -n "$version_minor" ] && [ -n "$version_patch" ]; then
local version_string="${version_major}.${version_minor}.${version_patch}"
- echo "Jukebox Version: ${version_string}"
+ echo ${version_string}
else
- echo "Unable to extract version information from ${python_file}"
+ exit_on_error "ERROR: Unable to extract version information from ${python_file}"
fi
}
From 554c0ed0b87717dc90e76794dd63f871ae83e1f6 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Fri, 8 Dec 2023 08:26:19 +0100
Subject: [PATCH 042/121] fix local libzmq build
fix folder handling ZMQ_TMP_DIR.
remove libsodium (use internal encryption lib tweetnacl).
add cpu_count.
add --disable-Werror.
add sudo to make install.
update log messaages.
---
installation/routines/setup_jukebox_core.sh | 38 +++++++++------------
1 file changed, 17 insertions(+), 21 deletions(-)
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index efdb6c168..b02b8418b 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# Constants
-ZMQ_TMP_DIR="libzmq"
+ZMQ_TMP_DIR="${HOME_PATH}/libzmq"
ZMQ_PREFIX="/usr/local"
ZMQ_VERSION="4.3.5"
@@ -48,30 +48,26 @@ _jukebox_core_configure_pulseaudio() {
}
_jukebox_core_build_libzmq_with_drafts() {
- echo " Building libzmq with drafts support" | tee /dev/fd/3
-
- LIBSODIUM_VERSION="1.0.18"
- echo " Building libsodium v${LIBSODIUM_VERSION}" | tee /dev/fd/3
- { cd "${HOME_PATH}" && mkdir "${ZMQ_TMP_DIR}" && cd "${ZMQ_TMP_DIR}"; } || exit_on_error
- wget --quiet https://github.com/jedisct1/libsodium/releases/download/${LIBSODIUM_VERSION}-RELEASE/libsodium-${LIBSODIUM_VERSION}.tar.gz
- tar -zxvf libsodium-${LIBSODIUM_VERSION}.tar.gz
- cd libsodium-${LIBSODIUM_VERSION} || exit_on_error
- ./configure
- make && make install
-
- echo " Building libzmq v${ZMQ_VERSION}" | tee /dev/fd/3
- cd "${HOME}/${ZMQ_TMP_DIR}" || exit_on_error
- wget --quiet https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/zeromq-${ZMQ_VERSION}.tar.gz -O libzmq.tar.gz
- tar -xzf libzmq.tar.gz
- zeromq-${ZMQ_VERSION}/configure --prefix=${ZMQ_PREFIX} --enable-drafts
- make && make install
+ echo " Building libzmq v${ZMQ_VERSION} with drafts support" | tee /dev/fd/3
+ local zmq_filename="zeromq-${ZMQ_VERSION}"
+ local zmq_tar_filename="${zmq_filename}.tar.gz"
+ local cpu_count=${CPU_COUNT:-$(python3 -c "import os; print(os.cpu_count())")}
+
+ cd "${ZMQ_TMP_DIR}" || exit_on_error
+ wget --quiet https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/${zmq_tar_filename}
+ tar -xzf ${zmq_tar_filename}
+ rm -f ${zmq_tar_filename}
+ cd ${zmq_filename} || exit_on_error
+ ./configure --prefix=${ZMQ_PREFIX} --enable-drafts --disable-Werror
+ make -j${cpu_count} && sudo make install
}
_jukebox_core_download_prebuilt_libzmq_with_drafts() {
- echo " Download pre-compiled libzmq"
+ echo " Download pre-compiled libzmq with drafts support"
local ZMQ_TAR_FILENAME="libzmq.tar.gz"
ARCH=$(get_architecture)
+ cd "${ZMQ_TMP_DIR}" || exit_on_error
wget --quiet https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O ${ZMQ_TAR_FILENAME}
tar -xzf ${ZMQ_TAR_FILENAME}
rm -f ${ZMQ_TAR_FILENAME}
@@ -89,12 +85,12 @@ _jukebox_core_build_and_install_pyzmq() {
echo " Install pyzmq with libzmq-drafts to support WebSockets" | tee /dev/fd/3
if ! pip list | grep -F pyzmq >> /dev/null; then
- { cd "${HOME_PATH}" && mkdir "${ZMQ_TMP_DIR}" && cd "${ZMQ_TMP_DIR}"; } || exit_on_error
if [[ $(uname -m) == "armv6l" ]]; then
_show_slow_hardware_message
fi
+ mkdir -p "${ZMQ_TMP_DIR}" || exit_on_error
if [ "$BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE" = true ] ; then
_jukebox_core_build_libzmq_with_drafts
else
@@ -151,8 +147,8 @@ _jukebox_core_check() {
_run_setup_jukebox_core() {
_jukebox_core_install_os_dependencies
_jukebox_core_install_python_requirements
- _jukebox_core_configure_pulseaudio
_jukebox_core_build_and_install_pyzmq
+ _jukebox_core_configure_pulseaudio
_jukebox_core_install_settings
_jukebox_core_register_as_service
_jukebox_core_check
From 435bd6fdf0dcc8c074c901c7afad4a777e23d016 Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Fri, 8 Dec 2023 08:26:19 +0100
Subject: [PATCH 043/121] add CI test for local libzmq build
---
.../test_docker_debian_codename_sub_v3.yml | 2 +-
ci/installation/run_install_libzmq_local.sh | 40 +++++++++++++++++++
installation/includes/01_default_config.sh | 2 +-
3 files changed, 42 insertions(+), 2 deletions(-)
create mode 100644 ci/installation/run_install_libzmq_local.sh
diff --git a/.github/workflows/test_docker_debian_codename_sub_v3.yml b/.github/workflows/test_docker_debian_codename_sub_v3.yml
index 97924c4bf..b4df11b3c 100644
--- a/.github/workflows/test_docker_debian_codename_sub_v3.yml
+++ b/.github/workflows/test_docker_debian_codename_sub_v3.yml
@@ -143,7 +143,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- test_script: ['run_install_common.sh', 'run_install_faststartup.sh', 'run_install_webapp_local.sh', 'run_install_webapp_download.sh']
+ test_script: ['run_install_common.sh', 'run_install_faststartup.sh', 'run_install_webapp_local.sh', 'run_install_webapp_download.sh', 'run_install_libzmq_local.sh']
steps:
- name: Set up QEMU
diff --git a/ci/installation/run_install_libzmq_local.sh b/ci/installation/run_install_libzmq_local.sh
new file mode 100644
index 000000000..20f246ff8
--- /dev/null
+++ b/ci/installation/run_install_libzmq_local.sh
@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# Install Phoniebox and test it
+# Used e.g. for tests on Docker
+
+# Objective:
+# Test for the libzmq local build (no precompiled download)
+
+SOURCE="${BASH_SOURCE[0]}"
+SCRIPT_DIR="$(dirname "$SOURCE")"
+LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
+LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
+
+export BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE=true
+# Run installation (in interactive mode)
+# y - start setup
+# n - use static ip
+# n - deactivate ipv6
+# n - setup autohotspot
+# n - deactivate bluetooth
+# n - disable on-chip audio
+# - - mpd overwrite config (only with existing installation)
+# n - setup rfid reader
+# n - setup samba
+# n - setup webapp
+# - - setup kiosk mode (only with webapp = y)
+# - - install node (only with webapp = y)
+# n - reboot
+
+"${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
+n
+n
+n
+n
+n
+n
+n
+n
+n
+'
diff --git a/installation/includes/01_default_config.sh b/installation/includes/01_default_config.sh
index b2f37a1de..fa1bafb61 100644
--- a/installation/includes/01_default_config.sh
+++ b/installation/includes/01_default_config.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
-BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE=false
+BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE=${BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE:-"false"}
ENABLE_STATIC_IP=true
DISABLE_IPv6=true
ENABLE_AUTOHOTSPOT=false
From 23cf06cb90cb7fe23ee6347fdd86c5741540f8cc Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Fri, 8 Dec 2023 08:26:19 +0100
Subject: [PATCH 044/121] update var names and docs
---
installation/routines/setup_jukebox_core.sh | 33 +++++++++++----------
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/installation/routines/setup_jukebox_core.sh b/installation/routines/setup_jukebox_core.sh
index b02b8418b..6b070ff6c 100644
--- a/installation/routines/setup_jukebox_core.sh
+++ b/installation/routines/setup_jukebox_core.sh
@@ -1,9 +1,9 @@
#!/usr/bin/env bash
# Constants
-ZMQ_TMP_DIR="${HOME_PATH}/libzmq"
-ZMQ_PREFIX="/usr/local"
-ZMQ_VERSION="4.3.5"
+JUKEBOX_ZMQ_TMP_DIR="${HOME_PATH}/libzmq"
+JUKEBOX_ZMQ_PREFIX="/usr/local"
+JUKEBOX_ZMQ_VERSION="4.3.5"
JUKEBOX_PULSE_CONFIG="${HOME_PATH}"/.config/pulse/default.pa
JUKEBOX_SERVICE_NAME="${SYSTEMD_USR_PATH}/jukebox-daemon.service"
@@ -48,30 +48,30 @@ _jukebox_core_configure_pulseaudio() {
}
_jukebox_core_build_libzmq_with_drafts() {
- echo " Building libzmq v${ZMQ_VERSION} with drafts support" | tee /dev/fd/3
- local zmq_filename="zeromq-${ZMQ_VERSION}"
+ echo " Building libzmq v${JUKEBOX_ZMQ_VERSION} with drafts support" | tee /dev/fd/3
+ local zmq_filename="zeromq-${JUKEBOX_ZMQ_VERSION}"
local zmq_tar_filename="${zmq_filename}.tar.gz"
local cpu_count=${CPU_COUNT:-$(python3 -c "import os; print(os.cpu_count())")}
- cd "${ZMQ_TMP_DIR}" || exit_on_error
- wget --quiet https://github.com/zeromq/libzmq/releases/download/v${ZMQ_VERSION}/${zmq_tar_filename}
+ cd "${JUKEBOX_ZMQ_TMP_DIR}" || exit_on_error
+ wget --quiet https://github.com/zeromq/libzmq/releases/download/v${JUKEBOX_ZMQ_VERSION}/${zmq_tar_filename}
tar -xzf ${zmq_tar_filename}
rm -f ${zmq_tar_filename}
cd ${zmq_filename} || exit_on_error
- ./configure --prefix=${ZMQ_PREFIX} --enable-drafts --disable-Werror
+ ./configure --prefix=${JUKEBOX_ZMQ_PREFIX} --enable-drafts --disable-Werror
make -j${cpu_count} && sudo make install
}
_jukebox_core_download_prebuilt_libzmq_with_drafts() {
echo " Download pre-compiled libzmq with drafts support"
- local ZMQ_TAR_FILENAME="libzmq.tar.gz"
+ local zmq_tar_filename="libzmq.tar.gz"
ARCH=$(get_architecture)
- cd "${ZMQ_TMP_DIR}" || exit_on_error
- wget --quiet https://github.com/pabera/libzmq/releases/download/v${ZMQ_VERSION}/libzmq5-${ARCH}-${ZMQ_VERSION}.tar.gz -O ${ZMQ_TAR_FILENAME}
- tar -xzf ${ZMQ_TAR_FILENAME}
- rm -f ${ZMQ_TAR_FILENAME}
- sudo rsync -a ./* ${ZMQ_PREFIX}/
+ cd "${JUKEBOX_ZMQ_TMP_DIR}" || exit_on_error
+ wget --quiet https://github.com/pabera/libzmq/releases/download/v${JUKEBOX_ZMQ_VERSION}/libzmq5-${ARCH}-${JUKEBOX_ZMQ_VERSION}.tar.gz -O ${zmq_tar_filename}
+ tar -xzf ${zmq_tar_filename}
+ rm -f ${zmq_tar_filename}
+ sudo rsync -a ./* ${JUKEBOX_ZMQ_PREFIX}/
}
_jukebox_core_build_and_install_pyzmq() {
@@ -82,6 +82,7 @@ _jukebox_core_build_and_install_pyzmq() {
# Sources:
# https://pyzmq.readthedocs.io/en/latest/howto/draft.html
# https://github.com/MonsieurV/ZeroMQ-RPi/blob/master/README.md
+ # https://github.com/zeromq/pyzmq/issues/1523#issuecomment-1593120264
echo " Install pyzmq with libzmq-drafts to support WebSockets" | tee /dev/fd/3
if ! pip list | grep -F pyzmq >> /dev/null; then
@@ -90,14 +91,14 @@ _jukebox_core_build_and_install_pyzmq() {
_show_slow_hardware_message
fi
- mkdir -p "${ZMQ_TMP_DIR}" || exit_on_error
+ mkdir -p "${JUKEBOX_ZMQ_TMP_DIR}" || exit_on_error
if [ "$BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE" = true ] ; then
_jukebox_core_build_libzmq_with_drafts
else
_jukebox_core_download_prebuilt_libzmq_with_drafts
fi
- ZMQ_PREFIX="${ZMQ_PREFIX}" ZMQ_DRAFT_API=1 \
+ ZMQ_PREFIX="${JUKEBOX_ZMQ_PREFIX}" ZMQ_DRAFT_API=1 \
pip install -v --no-binary pyzmq --pre pyzmq
else
echo " Skipping. pyzmq already installed" | tee /dev/fd/3
From 55b1c9e59ae1a556a9953826db002499492df8dd Mon Sep 17 00:00:00 2001
From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
Date: Fri, 8 Dec 2023 10:02:04 +0100
Subject: [PATCH 045/121] add platform in scope and description
---
.../test_docker_debian_codename_sub_v3.yml | 17 +++++++++--------
.github/workflows/test_docker_debian_v3.yml | 10 ++++++----
2 files changed, 15 insertions(+), 12 deletions(-)
diff --git a/.github/workflows/test_docker_debian_codename_sub_v3.yml b/.github/workflows/test_docker_debian_codename_sub_v3.yml
index b4df11b3c..dde60cb2a 100644
--- a/.github/workflows/test_docker_debian_codename_sub_v3.yml
+++ b/.github/workflows/test_docker_debian_codename_sub_v3.yml
@@ -6,14 +6,13 @@ on:
debian_codename:
required: true
type: string
+ platform:
+ required: true
+ type: string
docker_image_name:
required: false
type: string
default: rpi-jukebox-rfid-v3
- platform:
- required: false
- type: string
- default: linux/arm/v7
cache_scope:
required: false
type: string
@@ -34,7 +33,7 @@ env:
# let only one instance run the test so cache is not corrupted.
# cancel already running instances as only the last run will be relevant
concurrency:
- group: ${{ inputs.cache_scope }}-${{ inputs.debian_codename }}
+ group: ${{ inputs.cache_scope }}-${{ inputs.debian_codename }}-${{ inputs.platform }}
cancel-in-progress: true
jobs:
@@ -73,10 +72,12 @@ jobs:
DEBIAN_CODENAME: ${{ inputs.debian_codename }}
DOCKER_IMAGE_NAME: ${{ inputs.docker_image_name }}
CACHE_SCOPE: ${{ inputs.cache_scope }}
+ PLATFORM: ${{ inputs.platform }}
run: |
- echo "image_tag_name=${{ env.DOCKER_IMAGE_NAME }}:${{ env.DEBIAN_CODENAME }}-test" >> $GITHUB_OUTPUT
- echo "image_file_name=${{ env.DOCKER_IMAGE_NAME }}-${{ env.DEBIAN_CODENAME }}.tar" >> $GITHUB_OUTPUT
- echo "cache_scope=${{ env.CACHE_SCOPE }}-${{ env.DEBIAN_CODENAME }}" >> $GITHUB_OUTPUT
+ PLATFORM=${PLATFORM////_}
+ echo "image_tag_name=${{ env.DOCKER_IMAGE_NAME }}:${{ env.DEBIAN_CODENAME }}-${PLATFORM}-test" >> $GITHUB_OUTPUT
+ echo "image_file_name=${{ env.DOCKER_IMAGE_NAME }}-${{ env.DEBIAN_CODENAME }}-${PLATFORM}.tar" >> $GITHUB_OUTPUT
+ echo "cache_scope=${{ env.CACHE_SCOPE }}-${{ env.DEBIAN_CODENAME }}-${PLATFORM}" >> $GITHUB_OUTPUT
- name: Set Output vars
id: vars
diff --git a/.github/workflows/test_docker_debian_v3.yml b/.github/workflows/test_docker_debian_v3.yml
index 6cf1648aa..6f90048ec 100644
--- a/.github/workflows/test_docker_debian_v3.yml
+++ b/.github/workflows/test_docker_debian_v3.yml
@@ -18,14 +18,16 @@ concurrency:
jobs:
# Build container and run tests. Duplication of job intended for better visualization.
- run_bookworm:
- name: 'bookworm'
+ run_bookworm_armv7:
+ name: 'bookworm armv7'
uses: ./.github/workflows/test_docker_debian_codename_sub_v3.yml
with:
debian_codename: 'bookworm'
+ platform: linux/arm/v7
- run_bullseye:
- name: 'bullseye'
+ run_bullseye_armv7:
+ name: 'bullseye armv7'
uses: ./.github/workflows/test_docker_debian_codename_sub_v3.yml
with:
debian_codename: 'bullseye'
+ platform: linux/arm/v7
From c00cde685104746fc3e1cee495b36d0a7464d713 Mon Sep 17 00:00:00 2001
From: s-martin Ups! Requested file not found.
Why not try again from the top-level of
diff --git a/resources/html/runbuildui.html b/resources/html/runbuildui.html index 04f92c704..6ade7bb0a 100755 --- a/resources/html/runbuildui.html +++ b/resources/html/runbuildui.html @@ -12,11 +12,11 @@Ups! Looks like your Web UI has not been build!
No reason to panic. Please run through the following steps:
-
-
cd ~/RPi-Jukebox-RFID/src/webapp
- ./run_rebuild.sh -u
- - Reload this page +
cd ~/RPi-Jukebox-RFID/src/webapp
+ ./run_rebuild.sh -u
+ Reload this page
In case of trouble when building the Web UI, consult the documentation! +
In case of trouble when building the Web UI, consult the official documentation!