mirror of https://github.com/IrosTheBeggar/mStream.git synced 2025-10-27 07:31:02 +00:00

The easiest music streaming server available

javascript lokijs mstream music music-streaming music-streaming-server

Go to file

IrosTheBeggar 88a7157a04 fix access error		2022-01-30 21:33:04 -05:00
.github	build webapp step	2021-12-29 10:09:24 -05:00
bin	code cleanup for syncthing	2021-04-17 14:47:27 -04:00
build	v5.4.0	2021-09-27 00:06:03 -04:00
docs	updated docs	2021-10-12 16:10:56 -04:00
image-cache	cleanup	2021-03-04 23:01:49 -05:00
save	update server config handling	2021-01-04 23:04:55 -05:00
src	fix access error	2022-01-30 21:33:04 -05:00
webapp	v5.9.4	2021-12-29 10:27:56 -05:00
.gitignore	remove jquery	2021-11-27 13:53:08 -05:00
cli-boot-wrapper.js	update actions	2021-08-11 20:44:15 -04:00
dev-app-update.yml	auto updater	2019-10-24 23:33:02 -04:00
LICENSE	Create LICENSE	2017-04-29 13:53:32 -04:00
package.json	v5.9.4	2021-12-29 10:27:56 -05:00
README.md	forgot a line	2021-11-24 00:30:30 -05:00

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, & FreeBSD
Light on memory and CPU
Tested on multi-terabyte libraries
Runs on ARM boards like the Raspberry Pi

WebApp Features

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

Installing mStream

Install From Source
Docker Instructions
Binaries for Win/OSX/Linux - mStream binaries are compiled with Electron and have some extra features
- Runs in background and starts mStream on boot
- Automatic updates
- Adds a tray icon to manage mStream
AWS Cloud using Terraform

Quick Install from CLI

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

# Boot mStream
node cli-boot-wrapper.js

Android App

This App is Open Source. See the Source Code

Technical Details

Dependencies: NodeJS v10 or greater
Supported File Formats: flac, mp3, mp4, wav, ogg, opus, aac, m4a

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!