4.6 KiB
mStream
Check Out The Demo!
mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.
Server Features
- 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
WebApp Features
- 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 --only=production
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.
Quick Start
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.
# change port (defaults to 3000)
mstream -p 4999
# the login system will be disabled if these values are not set
mstream -u username -x password
# set music directory
# defaults to the current working directory if not set
mstream -m /path/to/music
## lastFM Scrobbling
mstream -l username -z password
Configure mStream with a JSON file
mStream can also be booted using a JSON file using the -j flag.
mstream -j /path/to/config.json
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.
Editing a JSON config by hand is tedious. There's a number of special flags that will launch a prompt to guide you through editing the config. It's recommended you run the --wizard program if this is your first time using mStream
# Setup Wizard
# This brings up an interactive shell program to edit all things in the config
mstream --wizard /path/to/config.json
# Some other useful commands to edit your config
mstream -j config.json --addpath /path/to/folder
mstream -j config.json --adduser
mstream -j config.json --removeuser
mstream -j config.json --removepath
mstream -j config.json --editport
mstream -j config.json --makesecret
# Add SSL Key/Cert
mstream -j config.json --addkey <ssl key>
mstream -j config.json --addcert <ssl cert>
Android/iPhone Apps
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.
For now you can download it from the git repo
The API
mStream uses a JSON based REST API. The API is documented here
The Docs
All the details about mStream are available in the docs folder
Contributing
Like the project? Consider sending us some money on Patreon
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 paul@mstream.io