mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.
The best way to install mStream is to pull the latest version with git and build that. The full instruction for a fresh Ubuntu install can be found here. The quick version is:
```shell git clone https://github.com/IrosTheBeggar/mStream.git cd mStream
npm install --only=production sudo npm link ```
mStrean is also available as a pre-compiled EXE for Windows. This version is called mStream Express and can be downloaded from the release page
mStream can be run with command
mstream. This will boot an mStream server on port 3000 and will use the current working directory as your music directory.
The quickest way to setup mStream is to use command line flags. A full list of command line settings can be seen here. These config options should be enough for most users. More advanced configurations can be made by using a JSON config file
mstream -p 4999
mstream -u username -x password
mstream -m /path/to/music
mstream -l username -z password ```
mStream can also be booted using a JSON file using the
-j flag. Using a JSON config file allows for more 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
An example config is shown below. You can see the full set of config options here
"vpaths": ["blues", "metal"]
mStream is currently adding support for the subsonic API. Once that's done mStream will be accessible by a number of mobile apps
There is also an mStream Android App that is currently in the alpha stages of development.
mStream uses a JSON based REST API. The API is documented here