INSTALL - MiczFlor/RPi-Jukebox-RFID GitHub Wiki
Installing Phoniebox
[!CAUTION] Do NOT use the latest RaspberryPi OS Bookworm release (also don't upgrade via apt) with the new kernel 6.6, if you need to use GPIO components . There have been incompatible changes for the RPi.GPIO library, so Shims and Rfid Reader usage can be broken (#2295).
Using RaspberryPi OS Bullseye is the current recommendation as it does not use the new kernel.
[!IMPORTANT] The Phoniebox software V2.x wiki pages have been mostly created for buster or earlier. As this should not be a problem in general, some instructions may not work out of the box on newer Raspberry Pi OS versions. If you encounter problems please head to the issue or discussion section.
This project has been tested on Raspberry Pi model 1, 2, 3, 4, and Zero.
Install Raspberry Pi OS (previously Raspbian) on your RPi
There are a number of operating systems to chose from on the official RPi download page.
Currently we recommend to use the latest legacy release image.
- Use the 'lite'-Version (configuration via ssh). If you need the Desktop UI you may need to fix some audio things (see https://github.com/MiczFlor/RPi-Jukebox-RFID/discussions/2267#discussioncomment-8556789).
Installation steps:
- Connect a Micro SD card to your computer (preferable an SD card with high read throughput)
- Download the Raspberry Pi Imager and run it
- Click on "Choose Device" and select "No filtering"
- Click on "Choose OS" and select "Raspberry Pi OS (other)"
- Select Raspberry Pi OS (Legacy) Lite (prefered for Phoniebox)
- if you need a desktop environment, select the non lite version
- if you want to use a preloaded image, go back and choose Use Custom
- Select Raspberry Pi OS (Legacy) Lite (prefered for Phoniebox)
- Select your Micro SD card (your card will be formatted)
- After you click
Next
, a prompt will ask you if you like to customize the OS settings- Click
Edit Settings
and configure- At the
General
tab- Provide a hostname.
- ⚠️ Username MUST be
pi
. Other usernames are not supported. - User Password
- Wifi
- locale settings
- At the
Services
tab.- Enable SSH with "Use password authentication"
- At the
Options
tab.- Disable "Telemetrie" if you like
- Click
Save
- At the
- Click
Yes
to use Settings
- Click
- Click
Write
- Confirm the next warning about erasing the SD card with
Yes
- Wait for the imaging process to be finished (it'll take a few minutes)
Plug the SD into your Pi and optionally connect keyboard, monitor and mouse. And fire it up.
See the official RPi guide for further information.
Autologin after boot
When you start the Phoniebox, it needs to fire up without stalling at the login screen. This can also be configured using the RPi config tool.
Open a terminal to star the RPi configuration tool.
$ sudo raspi-config
Select Boot options
and then Desktop / CLI
. The option you want to pick is Console Autologin - Text console, automatically logged in as 'pi' user
.
One line install command
There is a one line script for Raspberry Pi OS. Copy and paste it into your Pi terminal - if you have your
- Raspberry Pi OS up and running and
- are connected to the Internet
This script gets your Phoniebox up and running and automatically configures all necessary parts. Once you finished the installation, read the manual to add audio files and RFID cards.
A. Default install script (recommended)
Uses the latest release from the master
branch.
cd; rm install-jukebox.sh; wget https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/master/scripts/installscripts/install-jukebox.sh; chmod +x install-jukebox.sh; ./install-jukebox.sh
Having said this, you might learn a bit more about your Raspberry Pi to walk through the installation process step by step, like this:
The one line install command contains five separate commands linked up by replacing the end of line with ;
. The commands do the following:
cd
- move to the home directoryrm install-jukebox.sh
- remove previously downloaded versions of the install scriptwget https://raw.githubusercont...
- download the actual install script from githubchmod +x install-jukebox.sh
- make the script executable./install-jukebox.sh
- run the script
B. Developer install script
For latest updates, try the version in the develop
branch. Attention: it’s likely that things on develop are broken or have to be changed by yourself.
cd; rm install-jukebox.sh; wget https://raw.githubusercontent.com/MiczFlor/RPi-Jukebox-RFID/develop/scripts/installscripts/install-jukebox.sh; chmod +x install-jukebox.sh; GIT_BRANCH=develop bash ./install-jukebox.sh