Merge branch 'testing' into version-2

README.md

@@ -27,6 +27,31 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly
 
 ![Screenshot of PeerTube](./doc/screenshots/screenshot1.jpg)
 
+## Disclaimers / important information
+
+### IMPORTANT POINT TO READ BEFORE INSTALLING
+* Require **dedicated domain** like **peertube.domain.tld**.
+* Admin username is: **root**.
+* **Admin password and LDAP configuration** will be sent to the email address given at the time of the installation.
+* URL can not be changed once selected. Choose the domain wisely.
+* You need more then **1 GB** of RAM. If you don't have it, please create a **swap memory**.
+ 
+        $ dd if=/dev/zero of=/swapfile bs=1024 count=1048576
+        $ mkswap /swapfile
+        $ swapon /swapfile
+        $ echo "/swapfile swap swap defaults 0 0" >> /etc/fstab
+        
+* This app is **multi-instance** (you can have more then one PeerTube instance running on a YunoHost server)
+* **If you are hosted on OVH virtual machine or experiencing `gyp ERR! configure error`, please switch to [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
+* HTTP auth is not supported
+* Do not modify the `/var/www/<app>/conf/production.yaml` file, because it will be overridden in the next upgrade. Please instead either change them though the web interface or create a `/var/www/<app>/conf/local.yaml` file, assign it the same owner, group and rights than for `conf/production.yaml` and fill there your specific settings.
+    * Note: when the same option have different values in `production.yaml` and `local.yaml` files, only the value in `local.yaml` is taken into account.
+
+### PLUGINS
+* LDAP auth is supported, LDAP configuration will be sent to the email address given at the time of the installation.
+* PeerTube plugin livechat is installed with Prosody. To enable, just select «Prosody server controlled by Peertube» as chat mode in the plugin configutation of the PeerTube admin page
+* During install, because of Prosody, Metronome is disabled
+
 ## Documentation and resources
 
 * Official app website: <https://joinpeertube.org/fr>

README_fr.md

@@ -27,6 +27,30 @@ Plateforme de streaming vidéo fédérée (ActivityPub) utilisant P2P (BitTorren
 
 ![Capture d’écran de PeerTube](./doc/screenshots/screenshot1.jpg)
 
+## Avertissements / informations importantes
+
+### Points importants à lire avant l'installation
+* Le nom d'utilisateur de l'administrateur est: **root**.
+* **Le mot de passe administrateur et la configuration LDAP** seront envoyés à l'adresse email indiquée au moment de l'installation.
+* L'URL ne peut pas être modifiée une fois sélectionnée. Choisissez judicieusement le domaine.
+* Vous avez besoin de plus de **1 Go** de RAM. Si vous ne l'avez pas, veuillez créer une **mémoire swap**.
+ 
+        $ dd if=/dev/zero of=/swapfile bs=1024 count=1048576
+        $ mkswap /swapfile
+        $ swapon /swapfile
+        $ echo "/swapfile swap swap defaults 0 0" >> /etc/fstab
+
+* **Si vous êtes hébergé sur une machine virtuelle OVH ou rencontrez `gyp ERR! configure error`, veuillez passer à [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
+* L'authentification HTTP n'est pas supportée
+* Ne modifiez pas le fichier `/var/www/<app>/conf/production.yaml`, car il sera remplacé à la prochaine mise à jour. À la place, veuillez modifier la configuration via l'interface web ou créer et remplir le fichier `/var/www/<app>/conf/local.yaml`, assignez-lui les mêmes propriétaire, groupe et droits que pour `conf/production.yaml` et y remplir vos options spécifiques.
+    * Note: si la même option contient différentes valeurs dans les fichiers `conf/production.yaml` et `conf/local.yaml`, seule la valeur dans `conf/local.yaml` sera prise en compte.
+
+#### PLUGINS
+
+* L'authentification LDAP est prise en charge, les instructions de configuration sont envoyées à l'adresse email indiquée au moment de l'installation
+* Le plugin PeerTube livechat est installé ainsi que Prosody. pour l'activer, sélectionner «Prosody server controlled by Peertube» dans le paramétre chat mode du plugin dans la page d'administration de PeerTube.
+* Pendant l'installation, à cause de Prosody, Metronome est désactivé.
+
 ## Documentations et ressources
 
 * Site officiel de l’app : <https://joinpeertube.org/fr>