1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/jitsi_ynh.git synced 2024-09-03 19:35:57 +02:00
jitsi_ynh/README.md

58 lines
2.6 KiB
Markdown
Raw Normal View History

2022-02-06 15:37:33 +01:00
<!--
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.
-->
2019-06-06 06:04:22 +02:00
# Jitsi Meet for YunoHost
2015-01-14 10:55:14 +01:00
2020-10-13 23:04:01 +02:00
[![Integration level](https://dash.yunohost.org/integration/jitsi.svg)](https://dash.yunohost.org/appci/app/jitsi) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.maintain.svg)
2022-02-06 15:37:33 +01:00
[![Install Jitsi Meet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jitsi)
2020-10-13 23:04:01 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-02-06 15:37:33 +01:00
> *This package allows you to install Jitsi Meet 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.*
2020-04-07 20:20:57 +02:00
2019-06-06 06:04:22 +02:00
## Overview
2022-02-06 15:37:33 +01:00
2019-09-23 22:34:01 +02:00
Jitsi Meet is a libre software (Apache) WebRTC JavaScript app that uses Jitsi Videobridge to provide high quality, secure, and scalable video conferences.
2019-06-06 06:04:22 +02:00
2022-04-16 20:43:25 +02:00
**Shipped version:** 1.0.5913~ynh3
2019-06-06 06:04:22 +02:00
2022-02-06 15:37:33 +01:00
**Demo:** https://meet.jit.si/
2019-06-06 06:04:22 +02:00
## Screenshots
2022-02-06 15:37:33 +01:00
![](./doc/screenshots/screenshot.png)
2019-06-06 06:04:22 +02:00
2022-02-06 15:37:33 +01:00
## Disclaimers / important information
2019-06-06 06:04:22 +02:00
2022-02-06 15:37:33 +01:00
## Important points before installing
2019-06-06 06:04:22 +02:00
2022-02-06 15:37:33 +01:00
1. **Jitsi** requires a dedicated **root domain**, eg. jitsi.domain.tld
2. **Jitsi** requires the ports TCP/4443 and UDP/10000 to be forwarded to your YunoHost (The same way you forwarded 80 (HTTP), 443 (HTTPS), etc... https://yunohost.org/#/isp_box_config)
3. **Jitsi** will stop and disable Metronome XMPP.
2022-04-16 20:43:25 +02:00
4. LDAP authentication is activated, only authenticated users to create new conference rooms. Whenever a new room is about to be created, Jitsi Meet will prompt for a user name and password. After the room is created, others will be able to join from anonymous domain.
5. **Jitsi** is configured for 50 users maximum, this number can be increase going to the Yunohost config panel
2022-02-11 00:47:06 +01:00
2022-02-06 15:37:33 +01:00
## Documentation and resources
2019-06-06 06:04:22 +02:00
2022-02-06 15:37:33 +01:00
* Official app website: https://jitsi.org/
* Official user documentation: https://jitsi.org/user-faq/
* Upstream app code repository: https://github.com/jitsi/jitsi-meet
* YunoHost documentation for this app: https://yunohost.org/app_jitsi
* Report a bug: https://github.com/YunoHost-Apps/jitsi_ynh/issues
2019-06-06 06:04:22 +02:00
2020-10-13 23:04:01 +02:00
## Developer info
2019-06-06 06:04:22 +02:00
2020-06-18 02:03:31 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jitsi_ynh/tree/testing).
2019-06-06 06:04:22 +02:00
2020-01-15 21:40:17 +01:00
To try the testing branch, please proceed like that.
2019-06-06 06:04:22 +02:00
```
sudo yunohost app install https://github.com/YunoHost-Apps/jitsi_ynh/tree/testing --debug
or
sudo yunohost app upgrade jitsi -u https://github.com/YunoHost-Apps/jitsi_ynh/tree/testing --debug
```
2022-02-06 15:37:33 +01:00
2022-04-16 20:43:25 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps