Просмотр исходного кода

Update docs for mautrix bridges: adopt the common description for the section "Usage"

Fix docs/configuring-playbook-bridge-mautrix-bridges.md: simplify the instruction to refer each documentation page (note that there are two formats of the links: https://docs.mau.fi/bridges/python/SERVICENAME/authentication.html and https://docs.mau.fi/bridges/go/SERVICENAME/authentication.html)

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3914/head
Suguru Hirahara 1 год назад
Родитель
Сommit
29826244a1
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: E4F9743DAB4B7B75
10 измененных файлов: 12 добавлений и 11 удалений
  1. +1
    -1
      docs/configuring-playbook-bridge-appservice-kakaotalk.md
  2. +1
    -1
      docs/configuring-playbook-bridge-appservice-webhooks.md
  3. +1
    -1
      docs/configuring-playbook-bridge-beeper-linkedin.md
  4. +1
    -1
      docs/configuring-playbook-bridge-mautrix-bridges.md
  5. +1
    -1
      docs/configuring-playbook-bridge-mautrix-facebook.md
  6. +1
    -1
      docs/configuring-playbook-bridge-mautrix-googlechat.md
  7. +1
    -1
      docs/configuring-playbook-bridge-mautrix-hangouts.md
  8. +1
    -1
      docs/configuring-playbook-bridge-mautrix-instagram.md
  9. +1
    -1
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  10. +3
    -2
      docs/configuring-playbook-bridge-mautrix-twitter.md

+ 1
- 1
docs/configuring-playbook-bridge-appservice-kakaotalk.md Просмотреть файл

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

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

Send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password.
You then need to send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password.

+ 1
- 1
docs/configuring-playbook-bridge-appservice-webhooks.md Просмотреть файл

@@ -48,7 +48,7 @@ To use the bridge, you need to invite the bridge bot user to your room in either
- Send `/invite @_webhook:example.com` (**Note**: Make sure you have administration permissions in your room)
- Add the bridge bot to a private channel (personal channels imply you being an administrator)

You then need to send a message to the bridge bot in order to receive a private message including the webhook link:
You then need to send a message to the bridge bot to receive a private message including the webhook link:

```
!webhook


+ 1
- 1
docs/configuring-playbook-bridge-beeper-linkedin.md Просмотреть файл

@@ -39,7 +39,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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

Send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to enable bridging for your LinkedIn account.
You then need to send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to enable bridging for your LinkedIn account.

## Troubleshooting



+ 1
- 1
docs/configuring-playbook-bridge-mautrix-bridges.md Просмотреть файл

@@ -157,7 +157,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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

Send `login` to the bridge bot to get started. You can learn more here about authentication from the bridge's official documentation on Authentication: https://docs.mau.fi/bridges/python/SERVICENAME/authentication.html
For details about the next steps, refer to each bridge's individual documentation page.

If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.



+ 1
- 1
docs/configuring-playbook-bridge-mautrix-facebook.md Просмотреть файл

@@ -53,7 +53,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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

Send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging for your Facebook Messenger account.
You then need to send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging for your Facebook Messenger account.

If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.



+ 1
- 1
docs/configuring-playbook-bridge-mautrix-googlechat.md Просмотреть файл

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

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

Send `login` to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions.
You then need to send `login` to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions.

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.



+ 1
- 1
docs/configuring-playbook-bridge-mautrix-hangouts.md Просмотреть файл

@@ -53,7 +53,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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

Send `login` to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions.
You then need to send `login` to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions.

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.



+ 1
- 1
docs/configuring-playbook-bridge-mautrix-instagram.md Просмотреть файл

@@ -43,4 +43,4 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

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).

Send `login YOUR_INSTAGRAM_EMAIL_ADDRESS YOUR_INSTAGRAM_PASSWORD` to the bridge bot to enable bridging for your instagram/Messenger account.
You then need to send `login YOUR_INSTAGRAM_EMAIL_ADDRESS YOUR_INSTAGRAM_PASSWORD` to the bridge bot to enable bridging for your instagram/Messenger account.

+ 1
- 1
docs/configuring-playbook-bridge-mautrix-meta-messenger.md Просмотреть файл

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

To use the bridge, you need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`.

You then need to send a `login` command and follow the bridge bot's instructions.
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).

+ 3
- 2
docs/configuring-playbook-bridge-mautrix-twitter.md Просмотреть файл

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

## Usage

1. You then need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
2. Send login-cookie to start the login. The bot should respond with instructions on how to proceed.
To use the bridge, you need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).

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).

Загрузка…
Отмена
Сохранить