1. Overview¶
For the person who sets up and runs the boxes and the library at home: with a terminal, a NAS or a PC, and a
browser. What to do, in steps, and what happens then. How the box is operated and what the web page offers is in the
manual; this document points to it instead of repeating it. Every detail – every command, every option,
every file – is in the developer documents (docs/developer/, in English).
1.1 What runs where¶
| What | Where it runs | Its page | Its data |
|---|---|---|---|
| Box | a Raspberry Pi in the wooden case | https://<name of the box>.local, e.g. https://tinyjukebox.local |
/srv/tinyjukebox/ on its SD card |
| Library on the NAS | the Synology package tinyjukebox-library |
https://<nas>:8866 |
/var/packages/tinyjukebox-library/var/ and the shared folder tinyjukebox |
| Library in Docker or on a PC | the image ghcr.io/tgd1975/tinyjukebox, or tinyjukebox-library --data DIR |
https://<computer>:8866 |
the volume /data, or the folder DIR |
| App | an Android phone: a phone as a box, or the page of the library | – | on the phone (manual, section 13.7) |
A box works alone. With a library the boxes share albums, tags, stations and covers, and the library keeps the progress of every box (manual, section 13). A box without a library fetches new versions of its software from GitHub; a box with a library fetches them from the library.
1.2 Roles¶
adminmay do everything: albums, tags, stations, users, backups, versions.usermay operate the box – status, player, volume, buttons – and change the own password; on the library also make a tag known by scanning it.
A box and the library each have their own users. Users and passwords on the page: manual, section 11.
1.3 The files of a box¶
| Folder | Content |
|---|---|
/srv/tinyjukebox/albums/ |
one folder per album: MP3 files and playlist.m3u |
/srv/tinyjukebox/json/ |
tags, albums, stations, progress, volume limits; images/: the covers |
/srv/tinyjukebox/ssl/ |
certificate of the page and users.yaml, the users |
/srv/tinyjukebox/log/ |
tinyjukebox.log, the log of the box |
/srv/tinyjukebox/slots/, current |
the versions of the box software and the one that runs |
/srv/tinyjukebox/state/ |
which version runs and why; history.log, one line per switch |
/srv/tinyjukebox/identity/, sync/ |
the key of the box and the address of its library; what it exchanges with the library |
/srv/tinyjukebox/spotify/ |
key, player and login of Spotify |
/srv/tinyjukebox/config/ |
tinyjukebox.yaml, if there is one (section 8) |
All of it belongs to the user of the box, pi on our box. The complete list:
box.md, section 6.