Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #2216

Merged
3 changes: 2 additions & 1 deletion documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ project check out the [documentation of Version 2](https://github.com/MiczFlor/R
Version 3 has reached a mature state and will soon be the default version.
However, some features may still be missing. Please check the [Feature Status](./developers/status.md), if YOUR feature is already implemented.

> ![NOTE] If version 3 has all the features you need, we recommend using Version 3.
> [!NOTE]
> If version 3 has all the features you need, we recommend using Version 3.

If there is a feature missing, please open an issue.

Expand Down
39 changes: 36 additions & 3 deletions documentation/builders/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr
1. Connect a Micro SD card to your computer (preferable an SD card with high read throughput)
2. Download the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) and run it
3. Click on "Raspberry Pi Device" and select "No filtering"
4. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system. `future3` does not support 64bit kernels (`aarch64`).
4. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system. *64-bit is currently not supported.* For Pi 4 and newer also check [this](#workaround-for-64-bit-kernels-pi-4-and-newer).
AlvinSchiller marked this conversation as resolved.
Show resolved Hide resolved
5. Select your Micro SD card (your card will be formatted)
6. After you click `Next`, a prompt will ask you if you like to customize the OS settings
* Click `Edit Settings`
Expand All @@ -26,12 +26,12 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr
8. Confirm the next warning about erasing the SD card with `Yes`
9. Wait for the imaging process to be finished (it'll take a few minutes)


### Pre-boot preparation
<details>

<summary>In case you forgot to customize the OS settings, follow these instructions after RPi OS has been written to the SD card.</summary>

### Pre-boot preparation

You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to proceed with the next steps.

1. Open a terminal of your choice.
Expand Down Expand Up @@ -77,6 +77,39 @@ You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to

</details>

### Pre-install preparation / workarounds

#### Workaround for network related features on Bookworm
<details>
With Bookworm the network settings have changed. Now "NetworkManager" is used instead of "dhcpcd".
This breaks breaks network related features like "Static IP", "Wifi Setup" and "Autohotspot".
Before running the installation, the network config has to be changed via raspi-config, to use the "old" dhcpcd network settings.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we refer to use Bullseye, this is not a problem anymore.
Meanwhile, can't we just automate this instead of describing it here, potentially loosing builders along the way? We could silently change the raspi-config in the installation, most builders won't care. It's a save convention to define.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could keep this docs for reference on Bookworm, but it'll be less of a pain for most builders.

Copy link
Collaborator Author

@AlvinSchiller AlvinSchiller Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our current installation instruction dont mention a specific version (the default will be select be RPI Imager), but i think more and more will use the newer Bookworm, and running into this.

A quickfix in the installation is not possible, as a change of the setting will instantly reset the network and the user will lose access to the device, if it has a wifi connection.

I address the problem, with #2184 to have both ways working.
So this is just a temporary documentation apart from the Issue and notes in the Release till the implementation is finished ( in case it will not be ready for 3.5.0 ).


:warning:
s-martin marked this conversation as resolved.
Show resolved Hide resolved
If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless connection.
So make sure you use a wired connection or perform the following steps in a local terminal with a connected monitor and keyboard.

Change network config
* run `sudo raspi-config`
* select `6 - Advanced Options`
* select `AA - Network Config`
* select `dhcpcd`

If you need Wifi, add the information now
* select `1 - System Options`
* select `1 - Wireless LAN`
* enter Wifi information
</details>

#### Workaround for 64-bit Kernels (Pi 4 and newer)
<details>

The installation process checks if a 32-bit OS is running, as 64-bit is currently not supported.
This check also fails if the kernel is running in 64-bit mode. This is the default for Raspberry Pi models 4 and newer.

To be able to run the installation, you have to switch to the 32-bit mode by modifying the `config.txt` ([check for the correct location as it has changed since bookworm](https://www.raspberrypi.com/documentation/computers/config_txt.html)) and add/change the line `arm_64bit=0`. Reboot before you proceed.
s-martin marked this conversation as resolved.
Show resolved Hide resolved
</details>

## Install Phoniebox software

Choose a version, run the corresponding install command in your SSH terminal and follow the instructions.
Expand Down
10 changes: 5 additions & 5 deletions installation/install-jukebox.sh
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ Check install log for details:"
exit 1
}

# 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 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!)
AlvinSchiller marked this conversation as resolved.
Show resolved Hide resolved
_check_os_type() {
local os_type=$(uname -m)

Expand All @@ -97,8 +97,8 @@ _check_os_type() {
if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then
print_lc " ... OK!\n"
else
print_lc "ERROR: Only 32 bit operating systems supported. Please use a 32bit version of RaspianOS!"
print_lc "You can fix this problem for 64bit kernels: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041"
print_lc "ERROR: Only 32-bit operating systems are supported. Please use a 32-bit version of RaspianOS!"
AlvinSchiller marked this conversation as resolved.
Show resolved Hide resolved
print_lc "For Pi 4 models or newer running a 64-bit kernels, also see this: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041"
exit 1
fi
}
Expand Down
Loading