Skip to content

Repository files navigation

mStream Music

The easiest music streaming sever

Main Shared Admin
main shared admin

Demo & Other Links

Notable Features

mStream has some unique features other server's don't have

Album Art Lookup

mStream automatically retrieves album art for your collection

Quick Sync - Zero Configuration Deployments

Enable Quick Sync in the Admin Panel to access mStream without setting up port forwarding, DNS, SSL, etc. Quick Sync is a free VPN-like service powered by Iroh

NOTE: Quick Sync only works for mobile apps and the upcoming desktop app. The webapp will not work (it's the price of not having to setup DNS/SSL).

P2P Discovery

When enabled, this feature will automatically download music discovery data from other mStream servers. With this data, mStream can show your songs that are not in your collection that are similar to what your are listening to.

Please note, this is discovery only. You will have to find these songs on your own.

Federation

You can federate with other servers. Federated servers have read access to eachother's data. With this, your p2p discovery feature can now stream discovered music.

Public mode

The demo site does not require you to sign in because mStream is publicly accessible by default. This makes it easy to setup and gives you the option to keep it publicly available if you are just running it on a secured network. Once you add a user, the system becomes password protected.

Installing mStream

Binaries

NOTE: as of v6.13, mStream no longer uses electron to build binaries. The new binaries comes in two flavors: a minimal build that is just the server, or a batteries included build that comes with all the convenience features (auto update, run server on system boot, etc). The binaries are included on the release page, and the batteries included build will be released soon.

Docker

Other

Mobile Apps

Official Android App

mStream Android App

The iOS app is currently in review. You can get early access to it here: https://testflight.apple.com/join/dX37YTzK

mStream iOS App mStream Android App

Feature List

  • Torrent Client Integration - Manage your torrents through mStream
  • YT-DLP integration - Download youtube videos as audio files
  • DLNA Support
  • Automatic Backup Feature - Backup your music to any drive connected to your server
  • Transcoding
  • Subsonic API support
  • Auto DJ - Automatically queue up songs
  • Lyrics Support - includes being able to search by lyrics
  • Jukebox Mode - Control your browser remotely
  • Local server audio playback - Note, will not work on Docker

Credits

mStream is built on top of some great open-source libraries:

  • music-metadata - The metadata parser used by the JS scanner fallback
  • Lofty - Audio tag reader powering the Rust scanner
  • Symphonia - Pure-Rust audio decoder used to render waveform previews during a scan
  • Butterchurn - A clone of Milkdrop Visualizer written in JavaScript
  • LRCLib - Optional source for synced lyrics

And thanks to the LinuxServer.io group for maintaining the Docker image!

Releases

Sponsor this project

Packages

Used by

Contributors

Languages