From d9d5fd9219862e8bcd7977f2d61812389427a76e Mon Sep 17 00:00:00 2001 From: Herman Rimm Date: Mon, 7 Oct 2024 09:55:14 +0200 Subject: [PATCH] Update docs/configuration.md default, link with src/config/mod.rs --- docs/configuration.md | 4 ++-- src/config/mod.rs | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index b2b4f3a4..db1f659a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -17,7 +17,7 @@ Conduit's configuration file is divided into the following sections: ## Global -The `global` section contains the following fields: +As per [config/mod.rs](https://gitlab.com/famedly/conduit/-/blob/next/src/config/mod.rs), the `global` section contains the following fields: > **Note:** The `*` symbol indicates that the field is required, and the values in **parentheses** are the possible values @@ -42,7 +42,7 @@ The `global` section contains the following fields: | `allow_registration` | `boolean` | Opens your homeserver to public registration | `false` | | `registration_token` | `string` | The token users need to have when registering to your homeserver | N/A | | `allow_encryption` | `boolean` | Allow users to enable encryption in their rooms | `true` | -| `allow_federation` | `boolean` | Allow federation with other servers | `true` | +| `allow_federation` | `boolean` | Allow federation with other servers | `false` | | `allow_room_creation` | `boolean` | Allow users to create rooms | `true` | | `allow_unstable_room_versions` | `boolean` | Allow users to create and join rooms with unstable versions | `true` | | `default_room_version` | `string` | The default room version (`"6"`-`"10"`)| `"10"` | diff --git a/src/config/mod.rs b/src/config/mod.rs index 7cac2ed8..7c4f583c 100644 --- a/src/config/mod.rs +++ b/src/config/mod.rs @@ -13,6 +13,7 @@ mod proxy; use self::proxy::ProxyConfig; +// Make sure to update docs/configuration.md accordingly. #[derive(Clone, Debug, Deserialize)] pub struct Config { #[serde(default = "default_address")]