From 6fb89341685add64c2b1192ca618498587cf93b2 Mon Sep 17 00:00:00 2001 From: Mayeul Cantan Date: Sun, 21 Apr 2024 18:23:25 +0200 Subject: [PATCH] Update documentation following the python->go migration --- README.md | 2 +- doc/ADMIN.md | 5 ++--- doc/DESCRIPTION.md | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 83d78df..51e80d0 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It shall NOT be edited by hand. A puppeting bridge between Matrix and Signal packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Signal user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Signal room, so only someone with a Signal account can participate to Signal group conversations. -The ["Mautrix-Signal"](https://docs.mau.fi/bridges/python/signal/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. +The ["Mautrix-Signal"](https://docs.mau.fi/bridges/go/signal/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.5.1~ynh1 diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 5f346a6..2081f7b 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -12,7 +12,7 @@ * Then, invite the bot (default @signalbot:yoursynapse.domain) in this new Mautrix-Signal bot administration room. * If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html) * Send ``!sg help`` to the bot in the created room to know how to control the bot. -See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/signal/authentication.html) +See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/go/signal/authentication.html) #### Linking the Bridge as a secondary device @@ -50,12 +50,11 @@ and then restarting the mautrix_signal service. ## Documentation -* Official "Mautrix-Signal" documentation: +* Official "Mautrix-Signal" documentation: * Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr * Matrix room (upstream app): #signal: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'``` -* "Mautrix-Signal" bridge is based on the [signal daemon](https://gitlab.com/signald/signald) project. * YunoHost documentation: If more specific documentation is needed, feel free to contribute. ## YunoHost specific features diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index d3721dd..1a4ca9a 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,4 +1,4 @@ A puppeting bridge between Matrix and Signal packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Signal user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Signal room, so only someone with a Signal account can participate to Signal group conversations. -The ["Mautrix-Signal"](https://docs.mau.fi/bridges/python/signal/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. +The ["Mautrix-Signal"](https://docs.mau.fi/bridges/go/signal/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.