lyrion.org

Plugins and extensions are how you add capabilities to Lyrion Music Server (LMS) that aren't built into the core — new music services, player-side apps, and integrations. LMS ships with a plugin system and an in-app plugin repository, so most additions are installed from inside the server rather than by editing files. The official documentation organizes this under Extensions (Applications and Plugins), with a separate Available Plugins page and a Repository File Reference for anyone publishing their own.

What "extensions" covers in LMS

The Lyrion documentation splits extensions into two kinds:

• Applications — add-ons that run alongside LMS.
• Plugins — modules loaded into LMS itself to change or extend its behavior.

There's also Applet Development for SqueezePlay-based players, which is a separate track from server-side plugins. If your goal is to change what the server does (scanning, metadata, music services, CLI/RPC behavior), you want a plugin. If your goal is to change what a software player shows or does, you want an applet.

What plugins actually let you change

Based on how the documentation is structured, plugins are the extension point for:

• Music service integration — the docs include a dedicated Music Service Plugin reference, which is the path for connecting streaming or online catalog services.
• Library and metadata behavior — the media library and metadata guides sit alongside the plugin docs, and plugins are the mechanism for altering how tracks are organized and presented.
• Server-side features exposed through the CLI/JSON-RPC interface — the command-line interface reference lists the query categories (players, database, playlist, favorites, randomplay, alarms, and so on) that plugins and clients build on.

In short: if a feature isn't in the core server, the documented way to add it is a plugin, and the documented way to find one is the plugin repository.

Finding and installing plugins

The documentation points to an Available Plugins page and a Repository File Reference. The practical flow is:

1. Open the LMS web interface and go to its plugin management section (the docs list Plugins → Overview and Available Plugins as the relevant pages).
2. Browse or search the available plugins list.
3. Enable the plugin you want and let LMS fetch it from the repository.
4. Restart or reload as prompted, then configure the plugin in its own settings page.

The Repository File Reference matters if you're maintaining your own repository or want to understand where LMS is pulling plugin metadata from — it documents the file format LMS reads to discover plugins.

When you'd write your own

The docs include a Plugin Development section and a Contributing section (with bug reporting, DCO sign-off, and translation guidance). You'd go this route if:

• No existing plugin covers the music service or behavior you need.
• You want to expose something through LMS's CLI/JSON-RPC interface.
• You're adapting an existing plugin for a new service or a new LMS version.

The LMS 9 changelog and LMS 8 changelog are worth checking before you start, since plugin APIs can shift between major versions.

A realistic example

Say you want LMS to pull from a music service it doesn't natively support. You'd check the Available Plugins list first — if someone has already published a music service plugin for it, you enable it and enter your credentials in the plugin's settings. If not, the Music Service Plugin reference is the starting point for building one, and the Repository File Reference tells you how to make it discoverable to other LMS users.

What to check before you commit

• Version compatibility — confirm the plugin supports your LMS major version (8.x vs 9.x), since the changelogs show API changes between them.
• Where it comes from — plugins are fetched from repositories; the Repository File Reference documents the format, so you can see what a repository entry contains.
• Server vs. player — a server plugin won't change a SqueezePlay player's UI; that's applet territory.

The documentation doesn't state pricing or login requirements for plugins, so treat those as plugin-specific and check the individual plugin's page.

Lyrion Music Server (LMS) is open-source software that controls and manages music players and your media library. It was formerly called Logitech Media Server and is often abbreviated as "LMS." If you have Squeezebox hardware or software players, or you want a self-hosted music server that ties them together, LMS is the central piece you install first.

What LMS actually does

LMS runs as a server on a computer or NAS on your network. It indexes your music library, then streams and controls playback on connected players. You interact with it through a web interface or through the players themselves.

In practical terms, LMS handles:

• Library management — scanning and organizing your local music files, including metadata handling.
• Player control — sending audio to and controlling one or many players at once.
• Playback features — playlists, favorites, random play, alarms, and notifications.
• Extensibility — plugins and applications that add functionality.

The Lyrion/Squeezebox ecosystem

LMS is one part of a larger ecosystem. The documentation describes it as "The Lyrion Music Server (LMS) ecosystem," which includes the server software plus the players and controllers that connect to it.

Players fall into two broad categories:

This split matters: you don't need original Logitech hardware to use LMS. Software players like Squeezelite let you turn a Raspberry Pi, a PC, or another device into a player.

Getting started

The documentation organizes setup by platform and use case, so you can pick the path that matches your hardware:

• Download & Installation — the general starting point.
• Beginner's guides — including a full-featured LMS on a Raspberry Pi, plus Docker setups for Synology, QNAP, and OMV.
• Getting started on macOS — a platform-specific walkthrough.
• Creating a media library — how to get your music organized, with guidance on metadata and classical music.

A typical flow is: install LMS on a always-on machine or NAS, point it at your music folder, let it scan, then connect a player and control playback from the web interface or a controller.

Where to go next

