Explorar el Código

Use common descriptions for adding the configuration

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3911/head
Suguru Hirahara hace 1 año
padre
commit
80c352d69e
No se encontró ninguna clave conocida en la base de datos para esta firma ID de clave GPG: E4F9743DAB4B7B75
Se han modificado 2 ficheros con 5 adiciones y 5 borrados
  1. +2
    -2
      docs/configuring-playbook-dimension.md
  2. +3
    -3
      docs/configuring-playbook-federation.md

+ 2
- 2
docs/configuring-playbook-dimension.md Ver fichero

@@ -38,7 +38,7 @@ Dimension requires an access token to be able to connect to your homeserver. Ref

## Adjusting the playbook configuration

To enable Dimension, add this to your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`). Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token).
To enable Dimension, 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](#obtain-an-access-token).

```yaml
matrix_dimension_enabled: true
@@ -48,7 +48,7 @@ matrix_dimension_access_token: "ACCESS_TOKEN_HERE"

### Define admin users

These users can modify the integrations this Dimension supports. Add this to your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`):
To define admin users who can modify the integrations this Dimension supports, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:

```yaml
matrix_dimension_admins:


+ 3
- 3
docs/configuring-playbook-federation.md Ver fichero

@@ -20,7 +20,7 @@ If you wish to disable federation, you can do that with an empty list (`[]`), or

By default, your server's public rooms directory is not exposed to other servers via federation.

If you wish to expose it, add this to your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`):
To expose it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:

```yaml
matrix_synapse_allow_public_rooms_over_federation: true
@@ -28,7 +28,7 @@ matrix_synapse_allow_public_rooms_over_federation: true

## Disabling federation

To completely disable federation, isolating your server from the rest of the Matrix network, add this to your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`):
To completely disable federation, isolating your server from the rest of the Matrix network, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:

```yaml
matrix_homeserver_federation_enabled: false
@@ -52,7 +52,7 @@ matrix_synapse_reverse_proxy_companion_federation_api_enabled: false

Why? This change could be useful for people running small Synapse instances on small severs/VPSes to avoid being impacted by a simple DOS/DDOS when bandwidth, RAM, an CPU resources are limited and if your hosting provider does not provide a DOS/DDOS protection.

The following changes in the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) will allow this and make it possible to proxy the federation through a CDN such as CloudFlare or any other:
To make it possible to proxy the federation through a CDN such as CloudFlare or any other, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:

```yaml
matrix_synapse_http_listener_resource_names: ["client","federation"]


Cargando…
Cancelar
Guardar