|Paul Sori eaff0d9c94 removing cruft||5 days ago|
|docs||2 weeks ago|
|electron||3 months ago|
|image-cache||1 year ago|
|logs||3 months ago|
|modules||2 weeks ago|
|public||5 days ago|
|save||2 months ago|
|.gitignore||2 months ago|
|Dockerfile||11 months ago|
|LICENSE||1 year ago|
|README.md||1 month ago|
|_config.yml||2 months ago|
|cli-boot-wrapper.js||2 months ago|
|mstream-electron.js||2 months ago|
|mstream.js||2 months ago|
|package.json||2 months ago|
mStream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere.
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:
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
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 protected]
mStream is technically several different projects, each in their own stage of development.