Przeglądaj źródła

Update draupnir and mjolnir docs: replace numbering

This is a follow-up to e5ab17cafd.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3872/head
Suguru Hirahara 1 rok temu
rodzic
commit
988dbf6268
Nie znaleziono w bazie danych klucza dla tego podpisu ID klucza GPG: E4F9743DAB4B7B75
3 zmienionych plików z 13 dodań i 23 usunięć
  1. +2
    -4
      docs/configuring-playbook-appservice-draupnir-for-all.md
  2. +6
    -10
      docs/configuring-playbook-bot-draupnir.md
  3. +5
    -9
      docs/configuring-playbook-bot-mjolnir.md

+ 2
- 4
docs/configuring-playbook-appservice-draupnir-for-all.md Wyświetl plik

@@ -40,14 +40,12 @@ This alias can be anything you want. However, for increased security during the

## Adjusting the playbook configuration

Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):

You must replace `ALIAS_FROM_STEP_2_GOES_HERE` with the alias you created in step 2.
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ALIAS_HERE`.

```yaml
matrix_appservice_draupnir_for_all_enabled: true

matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2_GOES_HERE"
matrix_appservice_draupnir_for_all_master_control_room_alias: "MANAGEMENT_ROOM_ALIAS_HERE"
```

### Extending the configuration


+ 6
- 10
docs/configuring-playbook-bot-draupnir.md Wyświetl plik

@@ -48,15 +48,13 @@ Finally invite the `@bot.draupnir:example.com` account you created earlier into

## Adjusting the playbook configuration

Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):

You must replace `ROOM_ID_FROM_STEP_4_GOES_HERE` with your own value.
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ID_HERE`.

```yaml
# Enable Draupnir
matrix_bot_draupnir_enabled: true

matrix_bot_draupnir_management_room: "ROOM_ID_FROM_STEP_4_GOES_HERE"
matrix_bot_draupnir_management_room: "MANAGEMENT_ROOM_ID_HERE"
```

### End-to-End Encryption support
@@ -79,7 +77,7 @@ matrix_pantalaimon_enabled: true
matrix_bot_draupnir_pantalaimon_use: true

# User name and password for the bot. Required when using Pantalaimon.
matrix_bot_draupnir_pantalaimon_username: "DRAUPNIR_USERNAME_FROM_STEP_1"
matrix_bot_draupnir_pantalaimon_username: "bot.draupnir"
matrix_bot_draupnir_pantalaimon_password: ### you should create a secure password for the bot account
```

@@ -99,12 +97,10 @@ matrix_bot_draupnir_raw_homeserver_url: "{{ matrix_addons_homeserver_client_api_

When NOT using Pantalaimon, Draupnir does not log in by itself and you must give it an access token for its bot account.

Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):

You must replace `ACCESS_TOKEN_FROM_STEP_2_GOES_HERE` with your own value.
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#get-an-access-token).

```yaml
matrix_bot_draupnir_access_token: "ACCESS_TOKEN_FROM_STEP_2_GOES_HERE"
matrix_bot_draupnir_access_token: "ACCESS_TOKEN_HERE"
```

### Extending the configuration
@@ -228,7 +224,7 @@ The first method intercepts the report API endpoint of the client-server API, wh
matrix_bot_draupnir_abuse_reporting_enabled: true
```

The other method polls an synapse admin API endpoint and is hence only available when using synapse and when the Draupnir user is an admin user (see step 1). To enable it, set `pollReports: true` in Draupnir's config:
The other method polls an synapse admin API endpoint and is hence only available when using synapse and when the Draupnir user is an admin user ([see above](#register-the-bot-account)). To enable it, set `pollReports: true` in Draupnir's config:

```yaml
matrix_bot_draupnir_configuration_extension_yaml: |


+ 5
- 9
docs/configuring-playbook-bot-mjolnir.md Wyświetl plik

@@ -44,15 +44,13 @@ Finally invite the `@bot.mjolnir:example.com` account you created earlier into t

## Adjusting the playbook configuration

Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):

You must replace `ROOM_ID_FROM_STEP_4_GOES_HERE` with your own value.
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ID_HERE`.

```yaml
# Enable Mjolnir
matrix_bot_mjolnir_enabled: true

matrix_bot_mjolnir_management_room: "ROOM_ID_FROM_STEP_4_GOES_HERE"
matrix_bot_mjolnir_management_room: "MANAGEMENT_ROOM_ID_HERE"
```

### End-to-End Encryption support
@@ -75,7 +73,7 @@ matrix_pantalaimon_enabled: true
matrix_bot_mjolnir_pantalaimon_use: true

# User name and password for the bot. Required when using Pantalaimon.
matrix_bot_mjolnir_pantalaimon_username: "MJOLNIR_USERNAME_FROM_STEP_1"
matrix_bot_mjolnir_pantalaimon_username: "bot.mjolnir"
matrix_bot_mjolnir_pantalaimon_password: ### you should create a secure password for the bot account
```

@@ -95,12 +93,10 @@ matrix_bot_mjolnir_raw_homeserver_url: "{{ matrix_addons_homeserver_client_api_u

When NOT using Pantalaimon, Mjolnir does not log in by itself and you must give it an access token for its bot account.

Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):

You must replace `ACCESS_TOKEN_FROM_STEP_2_GOES_HERE` with your own value.
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#get-an-access-token).

```yaml
matrix_bot_mjolnir_access_token: "ACCESS_TOKEN_FROM_STEP_2_GOES_HERE"
matrix_bot_mjolnir_access_token: "ACCESS_TOKEN_HERE"
```

### Adding Mjolnir synapse antispam module (optional)


Ładowanie…
Anuluj
Zapisz