Explorar el Código

Update docs for mautrix bridges: edit anchor links to official documentation pages

- Add links to the official documentation pages
- Remove links to Hangouts' documentation page: the links have been replaced with ones to Google Chat bridge and the resources about Hangouts bridge have been removed
- Replace links to documentation pages in python version with ones in go version

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3914/head
Suguru Hirahara hace 1 año
padre
commit
af0dfd99cd
No se encontró ninguna clave conocida en la base de datos para esta firma ID de clave GPG: E4F9743DAB4B7B75
Se han modificado 12 ficheros con 24 adiciones y 8 borrados
  1. +2
    -0
      docs/configuring-playbook-bridge-mautrix-discord.md
  2. +1
    -1
      docs/configuring-playbook-bridge-mautrix-facebook.md
  3. +2
    -0
      docs/configuring-playbook-bridge-mautrix-gmessages.md
  4. +0
    -4
      docs/configuring-playbook-bridge-mautrix-hangouts.md
  5. +1
    -1
      docs/configuring-playbook-bridge-mautrix-instagram.md
  6. +4
    -0
      docs/configuring-playbook-bridge-mautrix-meta-instagram.md
  7. +4
    -0
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  8. +3
    -1
      docs/configuring-playbook-bridge-mautrix-signal.md
  9. +2
    -0
      docs/configuring-playbook-bridge-mautrix-slack.md
  10. +2
    -0
      docs/configuring-playbook-bridge-mautrix-telegram.md
  11. +1
    -1
      docs/configuring-playbook-bridge-mautrix-twitter.md
  12. +2
    -0
      docs/configuring-playbook-bridge-mautrix-whatsapp.md

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-discord.md Ver fichero

@@ -60,6 +60,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

### Logging in

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/discord/authentication.html).

#### Method 1: Login using QR code (recommended)

For using this bridge, you would need to authenticate by **scanning a QR code** with the Discord app on your phone.


+ 1
- 1
docs/configuring-playbook-bridge-mautrix-facebook.md Ver fichero

@@ -6,7 +6,7 @@

The playbook can install and configure [mautrix-facebook](https://github.com/mautrix/facebook) for you.

See the project's [documentation](https://github.com/mautrix/facebook/blob/master/ROADMAP.md) to learn what it does and why it might be useful to you.
See the project's [documentation](https://github.com/mautrix/facebook/blob/master/README.md) to learn what it does and why it might be useful to you.

## Prerequisite (optional)



+ 2
- 0
docs/configuring-playbook-bridge-mautrix-gmessages.md Ver fichero

@@ -49,3 +49,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html).

+ 0
- 4
docs/configuring-playbook-bridge-mautrix-hangouts.md Ver fichero

@@ -6,8 +6,6 @@

The playbook can install and configure [mautrix-hangouts](https://github.com/mautrix/hangouts) for you.

See the project's [documentation](https://docs.mau.fi/bridges/python/hangouts/index.html) to learn what it does and why it might be useful to you.

## Prerequisite (optional)

### Enable Shared Secret Auth
@@ -58,5 +56,3 @@ You then need to send `login` to the bridge bot to receive a link to the portal
Automatic login may not work. If it does not, reload the page and select the "Manual login" checkbox before starting. Manual login involves logging into your Google account normally and then manually getting the OAuth token from browser cookies with developer tools.

Once logged in, recent chats should show up as new conversations automatically. Other chats will get portals as you receive messages.

You can learn more about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/hangouts/authentication.html).

+ 1
- 1
docs/configuring-playbook-bridge-mautrix-instagram.md Ver fichero

@@ -6,7 +6,7 @@

The playbook can install and configure [mautrix-instagram](https://github.com/mautrix/instagram) for you.

See the project's [documentation](https://docs.mau.fi/bridges/python/instagram/index.html) to learn what it does and why it might be useful to you.
See the project's [documentation](https://github.com/mautrix/instagram/blob/master/README.md) to learn what it does and why it might be useful to you.

## Adjusting the playbook configuration



+ 4
- 0
docs/configuring-playbook-bridge-mautrix-meta-instagram.md Ver fichero

@@ -4,6 +4,8 @@

The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you.

See the project's [documentation](https://docs.mau.fi/bridges/go/meta/index.html) to learn what it does and why it might be useful to you.

Since this bridge component can bridge to both [Messenger](https://messenger.com/) and [Instagram](https://instagram.com/) and you may wish to do both at the same time, the playbook makes it available via 2 different Ansible roles (`matrix-bridge-mautrix-meta-messenger` and `matrix-bridge-mautrix-meta-instagram`). The latter is a reconfigured copy of the first one (created by `just rebuild-mautrix-meta-instagram` and `bin/rebuild-mautrix-meta-instagram.sh`).

This documentation page only deals with the bridge's ability to bridge to Instagram. For bridging to Facebook/Messenger, see [Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md).
@@ -63,3 +65,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

To use the bridge, you need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html).

+ 4
- 0
docs/configuring-playbook-bridge-mautrix-meta-messenger.md Ver fichero

@@ -4,6 +4,8 @@

The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you.

See the project's [documentation](https://docs.mau.fi/bridges/go/meta/index.html) to learn what it does and why it might be useful to you.

Since this bridge component can bridge to both [Messenger](https://messenger.com/) and [Instagram](https://instagram.com/) and you may wish to do both at the same time, the playbook makes it available via 2 different Ansible roles (`matrix-bridge-mautrix-meta-messenger` and `matrix-bridge-mautrix-meta-instagram`). The latter is a reconfigured copy of the first one (created by `just rebuild-mautrix-meta-instagram` and `bin/rebuild-mautrix-meta-instagram.sh`).

This documentation page only deals with the bridge's ability to bridge to Facebook Messenger. For bridging to Instagram, see [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md).
@@ -80,3 +82,5 @@ To use the bridge, you need to start a chat with `@messengerbot:example.com` (wh
You then need to send `login` to the bridge bot and follow the instructions.

Given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there as per [the bridge's authentication instructions](https://docs.mau.fi/bridges/go/meta/authentication.html).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html).

+ 3
- 1
docs/configuring-playbook-bridge-mautrix-signal.md Ver fichero

@@ -4,7 +4,7 @@

The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you.

See the project's [documentation](https://docs.mau.fi/bridges/python/signal/index.html) to learn what it does and why it might be useful to you.
See the project's [documentation](https://docs.mau.fi/bridges/go/signal/index.html) to learn what it does and why it might be useful to you.

## Prerequisites (optional)

@@ -54,3 +54,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

To use the bridge, you need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/signal/authentication.html).

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-slack.md Ver fichero

@@ -63,3 +63,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
3. The bot should respond with "Successfully logged into <email> for team <workspace>"
4. Now that you're logged in, you can send `help` to the bot to see the available commands.
5. Slack channels should automatically begin bridging if you authenticated using a token. Otherwise, you must wait to receive a message in the channel if you used password authentication.

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html).

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-telegram.md Ver fichero

@@ -92,3 +92,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

To use the bridge, you need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/telegram/authentication.html).

+ 1
- 1
docs/configuring-playbook-bridge-mautrix-twitter.md Ver fichero

@@ -54,4 +54,4 @@ To use the bridge, you need to start a chat with `@twitterbot:example.com` (wher

You then need to send login-cookie to start the login. The bot should respond with instructions on how to proceed.

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/twitter/authentication.html).
You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/twitter/authentication.html).

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-whatsapp.md Ver fichero

@@ -52,3 +52,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage

To use the bridge, you need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html).

Cargando…
Cancelar
Guardar