mumble-web_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Mumble Web for YunoHost

[![Integration level](https://dash.yunohost.org/integration/mumble-web.svg)](https://dash.yunohost.org/appci/app/mumble-web) ![Working status](https://ci-apps.yunohost.org/ci/badges/mumble-web.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mumble-web.maintain.svg)  
[![Install Mumble Web with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mumble-web)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Mumble Web 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

mumble-web is an HTML5 Mumble client for use in modern browsers.
The Mumble protocol uses TCP for control and UDP for voice. Running in a browser, both are unavailable to this client. Instead Websockets are used for control and WebRTC is used for voice (using Websockets as fallback if the server does not support WebRTC).

**Shipped version:** 1.3.0~ynh4


**Demo:** https://web.mumble.framatalk.org/

## Screenshots

![Screenshot of Mumble Web](./doc/screenshots/screenshot.png)

## Disclaimers / important information

## Setup

- In order to use *Mumble web*, you need to install [Mumble server](https://github.com/YunoHost-Apps/mumbleserver_ynh) first.
- This installation assumes that *Mumble server* is served by port `64738`
- Various configuration options are available for Mumble web on this configuration file `/var/www/mumble-web/dist/config.local.js`

## Documentation

- Murmur documentation: https://wiki.mumble.info/wiki/Murmurguide
- Framasoft documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html

## Documentation and resources

* Official app website: <https://mumble.info>
* Official admin documentation: <https://docs.framasoft.org/fr/jitsimeet/mumble.html>
* Upstream app code repository: <https://github.com/Johni0702/mumble-web/>
* YunoHost documentation for this app: <https://yunohost.org/app_mumble-web>
* Report a bug: <https://github.com/YunoHost-Apps/mumble-web_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mumble-web_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/mumble-web_ynh/tree/testing --debug
or
sudo yunohost app upgrade mumble-web -u https://github.com/YunoHost-Apps/mumble-web_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>