Once LMS is running, the documentation branches into deeper topics depending on what you need:

• Help Guides and FAQs — troubleshooting and common questions, including changes in version 9.0.
• Advanced guides — OpenVPN on SB Radio/Touch, migrating from UE Smart Radio, LMS on ReadyNAS, and adding locales to a Docker container.
• Plugins and Applications — extending LMS with community and official add-ons.
• Reference — technical detail on the database structure, the SqueezePlay menu system, and the JSON/RPC command line interface.
• Community forums — where users and developers discuss problems and projects.

If you're deciding whether LMS fits your setup, the key question is whether you want a self-hosted server driving dedicated or software players on your own network. If so, start with the Download & Installation page and the beginner's guide for your platform.

Lyrion Music Server (LMS) is open-source software (formerly Logitech Media Server) that controls Squeezebox-family players and compatible software players. To get started, download and install LMS for your platform, then point it at a music folder to build a media library. The official documentation organizes this into a "Getting Started with LMS" section covering download/installation, beginner's guides, and platform-specific setups.

Start at the official entry points

The Lyrion Music Server site groups the first steps under two headings:

• Getting Started with LMS — the overall onboarding path
• Download & Installation — the actual download and install instructions

Within Getting Started, the documented sub-sections are:

• Download & Installation
• Beginner's guides
• Help Guides and FAQs
• Advanced guides
• Creating a media library

If you only read one thing first, the Beginner's guide for LMS is the intended starting document.

Pick the installation path that matches your hardware

LMS documents several distinct setup routes. Choose based on where you want the server to run:

Docker-based installs (Synology, QNAP, OMV) share the same container approach, so the Docker guides are worth reading together even if you only use one of those NAS brands. There is also a separate note on adding locales to a Docker container if you need non-default language support.

Follow the beginner's guide, then build your library

The documented flow is: install LMS, then move on to Creating a media library. That section is where you define what music LMS will serve.

Two related guides sit alongside library creation and are worth knowing about early:

• Getting the most out of LMS metadata — how tagging affects browsing and playback
• Guide to classical music on LMS and the #CURTRACK Guide — specialized handling for classical collections and curated track lists

Getting metadata right before you scan a large library saves re-work later, since LMS browsing depends heavily on tags.

Know where to look when something breaks

• Help Guides and FAQs — general troubleshooting and common questions
• New Music changes in 9.0 — relevant if you are coming from an older version or from Logitech Media Server
• Advanced guides — includes topics like using OpenVPN on SB Radio/Touch and migrating from UE Smart Radio

The Changelog is split into LMS 9 changelog and LMS 8 changelog, useful for confirming whether a behavior you remember belongs to the version you installed.

Players and controllers come after the server

LMS is the server; you still need something to play through. The site separates these into:

• Hardware based — Squeezebox Touch, Radio, Boom, Duet (Controller + Receiver), Transporter, Classic, Squeezebox 2/1, SLIMP3
• Software based — Squeezelite, Jivelite, SqueezePlay, SoftSqueeze, piCorePlayer

A Hardware Comparison and Software Comparison page exist if you are deciding between them. For a first setup, a software player such as Squeezelite is the usual way to test LMS without dedicated hardware.

Extensions, plugins, and community

• Plugins — Overview, Available Plugins, Repository File Reference
• Extensions — Applications and Plugins
• Community forums — the documented place for peer support
• Contributing — Overview, Reporting a bug, DCO Sign-off, Adding translations

Plugins are how LMS gains features beyond core playback, so the Available Plugins list is the reference to check before assuming something is missing.

Reference material for later

Once running, the Reference section covers the Lyrion Music Server introduction, Database Structure, and the SqueezePlay Menu System (Home Menu vs. SlimBrowse, Home Menu Items, SlimBrowse Protocol). Developer-oriented material includes the Command Line Interface (JSON/RPC) with its syntax guide, the SlimProto Protocol, SLIMP3 Protocol, and Applet/Plugin Development guides.

You do not need any of this to get music playing — treat it as the next layer if you want to script, extend, or debug LMS.

Lyrion Music Server (LMS) builds its library by scanning folders of music files you already own, then reading the metadata stored inside those files. To create a library, install LMS, point it at your music folder, and run a scan; to manage it well, keep your tags consistent and use the dedicated guides for metadata and classical music. This applies to local files on the machine or storage that LMS can reach — it is not a streaming catalog.

What "creating a media library" means in LMS

LMS does not host or download music. It indexes files from a location you specify, which is why the official documentation treats library creation as two connected tasks:

• Getting the files in place — a folder structure LMS can read.
• Getting the metadata right — tags that determine how albums, artists, and tracks appear.

The site's documentation groups this under Creating a media library, with two companion guides: Getting the most out of LMS metadata and Guide to classical music on LMS.

Steps to create the library

