Auto-update README

README.md

@@ -15,10 +15,74 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-A Facebook puppeting bridge for Matrix/Synapse.
+A puppeting bridge between Matrix and Facebook packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Facebook user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Facebook room, so only someone with a Facebook account can participate to Facebook group conversations. The ["Mautrix-Facebook"](https://docs.mau.fi/bridges/python/facebook/index.html) bridge consists in a Synapse App Service and relies on postgresql (mysql also possible). Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand.
+
 
 **Shipped version:** 0.3.3~ynh1
 
+## Disclaimers / important information
+
+## List of known public services
+
+* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #facebook:maunium.net
+
+## Bridging usage
+** Note that several Facebook and Matrix users can be bridged, each Facebook account has its own bot administration room. If they are in a same Facebook group, only one matrix room will be created. **
+
+### Bridge a Facebook user and a Matrix user
+* First your Matrix user or Synapse Server has to be authorized in the Configuration of the bridge (see below)
+* Then, invite the bot (default @facebookbot:yoursynapse.domain)
+  * If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html)
+* Type ``!fb login <email> <password>``, where ``<email>`` and ``<password>`` are your Facebook email and password, e.g. ``!fb login gafam@evil.com facebookpwd``
+* If you have 2FA enabled, the bot will ask you to send the 2FA token.
+* By defaults, only conversations with very recent messages will be bridged
+* Accept invitations to the bridged chat rooms
+* Send ``!fb help`` to the bot in this new Mautrix-Facebook bot administration room to know how to control the bot.
+See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/facebook/authentication.html)
+
+### Double puppeting
+* First login as described in the previous section
+* Connect to the Matrix-Synapse Server to get an access token, for example with the command ``curl -XPOST -d '{"type":"m.login.password","identifier":{"type": "m.id.user", "user": "matrixusername"},"password":"matrixpassword","initial_device_display_name":"mautrix-facebook"}' https://yoursynapse.domain/_matrix/client/r0/login``
+* Send ``login-matrix <access token>``, where ``<access token>`` is the token received from the Server.
+* After logging in, the default Matrix puppet of your Facebook account should leave rooms and your account should join all rooms the puppet was in automatically.
+
+
+### Relaybot: Bridge a group for several Matrix and several Facebook users to chat together
+Not yet available
+
+## Configuration of the bridge
+
+The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_facebook_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the
+following configuration file with SSH: 
+```/opt/yunohost/mautrix_facebook/config.yaml```
+and then restarting the mautrix_facebook service.
+
+## YunoHost specific features
+
+#### Multi-user support
+
+* Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot. 
+* The Facebook bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
+* Several Facebook and Matrix users can be bridged with one bridge, each user has its own bot administration room. 
+* If several bot users are in a same Facebook group, only one Matrix room will be created by the bridge.
+* See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
+
+#### Multi-instance support
+
+* Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Facebook accounts. 
+* Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances.
+
+## Limitations
+
+* It looks like media are not bridged. 
+
+## Additional information
+
+* Other info you would like to add about this app.
+
+**More info on the documentation page:**  
+https://docs.mau.fi/bridges/python/facebook/index.html
+
 ## Documentation and resources
 
 * Official user documentation: <https://docs.mau.fi/bridges/python/facebook/index.html>

README_fr.md

@@ -15,10 +15,60 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
 
 ## Vue d'ensemble
 
-Passerelle Facebook pour Matrix/Synapse.
+Une passerelle entre Matrix et Messenger empaquetée comme un service YunoHost. Les messages, médias et notifications sont relayées entre un compte Messenger et un compte Matrix. 
+La passerelle ["Mautrix-Facebook"](https://docs.mau.fi/bridges/python/facebook/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql. C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit être préalablemnet installé.
+
+** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_facebook en même temps!**
+
 
 **Version incluse :** 0.3.3~ynh1
 
+## Avertissements / informations importantes
+
+## Liste de passerelles publiques
+
+* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #facebook:maunium.net
+
+## Usages de la passerelle
+** Notez que plusieurs comptes Messenger et Matrix peuvent être relayés, chaque compte Messenger connecté a son propre Salon d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe Messenger, seul un Salon Matrix sera créé par la passerelle. **
+
+### Relayer TOUTES les conversations entre UN compte Messenger et UN compte Matrix
+* Prérequis : votre compte Matrix ou le serveur sur lequel il est hébergé doit être autorisé dans la configuration de la passerelle (voir ci-dessous)
+* Invitez le Robot (par défaut @facebookbot:synapse.votredomaine) à une nouvelle conversation.
+* Ce nouveau salon d'administration du Robot Mautrix-Messenger est appelé "Administration Room".
+* Envoyez ``help`` au Robot dans le "Administration Room" pour une liste des commandes d'administration de la passerelle.
+Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/facebook/authentication.html)
+
+#### Relier la passerelle comme un appareil secondaire
+
+### Robot-Relai "Relaybot": Relayer les conversations de TOUS les comptes Matrix et TOUS les comptes Messenger présents dans UN groupe/salon
+* Pas implémenté pour l'instant
+
+## Configuration de la passerelle
+
+La passerelle est [configurée avec les paramètres standards adaptés pour votre YunoHost et l'instance Matrix-Synapse sélectionnée](https://github.com/YunoHost-Apps/mautrix_facebook_ynh/blob/master/conf/config.yaml). Vous pouvez par exemple ajouter des administrateur.ice.s et utilisateur.ice.s du Robot autorisés en modifiant le fichier de configuration par liaison SSH: 
+``` sudo nano /opt/yunohost/mautrix_facebook/config.yaml```
+puis en redémarrant le service: 
+``` sudo yunohost service restart mautrix_facebook```
+
+## Caractéristiques spécifiques YunoHost
+
+#### Support multi-comptes
+* Les utilisateur.ice.s du Robot ne sont pas liés aux comptes Yunohost. N'importe quel compte Matrix ou serveur Synapse autorisés dans la configuration de la passerelle peut inviter/utiliser le Robot. 
+* Le robot Messenger est un utilisateur Matrix-Synapse local, mais accessible via la fédération (Synapse public ou privé).
+* Plusieurs comptes Messenger et Matrix peuvent être liés avec une seule passerelle, chaque compte a son propre salon d'administration. 
+* Si plusieurs utilisateur.ice.s du Robot sont dans un même groupe Messenger, seul un Salon Matrix sera créé par la passerelle. Autrement dit, la passerelle construit un seul miroir du réseau de discussion existant sur Messenger (utilisateurs et salons).
+* Voir https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
+
+#### Support multi-instance
+
+* L'installation multi-instance devrait fonctionner. Plusieurs instances de passerelles pourraient être installées pour une instance de Matrix-Synapse. Cela permet à un compte matrix de se relier à plusieurs comptes Messenger. 
+* Plusieurs instances de passerelles pourraient être installées pour que chaque instance de Matrix-Synapse puisse en bénéficier. Mais une passerelle peut être utilisée par les comptes de plusieurs instances Matrix-Synapse.
+
+## Limitations
+
+* Les appels Audio/Video ne sont pas relayés. Seule une notification apparait. 
+
 ## Documentations et ressources
 
 * Documentation officielle utilisateur : <https://docs.mau.fi/bridges/python/facebook/index.html>