Architecture_FoldersFiles

Architecture: Folders and Files

The install will create a folder named RPi-Jukebox-RFID. The absolute path to that folder will be: /home/pi/RPi-Jukebox-RFID

From now on this path will be referred to as root (of the Phoniebox). All following paths will be in reference to that root

First let's explain the folder structure. Individual files are explained below.

• / (root directory, here is everything to get started and install the project)
• /ci (docker images, which can be used for testing and are used for continous integration with GitHub Actions. See folder's README for details)
• /components (code and descriptions for optional componentes, e.g. displays, RFID readers etc. See folder's README for details)
• /docs (documentation and howtos for the project besides the README)
• /htdocs (PHP web interface)
• /logs (log file. Logging can be switched on an off in the web app under Settings)
• /misc (sample configuration files, mp3 testfiles)
  • /sampleconfigs (system configuration files and services used by the install script)
• /scripts (Phoniebox functions = scripts which are called by RFID swipes or through the web interface)
  • /helperscripts (help to configure and manage your phoniebox)
  • /installscripts (installation scripts which modify the system to work with/as a phoniebox)
  • /userscripts (in the web app under /userScripts.php an interface comes up that allows execution of shell scripts in this folder. Made for hacks to good to not have, but too mysterious to include...)
• /settings (See wiki for details global settings for Phoniebox behaviour. Individual settings for audio folders - e.g. resume - are in the audio folder under shared/audiofolders)
• /shared (links from RFID to audio files and folders)
  • /audiofolders (files and folders available to be played)
  • /shortcuts (files with the RFID ID as filename, content is linked foldername triggered by /scripts/rfid_trigger_play.sh)
• /tests (unsorted and unstandardised scripts to test stuff. See content of files and try to decipher...)