From 3f4d34667edd55909d9b526768da819570fadad9 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Mon, 7 Mar 2022 17:41:23 +0000 Subject: [PATCH] Auto-update README --- README.md | 112 ++++++++------------------------------------------- README_fr.md | 112 ++++++++------------------------------------------- 2 files changed, 34 insertions(+), 190 deletions(-) diff --git a/README.md b/README.md index bcd62d3..3989bef 100644 --- a/README.md +++ b/README.md @@ -1,110 +1,36 @@ -# A Matrix-Facebook puppeting bridge for YunoHost + + +# Matrix-Facebook bridge for YunoHost [![Integration level](https://dash.yunohost.org/integration/mautrix_facebook.svg)](https://dash.yunohost.org/appci/app/mautrix_facebook) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_facebook.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_facebook.maintain.svg) -[![Install Mautrix-Facebook with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_facebook) +[![Install Matrix-Facebook bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_facebook) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Mautrix-Facebook quickly and simply on a YunoHost server. +> *This package allows you to install Matrix-Facebook bridge 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 -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.0 +A Facebook puppeting bridge for Matrix/Synapse. -## Screenshots - -![](Link to a screenshot of this app.) - -## 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 ``, where ```` and ```` 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 ``, where ```` 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. +**Shipped version:** 0.3.0~ynh1 -### Relaybot: Bridge a group for several Matrix and several Facebook users to chat together -Not yet available -## Configuration of the bridge +## Documentation and resources -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. - -## Documentation - - * Official "Mautrix-Facebook" documentation: https://docs.mau.fi/bridges/python/facebook/index.html - * Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr - * Matrix room (upstream app): #facebook:maunium.net -In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with -``| sed -r 's/[0-9]{10,}/📞/g' `` - * YunoHost documentation: If more specific documentation is needed, feel free to contribute. - -## 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. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_facebook%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_facebook/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_facebook%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_facebook/) - -## 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 - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/mautrix_facebook_ynh/issues - * App website: https://github.com/YunoHost-Apps/mautrix_facebook_ynh - * Upstream app documentation: https://docs.mau.fi/bridges/python/facebook/index.html - * Upstream app repository: https://github.com/tulir/mautrix-facebook - * YunoHost website: https://yunohost.org/ - ---- +* Official user documentation: https://docs.mau.fi/bridges/python/facebook/index.html +* Official admin documentation: https://docs.mau.fi/bridges/python/setup/index.html?bridge=facebook +* Upstream app code repository: https://github.com/mautrix/facebook +* YunoHost documentation for this app: https://yunohost.org/app_mautrix_facebook +* Report a bug: https://github.com/YunoHost-Apps/mautrix_facebook_ynh/issues ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mautrix_facebook_ynh/tree/testing). To try the testing branch, please proceed like that. @@ -114,8 +40,4 @@ or sudo yunohost app upgrade mautrix_facebook -u https://github.com/YunoHost-Apps/mautrix_facebook_ynh/tree/testing --debug ``` -To test communication between the App Service and Matrix-Synapse on a VM (e.g. with domain name: synapse.vm), you must install a certificate: -``` -echo | openssl s_client -showcerts -servername synapse.vm -connect synapse.vm:443 2>/dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt -update-ca-certificates -``` +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index a731ff7..1ef4dd0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,106 +1,32 @@ -# Une passerelle entre Matrix et Facebook/Messenger pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/mautrix-facebook.svg)](https://dash.yunohost.org/appci/app/mautrix-facebook) -[![Install Mautrix-Messenger with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mautrix-facebook) +# Matrix-Facebook bridge pour YunoHost -*[Read this readme in english.](./README.md)* +[![Niveau d'intĂ©gration](https://dash.yunohost.org/integration/mautrix_facebook.svg)](https://dash.yunohost.org/appci/app/mautrix_facebook) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_facebook.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_facebook.maintain.svg) +[![Installer Matrix-Facebook bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_facebook) -> *Ce package vous permet d'installer Mautrix-Messenger rapidement et simplement sur un serveur Yunohost. +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Matrix-Facebook bridge rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -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!** +Passerelle Facebook pour Matrix/Synapse. -**Version incluse:** 0.3.0 +**Version incluse :** 0.3.0~ynh1 -## Captures d'Ă©cran -![](Lien vers une capture d'Ă©cran pour cette application) -## Liste de passerelles publiques +## Documentations et ressources -* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #facebook:maunium.net +* Documentation officielle utilisateur : https://docs.mau.fi/bridges/python/facebook/index.html +* Documentation officielle de l'admin : https://docs.mau.fi/bridges/python/setup/index.html?bridge=facebook +* DĂ©pĂŽt de code officiel de l'app : https://github.com/mautrix/facebook +* Documentation YunoHost pour cette app : https://yunohost.org/app_mautrix_facebook +* Signaler un bug : https://github.com/YunoHost-Apps/mautrix_facebook_ynh/issues -## 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. ** +## Informations pour les dĂ©veloppeurs -### 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``` - -## Documentation - - * Documentation officielle "Mautrix-Facebook": https://docs.mau.fi/bridges/python/facebook/index.html - * Salon Matrix sur les Passerelles dans Yunohost): #mautrix_yunohost:matrix.fdn.fr - * Salon Matrix (application principale): #facebook:maunium.net -Si vous devez tĂ©lĂ©verser vos fichiers log quelque-part, soyez avertis qu'ils contiennent des informations sur vos contacts et vos numĂ©ros de tĂ©lĂ©phone. Effacez-les avec -``| sed -r 's/[0-9]{10,}/📞/g' `` - * La passerelle "Mautrix-Messenger" repose sur l'implĂ©mentation du [daemon facebookd](https://gitlab.com/facebookd/facebookd) . - * Documentation YunoHost: Si une documentation spĂ©cifique est nĂ©cessaire, n'hĂ©sitez pas Ă  contribuer. - -## 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. - -#### Architectures supportĂ©es - -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_facebook%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_facebook/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_facebook%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_facebook/) - -## Limitations - -* Les appels Audio/Video ne sont pas relayĂ©s. Seule une notification apparait. - -## Informations additionnelles - -* - -**Plus d'informations sur la page de documentation:** - -* https://docs.mau.fi/bridges/python/facebook/index.html -* https://yunohost.org/packaging_apps - -## Liens - - * Signaler un bug: https://github.com/YunoHost-Apps/mautrix_facebook_ynh/issues - * Site de l'application: https://github.com/YunoHost-Apps/mautrix_facebook_ynh - * Documentation de l'application principale: https://docs.mau.fi/bridges/python/facebook/index.html - * DĂ©pĂŽt de l'application principale: https://github.com/tulir/mautrix-facebook - * Site web YunoHost: https://yunohost.org/ - ---- - -Informations pour les dĂ©veloppeurs ----------------- - -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mautrix_facebook_ynh/tree/testing). Pour essayer la branche testing, procĂ©dez comme suit. @@ -110,8 +36,4 @@ ou sudo yunohost app upgrade mautrix_facebook -u https://github.com/YunoHost-Apps/mautrix_facebook_ynh/tree/testing --debug ``` -Pour tester la communication entre le Service d'Application et Matrix-Synapse sur une Machine Virtuelle (ex. avec un nom de domaine: synapse.vm), vous devez installer un certificat: -``` -echo | openssl s_client -showcerts -servername synapse.vm -connect synapse.vm:443 2>/dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt -update-ca-certificates -``` +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file