mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.
- Works Cross Platform. Tested on Windows, OSX, Ubuntu, Arch, and Raspbian
- Dependency Free Installation
- Light on memory and CPU usage
- Tested on multi-terabyte libraries
- Gapless Playback
- Milkdrop Visualizer
- Playlist Sharing
- Upload Files through the file explorer
- AutoDJ - Queues up random songs
Install mStream Binaries for Win/OSX/Linux
This is the easiest way to install mStream. They have no dependencies so you can just download and run them. These releases come with an additional set of UI tools and features:
- Adds tray icon for easy server management
- Auto boots server on startup
- Comes with a GUI tools for server configuration
- No command line needed! Any user can install and run these
Install mStream From The Command Line
If you just want the core part of mStream without all the UI tools, you can install mStream from the NPM or Git repositories.
# Install From Git git clone https://github.com/IrosTheBeggar/mStream.git cd mStream npm install sudo npm link # To update mStream just pull from git and reboot the server git pull
You can also install mStream through npm with
npm install -g mstream. This is not recommended since some OSes (like Ubuntu) require sudo to do this.
To test your installation, run the command
mstream. This will boot an mStream server on port 3000 and will use the current working directory as your music directory.
# the login system will be disabled if these values are not set mstream -u username -x password # set music directory mstream -m /path/to/music
Configure mStream with a JSON file
mStream can also be booted using a JSON file using the
-j flag. Using a JSON config file allows for advanced configuration options, such as multiple users and folders. When booting with a JSON config file, all other flags will be ignored.
mstream -j /path/to/config.json
Editing a JSON config by hand is tedious, so mStream comes with an interactive bash program to edit the config file.
# Brings up an interactive shell program to edit all things in the config mstream --wizard /path/to/config.json
mStream has an Android App in progress. The app is currently in the alpha stage of development, but it works well enough for public use. The app will be released to Google Play once it's no longer an alpha.
mStream uses a JSON based REST API. The API is documented here
mStream is currently in need of a mobile developer to help with an app to sync music between devices. If you're interested in helping, email me at email@example.com
mStream is technically several different projects, each in their own stage of development.
- Server Core [v4] - The actually server code
- Server CLI Tools [v1] - These tools let you boot and configure the server via the through the command prompt. These were moved to v1 with the completion of the JSON configuration wizard
- Server Express Framework [v0.12] - Remember how the CLI tools are separate from the Server? The Express Framework allows mStream Server to be compiled to a binary that can be booted an configured entirely though a GUI. No command line needed.
- WebApp [v4] - The webApp has been built in parallel with the server
- Android App [v0.4alpha] - An android client that can stream and sync files from any mStream server