Skip to main content
This is unreleased documentation for the next Zaparoo Core release.
For up-to-date documentation, see the latest version (Stable).
Version: Next

LibreELEC

Beta

LibreELEC is a beta platform: launching and readers work, but install and startup are manual.

Zaparoo Core on LibreELEC provides Kodi integration for movies, TV shows, and music. Also works on CoreELEC and other Kodi-based systems.

File paths​

ItemPath
Config file/storage/.config/zaparoo/config.toml
Data directory/storage/.local/share/zaparoo
Log file/tmp/zaparoo/core.log
Mappings directory/storage/.local/share/zaparoo/mappings

The config file can be accessed through the SMB share in the Configfiles folder.

Install​

Download Zaparoo Core for LibreELEC from the Downloads page, unzip it and copy the zaparoo file to /storage.

Enable SSH in LibreELEC settings (Services > SSH Server). Default credentials: root / libreelec.

cd /storage
./zaparoo -service start

Once Core is running, write your first token from the Zaparoo App or the built-in web UI at http://<libreelec-ip>:7497/app/.

Kodi API Setup​

Enable Kodi remote control for Zaparoo to work:

  1. Open Settings > Services
  2. Change view setting to at least "Standard"
  3. Open the Control page
  4. Enable "Allow remote control via HTTP"
  5. Set a blank password
  6. Enable "Allow remote control from applications on this system"

Adding to Startup​

Add to /storage/.config/autostart.sh:

/storage/zaparoo -service start

Uninstall​

  1. Stop the service: /storage/zaparoo -service stop
  2. Remove the line you added to /storage/.config/autostart.sh.
  3. Delete /storage/zaparoo, and /storage/.local/share/zaparoo if you also want to remove your configuration and data.

Client security​

Encryption is off by default on LibreELEC, so the Zaparoo App and browsers connect without pairing. To require pairing with a PIN, set encryption = true in config.toml; Core then shows the PIN under Settings > Clients > Pair in the terminal UI or with ./zaparoo -pair.

Readers​

TypeReaderSupportSetupNotes
NFC/RFIDPN532 USBSupportedAuto-detected
NFC/RFIDPN532 ModuleSupportedDepends on wiringUART can auto-detect. I2C is supported.
NFC/RFIDACR122ULimitedManual enableUses libnfc: MIFARE Classic writing is limited, LED and beeper do not work, and some clone variants are incompatible.
NFC/RFIDRC522LimitedVia Simple SerialRequires a microcontroller; not a direct USB reader.
Barcode and QRZaparoo App cameraSupportedVia Zaparoo App
Barcode and QRRS-232 scannerSupportedManual config
Optical and MediaOptical DriveSupportedManual config
Optical and MediaExternal DriveSupportedManual enable
Custom and VirtualMQTT ReaderSupportedManual config
Custom and VirtualSimple SerialSupportedManual config
Custom and VirtualFile ReaderSupportedManual config
Displays and IntegrationsTTY2OLEDSupportedManual enable

Each reader's page has setup steps and troubleshooting. See readers to compare them, or the setup guide to pick one for your setup.

Launchers​

LibreELEC uses Kodi as its primary launcher. All media is played through the Kodi JSON-RPC API.

Local Files​

These launchers play files directly from disk in /storage/:

System IDFoldersExtensions
Videovideos, tvshows.avi, .mp4, .mkv, .iso, .bdmv, .ifo, .mpeg, .mpg, .mov, .wmv, .flv, .webm, .m4v, .3gp, .ts, .m2ts, .mts, .m3u, .m3u8
MusicTrackmusic.mp3, .flac, .ogg, .m4a, .wav, .wma, .aac, .opus

Library Media​

These launchers play media from Kodi's indexed library. They query Kodi's database during media indexing rather than scanning the filesystem.

System IDDescription
MovieMovies from Kodi library
TVEpisodeIndividual TV episodes
TVShowEntire TV show (plays next unwatched episode)
MusicTrackSongs from Kodi music library
MusicAlbumAlbums from Kodi music library
MusicArtistArtists from Kodi music library (plays all songs)

Shell scripts​

Custom shell scripts (.sh files) can be launched directly. Scripts must be added to the allow_file list in config.toml.

[launchers]
allow_file = [
"^/storage/.*\\.sh$"
]

Restart Zaparoo after modifying the config for changes to take effect.