mirrors/mStream
3
0
Fork 0
mirror of https://github.com/IrosTheBeggar/mStream.git synced 2025-10-27 07:31:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
The easiest music streaming server available
275 Commits 7 Branches 108 Tags 112 MiB
JavaScript 75.1%
HTML 19%
CSS 5.9%
673f909872
Go to file
IrosTheBeggar 673f909872 Removed guest user
2017-10-23 01:53:16 -04:00
docs Removed guest user 2017-10-23 01:53:16 -04:00
electron Added docs 2017-09-17 16:06:09 -04:00
image-cache Full metadata support and some bug fixes for mobile 2017-04-11 15:08:51 -04:00
modules Removed guest user 2017-10-23 01:53:16 -04:00
public Store last volume on mute 2017-10-17 19:50:23 -04:00
.gitignore Ignore package-lock until I have a better idea of wehat it does 2017-10-18 21:37:16 -04:00
Dockerfile Added Dockerfile and modified README 2016-08-26 09:33:39 +02:00
LICENSE Create LICENSE 2017-04-29 13:53:32 -04:00
mstream-command-line-boot-wrapper.js Improved electron detection 2017-09-18 16:08:16 -04:00
mstream-electron.js Removed guest user 2017-10-23 01:53:16 -04:00
mstream.js More DB improvements 2017-10-15 02:08:34 -04:00
package.electron.json Imrproved docs 2017-10-16 17:57:24 -04:00
package.json Removed guest user 2017-10-23 01:53:16 -04:00
README.md Fixed some embarrassing typos 2017-10-02 14:29:37 -04:00

README.md

mStream

mStream is a personal music streaming server written in NodeJS. The goal of mStream is to be the easiest music streaming server software available.

Links

See The Demo (no password required)

See The Demo (username: admin, password: abc123)

mStream Download Page

mStream Website

Install mStream

mStream can be installed on Mac, Windows, and Linux with NPM.

mStream is also available as a pre-compiled EXE for Windows. This version of mStream was created so solve the problem of dealing with NPM on Windows. Seriously, don't install mStream in Windows via NPM unless you know what you are doing. This pre-compiled version is called mStream Express and will work right out of the box and has no dependencies. It has some additional features as well, such as adding a Tray Icon to manage your server.

Install with NPM:

Install mStream Express for Windows

mStream Server Features

  • Works on Mac/Windows/Linux
  • Lightweight: uses less than 50MB of memory under normal load
  • SSL Support + JSON Web Token Authentication for security
  • Automatically scans library for metadata and album art
  • Server uses a RESTful JSON API. It's documented and easy to write code against

mStream Webapp Features

  • Supports FLAC streaming on all browsers
  • Responsive UI
  • Song caching for gapless playback
  • Jukebox Mode allows you to control the webapp from your phone
  • Built in VueJS

Android App

There is currently and mStream Android App under development. All the core media player features work, but the UI could use some work. It's not available on the App Store, but you can get the latest version here

  • Supports FLAC streaming
  • Allows you to download files to your phone for offline playback
  • Can connect to multiple servers
  • Open Source

Additional Reading

All the details about mStream are available in the docs folder

Contributing

Like the project? Consider sending us some money on Patreon