Przeglądaj źródła

Add a common warning message about not to share an access token

Based on docs/obtaining-access-tokens.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3901/head
Suguru Hirahara 1 rok temu
rodzic
commit
7911cdb232
Nie znaleziono w bazie danych klucza dla tego podpisu ID klucza GPG: E4F9743DAB4B7B75
11 zmienionych plików z 19 dodań i 3 usunięć
  1. +2
    -0
      docs/configuring-playbook-alertmanager-receiver.md
  2. +2
    -0
      docs/configuring-playbook-bot-chatgpt.md
  3. +2
    -0
      docs/configuring-playbook-bot-draupnir.md
  4. +2
    -0
      docs/configuring-playbook-bot-go-neb.md
  5. +2
    -0
      docs/configuring-playbook-bot-maubot.md
  6. +2
    -0
      docs/configuring-playbook-bot-mjolnir.md
  7. +1
    -1
      docs/configuring-playbook-dimension.md
  8. +2
    -0
      docs/configuring-playbook-email2matrix.md
  9. +1
    -1
      docs/configuring-playbook-user-verification-service.md
  10. +2
    -0
      docs/maintenance-synapse.md
  11. +1
    -1
      docs/obtaining-access-tokens.md

+ 2
- 0
docs/configuring-playbook-alertmanager-receiver.md Wyświetl plik

@@ -26,6 +26,8 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.alertma

The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

### Join to rooms as the bot manually

ℹ️ **This bot does not accept room invitations automatically**. To deliver messages to rooms, the bot must be joined to all rooms manually.


+ 2
- 0
docs/configuring-playbook-bot-chatgpt.md Wyświetl plik

@@ -28,6 +28,8 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.chatgpt

The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [Element documentation](https://element.io/help#encryption6).

## Adjusting the playbook configuration


+ 2
- 0
docs/configuring-playbook-bot-draupnir.md Wyświetl plik

@@ -28,6 +28,8 @@ If you would like Draupnir to be able to deactivate users, move aliases, shutdow

The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

### Make sure the account is free from rate limiting

If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a required step. If you do not configure it, Draupnir will crash.**


+ 2
- 0
docs/configuring-playbook-bot-go-neb.md Wyświetl plik

@@ -26,6 +26,8 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.go-neb

The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

## Adjusting the playbook configuration

To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_GONEB_HERE` and `ACCESS_TOKEN_FOR_ANOTHER_GONEB_HERE` with the ones created [above](#obtain-an-access-token).


+ 2
- 0
docs/configuring-playbook-bot-maubot.md Wyświetl plik

@@ -80,3 +80,5 @@ You should start in the following order
This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`.

Alternatively, you can refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). Be aware that you'd better use the **Obtain an access token via curl** method (not **Obtain an access token via Element Web**) as the latter will causes issues to your bot in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

+ 2
- 0
docs/configuring-playbook-bot-mjolnir.md Wyświetl plik

@@ -24,6 +24,8 @@ If you would like Mjolnir to be able to deactivate users, move aliases, shutdown

The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

### Make sure the account is free from rate limiting

If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a required step. If you do not configure it, Mjolnir will crash.**


+ 1
- 1
docs/configuring-playbook-dimension.md Wyświetl plik

@@ -32,7 +32,7 @@ We recommend that you create a dedicated Matrix user for Dimension (`dimension`

You are required to specify an access token (belonging to this new user) for Dimension to work. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

**Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.**
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

Add access token to your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`):



+ 2
- 0
docs/configuring-playbook-email2matrix.md Wyświetl plik

@@ -42,6 +42,8 @@ Take note of each room's room ID (different clients show the room ID in a differ

In order for the sender user created above to be able to send messages to the room, we'll need to obtain an access token for it. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

## Adjusting the playbook configuration

After doing the preparation steps above, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):


+ 1
- 1
docs/configuring-playbook-user-verification-service.md Wyświetl plik

@@ -47,7 +47,7 @@ We recommend that you create a dedicated Matrix user for uvs (`uvs` is a good us

You are required to specify an access token (belonging to this new user) for UVS to work. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

**Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.**
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

```yaml
matrix_user_verification_service_uvs_access_token: "YOUR ACCESS TOKEN HERE"


+ 2
- 0
docs/maintenance-synapse.md Wyświetl plik

@@ -18,6 +18,8 @@ You can use the **[Purge History API](https://github.com/element-hq/synapse/blob

To make use of this Synapse Admin API, **you'll need an admin access token** first. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).

⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

Synapse's Admin API is not exposed to the internet by default, following [official Synapse reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints). To expose it you will need to add `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` to your `vars.yml` file.

Follow the [Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md) documentation page for the actual purging instructions.


+ 1
- 1
docs/obtaining-access-tokens.md Wyświetl plik

@@ -2,7 +2,7 @@

When setting up some optional features like bots and bridges you will need to provide an access token for some user. This document provides documentation on how to obtain such an access token.

**Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.**
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.

## Prerequisites



Ładowanie…
Anuluj
Zapisz