Skip to content
/ lms Public

Lightweight Music Server. Access your self-hosted music using a web interface.

License

Notifications You must be signed in to change notification settings

epoupon/lms

Repository files navigation

LMS - Lightweight Music Server

Last Release

LMS is a self-hosted music streaming software: access your music collection from anywhere using a web interface!

A demo instance is available. Note the administration settings are not available.

Main features

  • Subsonic/OpenSubsonic API support
  • Multi-valued tags: genre, mood, artists, ...
  • Artist relationships: composer, conductor, lyricist, mixer, performer, producer, remixer
  • Release types: album, single, EP, compilation, live, ...
  • Release groups support to show different versions of albums, such as remasters, reissues, etc.
  • MusicBrainz Identifier support to handle duplicated artist and release names
  • ListenBrainz support for:
    • Scrobbling and synchronizing listens
    • Synchronizing 'love' feedbacks
  • Recommendation engine
  • Multi-library support
  • ReplayGain support
  • Audio transcoding for compatibility and reduced bandwidth
  • User management, with several authentication backends
  • Playlists support
  • Lyrics support

Music discovery

LMS provides several ways to help you find the music you like:

  • Tag-based filters (ex: "Rock", "Metal and Aggressive", "Electronic and Relaxed", ...)
  • Recommendations for similar artists and albums
  • Radio mode, with endless filling of the play queue with tracks similar to what is there
  • Searches in album, artist and track names (including sort names)
  • Starred Albums/Artists/Tracks
  • Random/Starred/Most played/Recently played/Recently added for Artist/Albums/Tracks, allowing you to search for things like:
    • Recently added Electronic artists
    • Random Metal and Aggressive albums
    • Most played Relaxed tracks
    • Starred Jazz albums
    • ...

Note: depending on your database size and/or your hardware, the tag-based recommendation engine may significantly slow down the user interface. You can disable it in the administration settings.

About tags

LMS primarily relies on tags to organize your music collection but also supports browsing by directory using the Subsonic/OpenSubsonic API.

Filtering

It is possible to apply global filters on your collection using genre, mood, grouping, language, and by music library. More tags, including custom ones, can be added in the database administration settings.

Note: You can use the lms-metadata tool to get an idea of the tags parsed by LMS.

Multiple artists

LMS works best when using the default Picard settings, where the artist tag contains a single display-friendly value, and the artists tag holds the actual artist names. This ensures a cleaner, more organized representation of artist names, when multiple artists are involved.

Multiple album artists

While LMS can manage multiple album artists using the albumartist tag, it works better when using the custom albumartists and albumartistssort tags, similar to how it handles regular artist tags.

Note: if you use Picard, add the following script to include these tags:

$setmulti(albumartists,%_albumartists%)
$setmulti(albumartistssort,%_albumartists_sort%)

Album track grouping

The recommended way to group tracks within an album is to use the MUSICBRAINZ_ALBUMID tag.

When this tag is not present, LMS will attempt to group them as best as possible: if the analyzed file contains a disc number and the total number of discs is greater than 1, sibling directories are also scanned to find a matching album. Otherwise, LMS will only consider albums within the current directory.

For an album to be considered a match, the following conditions must be met:

  • Same name
  • Same sort name
  • Same total number of discs
  • Identical 'compilation' flag value
  • Same record labels
  • Same barcode

Artist image lookup

The recommended method is to name the artist image file using the artist's MusicBrainz ArtistID. This file can be placed anywhere within one of the scanned libraries.

If no file with the MusicBrainz ArtistID is found, LMS will look for a file named artist (or another name configured in lms.conf) in the artist's directories:

  1. Identify the artist's directory: LMS selects all albums by the artist using the "AlbumArtist" link and determines the longest common path among them.
  2. Scan for the image: the directory is scanned starting from this common path, moving upwards if needed, until the artist image file is found.
  3. Fallback search: if no image is found, LMS will then search within each individual album folder.

Playlist support

LMS supports playlist files in m3u and m3u8 formats. These playlists are synced during the scan process and are available as public shared playlists.

Lyrics support

LMS supports lyrics in lrc files, txt files, and embedded track metadata. Both synchronized and unsynchronized lyrics are supported.

Keyboard shortcuts

  • Play/pause: Space
  • Previous track: Ctrl + Left
  • Next track: Ctrl + Right
  • Decrease volume: Ctrl + Down
  • Increase volume: Ctrl + Up
  • Seek back by 5 seconds: Ctrl + Shift + Left
  • Seek forward by 5 seconds: Ctrl + Shift + Right

Installation

See INSTALL.md file.

Contributing

Any feedback is welcome:

  • feel free to participate in discussions if you have questions,
  • report any bug or request for new features in the issue tracker,
  • submit your pull requests based on the develop branch.