https://github.com/irosthebeggar/mstream
The easiest music streaming server available
https://github.com/irosthebeggar/mstream
javascript lokijs mstream music music-streaming music-streaming-server
Last synced: 5 months ago
JSON representation
The easiest music streaming server available
- Host: GitHub
- URL: https://github.com/irosthebeggar/mstream
- Owner: IrosTheBeggar
- License: gpl-3.0
- Created: 2015-12-05T22:26:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T18:10:49.000Z (6 months ago)
- Last Synced: 2025-05-11T03:44:03.213Z (5 months ago)
- Topics: javascript, lokijs, mstream, music, music-streaming, music-streaming-server
- Language: JavaScript
- Homepage: http://mstream.io
- Size: 108 MB
- Stars: 2,259
- Watchers: 48
- Forks: 194
- Open Issues: 80
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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!](https://demo.mstream.io/)
#### [Discord Channel](https://discord.gg/AM896Rr)
#### [Website](https://mstream.io)
### 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
* [Docker Instructions](https://github.com/linuxserver/docker-mstream)
* [Binaries for Win/OSX/Linux](https://mstream.io/server)
* [Install From Source](docs/install.md)
* [AWS Cloud using Terraform](https://gitlab.com/SiliconTao-Systems/nova)
## Mobile Apps
[
](https://apps.apple.com/us/app/mstream-player/id1605378892)
[
](https://play.google.com/store/apps/details?id=com.nieratechinc.mstreamplayer&hl=en_US)
[Made by Niera Tech](https://mplayer.nieratech.com/)
## Quick Install from CLI
Deploying an mStream server is simple.
```shell
# Install From Git
git clone https://github.com/IrosTheBeggar/mStream.git
cd mStream
# Install dependencies and run
npm run-script wizard
```
## 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](https://github.com/Borewit/music-metadata) - The best metadata parser for NodeJS
* [LokiJS](https://github.com/techfort/LokiJS) - A native, in-memory, database written in JavaScript. LokiJS is the reason mStream is so fast and easy to install
* [Butterchurn](https://github.com/jberg/butterchurn) - A clone of Milkdrop Visualizer written in JavaScript
And thanks to the [LinuxServer.io](https://www.linuxserver.io/) group for maintaining the Docker image!