mStream/README.md

mStream Music

mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.

Main	Shared	Admin

Demo & Other Links

Check Out The Demo!

Discord Channel

Website

Server Features

• Cross Platform. Works on Windows, OSX, Linux
• Light on memory and CPU
• Tested on multi-terabyte libraries
• Runs on ARM board like the Raspberry Pi

WebApp Features

• Gapless Playback
• Milkdrop Visualizer
• Playlist Sharing
• Upload Files through the file explorer

Installing mStream

• Install From Source - Rolling release with the latest code, bugs included
• Docker Instructions - Stable Releases
• Binaries for Win/OSX/Linux - Stable Releases & Extra Features. It's built with Electron. Read more about it here
• AWS Cloud using Terraform

Quick Install from CLI

# Install From Git
git clone https://github.com/IrosTheBeggar/mStream.git
cd mStream
npm install

# Boot mStream
node cli-boot-wrapper.js

To uninstall mStream run rm -r mStream

Technical Details

• Dependencies: NodeJS v10 or greater

• Supported File Formats: flac, mp3, mp4, wav, ogg, opus, aac, m4a

The Docs

All the details about mStream are available in the docs folder

Credits

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

• music-metadata - The best metadata parser for NodeJS
• LokiJS - A native, in-memory, database written in JavaScript. LokiJS is the reason mStream is so fast and easy to install
• Butterchurn - A clone of Milkdrop Visualizer written in JavaScript

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