# mStream for YunoHost [![Integration level](https://dash.yunohost.org/integration/mstream.svg)](https://dash.yunohost.org/appci/app/mstream) ![](https://ci-apps.yunohost.org/ci/badges/mstream.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mstream.maintain.svg) [![Install mStream with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mstream) *[Lire ce readme en français.](./README_fr.md)* > *This package allows you to install mStream quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ### Features Cross Platform. Works on Windows, OSX, Linux, & FreeBSD Light on memory and CPU Tested on multi-terabyte libraries Runs on ARM boards like the Raspberry Pi **Shipped version:** 5.11.4~ynh1 **Demo:** https://demo.mstream.io/? ## Screenshots ![](./doc/screenshots/mstreamv5.png) ## Disclaimers / important information * Any known limitations, constrains or stuff not working, such as (but not limited to): * requiring a full dedicated domain ? * architectures not supported ? * not-working single-sign on or LDAP integration ? * the app requires an important amount of RAM / disk / .. to install or to work properly * etc... * Other infos that people should be aware of, such as: * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * how to configure / administrate the application if it ain't obvious * upgrade process / specificities / things to be aware of ? * security considerations ? ## Documentation and resources * Official app website: https://mstream.io/ * Official user documentation: https://yunohost.org/apps * Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/IrosTheBeggar/mStream * YunoHost documentation for this app: https://yunohost.org/app_mstream * Report a bug: https://github.com/YunoHost-Apps/mstream_ynh/issues ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mstream_ynh/tree/testing). To try the testing branch, please proceed like that. ``` sudo yunohost app install https://github.com/YunoHost-Apps/mstream_ynh/tree/testing --debug or sudo yunohost app upgrade mstream -u https://github.com/YunoHost-Apps/mstream_ynh/tree/testing --debug ``` **More info regarding app packaging:** https://yunohost.org/packaging_apps