Service: Lyrion Music Server - EyevinnOSC/community GitHub Wiki
Lyrion Music Server
Lyrion Music Server (serviceId lms-community-slimserver), formerly Logitech Media Server / Squeezebox Server, is an open source music streaming server that organises a music library and streams it to Squeezebox hardware players, software players (Squeezelite, the Lyrion app) or any UPnP/DLNA renderer. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 50 GiB of storage per instance. Source: LMS-Community/slimserver.
What it can do
- Stream local and internet music to players on Windows, macOS, Linux and hardware players.
- Read a music library from an S3-compatible bucket (AWS S3, MinIO and others) in addition to uploaded files.
- Provide a web UI with a first-run setup wizard (music folder, audio formats and plugins, optional server password).
Creating an instance
A music bucket is optional. To use MinIO on OSC for the library, create a MinIO instance first (minio-minio, see Service: MinIO), upload your music, and read its endpoint and credentials with describe-service-instance. Store the credentials with create-service-secret (serviceId lms-community-slimserver).
Create the instance with create-service-instance, serviceId: "lms-community-slimserver". A minimal instance needs only a name:
{ "name": "mylms" }
With a MinIO music bucket:
{
"name": "mylms",
"MusicBucketUrl": "s3://music",
"S3EndpointUrl": "https://<minio-instance>.minio-minio.auto.prod-se.osaas.io",
"S3AccessKeyId": "{{secrets.s3key}}",
"S3SecretAccessKey": "{{secrets.s3secret}}",
"S3Region": "us-east-1"
}
Use wait-for-service-ready or get-instance-status, then describe-service-instance for the instance URL. With the OSC CLI:
osc create lms-community-slimserver mylms
Options
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| MusicBucketUrl | No | string | URL or path of an S3 bucket containing music files for the server to access and stream, for example s3://my-music-bucket. |
| S3EndpointUrl | No | string | Endpoint URL of S3-compatible storage other than AWS S3, such as MinIO or DigitalOcean Spaces, for example https://minio.example.com. |
| S3AccessKeyId | No | string, sensitive | Access key ID for the S3 or S3-compatible storage. |
| S3SecretAccessKey | No | string, sensitive | Secret access key paired with the access key ID. |
| S3Region | No | string | AWS region of the bucket, for example eu-north-1. |
Store the credential options as secrets and pass them as {{secrets.NAME}}, as the entire field value.
Dependency: MinIO options (minio-minio)
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. |
| RootUser | No | string | Admin user name; used as the access key ID (AWS_ACCESS_KEY_ID / S3_ACCESS_KEY_ID) by S3 clients. |
| RootPassword | No | string, sensitive | Admin password; used as the secret access key (AWS_SECRET_ACCESS_KEY / S3_SECRET_ACCESS_KEY) by S3 clients. |
Using the instance
Open the instance URL. On first run a setup wizard walks you through choosing the music folder (point it at the S3 music bucket or an uploaded directory), selecting audio formats and plugins, and optionally setting a server password under Settings > Security. The default setup has no password; set one immediately if the instance is reachable from the internet.
To connect a player, install Squeezelite or the Lyrion app and point it at the server's hostname from the instance URL.
Limitations
- Storage is limited to 50 GiB per instance.
- No password is set by default.