1. Install LMS. Follow Getting Started with LMS → Download & Installation. The site also offers platform-specific beginner guides, including a full-featured LMS on a Raspberry Pi, Docker on Synology, Docker on QNAP, Docker on OMV, and getting started on macOS.
2. Confirm your files are accessible to the LMS host — local disk, attached storage, or a mounted share.
3. Point LMS at your music folder so it knows which directory to scan.
4. Run a scan and let LMS read the files and their tags.
5. Verify the result by browsing albums and artists, then fix any entries that appear wrong or split.

The exact menu path depends on your LMS version and skin, so rely on the Beginner's guide for your platform rather than a fixed click sequence.

Managing metadata so the library stays usable

Metadata is what turns a folder of files into a browsable library. The Getting the most out of LMS metadata guide is the reference here. In practice, the decisions that matter most are:

• Consistent artist and album artist tags — inconsistent values are a common cause of one album appearing as several.
• Album and track numbering — needed for correct ordering.
• Compilation handling — so multi-artist albums group sensibly.
• Artwork — embedded or stored alongside the files.

Treat tagging as ongoing maintenance: when you add music, tag it before scanning rather than after.

Classical music needs its own approach

Classical libraries break assumptions built for pop and rock — composer, conductor, soloist, and work are all distinct roles. LMS documents this separately in the Guide to classical music on LMS, and there is also a #CURTRACK Guide. If classical is a significant part of your collection, read that guide before bulk-tagging, because reworking a large classical library later is far more work than setting conventions first.

When to use the advanced and platform guides

Note that LMS 9.0 introduced changes to music handling, so check the New Music changes in 9.0 page if you are upgrading and your library behaves differently than expected.

Where to get help

The site's Help Guides and FAQs section collects troubleshooting material, and the Community forums are the place for questions the guides do not cover. Because LMS is open-source and community-maintained, forum answers often reflect the version and platform you are actually running — include both when you ask.

Lyrion Music Server (LMS) works with two broad families of playback devices: dedicated hardware players from the Squeezebox line, and software players you run on your own computer, Raspberry Pi, or NAS. Controllers are a separate category — they send commands to LMS but may or may not play audio themselves. The official documentation splits these into "Hardware based" and "Software based" sections, each with its own comparison page, so you can match a device to your setup before buying or installing anything.

The three roles in the LMS ecosystem

LMS is the server: it holds your music library, manages metadata, and streams audio to whatever is connected. Around it sit three kinds of endpoints:

• Players — receive and play audio streams from LMS.
• Controllers — browse the library and issue commands (play, pause, skip, volume).
• Combined devices — many Squeezebox units act as both player and controller.

This distinction matters because a controller alone won't produce sound, and a player without a controller is awkward to operate unless you drive it from the web interface or a phone app.

Hardware-based players and controllers

The hardware line is the original Squeezebox family. The documentation lists these under "Hardware based," with a Hardware Comparison page for side-by-side specs.

If you already own any of these, LMS is designed to drive them. If you're buying used hardware, check the individual device page — the docs treat each model separately rather than assuming they behave identically.

Software-based players

Software players let you reuse hardware you already have. The docs list Squeezelite, Jivelite, SqueezePlay, SoftSqueeze, and piCorePlayer, with a Software Comparison page.

• Squeezelite — a headless software player with its own manpage. This is the usual choice for a Raspberry Pi or a small always-on computer feeding a DAC.
• piCorePlayer — a ready-made Raspberry Pi image that bundles the player role; the docs also cover running a full-featured LMS on a Raspberry Pi.
• SqueezePlay — a software player with a graphical interface, and the basis for the SqueezePlay Menu System and applet development documentation.
• Jivelite — a touch-oriented interface, typically paired with a Squeezelite player on the same device.
• SoftSqueeze — an older software player, listed alongside the others.

The practical difference: Squeezelite gives you audio output with no screen, while SqueezePlay and Jivelite give you an on-screen interface. On a Pi you can run both a player and the server on one machine, or split them across two.

How to choose between hardware and software

Use the same dimensions the docs use when comparing:

• Cost and availability — hardware Squeezebox units are legacy devices; software players run on hardware you may already own.
• Interface — hardware units have built-in screens and knobs; software players need a separate screen, phone app, or web browser.
• Placement — a Boom or Radio is self-contained for a kitchen or bedroom; a Squeezelite box needs an amp or powered speakers.
• Maintenance — software players update with your OS; hardware firmware is fixed to what the community supports.

A reasonable default: if you want a single self-contained unit, look at the hardware comparison. If you want to add rooms cheaply or feed an existing stereo, start with Squeezelite or piCorePlayer.

Getting started

1. Install and run LMS using the Download & Installation page or a beginner's guide (Raspberry Pi, Docker on Synology/QNAP/OMV, or macOS).
2. Pick a player — connect a Squeezebox device to your network, or install Squeezelite/piCorePlayer on a computer or Pi.
3. Confirm the player appears in LMS, then use a controller (hardware remote, web interface, or app) to browse and play.

If a player doesn't show up, the usual causes are network isolation between server and player, or the player software not running. The Help Guides and FAQs and the community forums cover device-specific issues.