Skip to content
Richard edited this page Aug 31, 2026 · 20 revisions

Welcome to the PiKaraoke wiki — guides, tips and tricks for running pikaraoke.

Installing for the first time? The instructions are in the README — a one-line command on Linux and macOS, and on Windows either a setup installer or a PowerShell one-liner.

Wondering how something works? The FAQ is the closest thing to a manual. Connecting, finding songs and play history come first, then an admin section covering the queue on the night, the song library, sessions, the splash screen and audio.

Something actually broken? Troubleshooting keeps the Raspberry Pi problems in one half and everything else in the other.

Want to change how it runs? Most settings — the splash screen, the interface language, folder browsing, fair queuing — are on the Settings page in the web interface. Setting up the machine covers what is fixed at launch: headless mode, custom addresses, running more than one room, and the full list of command line options.

There are also guides for dedicated Raspberry Pi and FullPageOS builds, running the server from an Android phone, casting to a TV, and fixing Bluetooth speaker lag.

Want to contribute? The development guide covers the setup, the tests and the PR conventions, and translators are always wanted.

Clone this wiki locally