oss/conduit
oss/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2025-06-27 16:35:59 +00:00
Code Wiki Activity

Update docs/configuration.md default, link with src/config/mod.rs

Browse source
This commit is contained in:
Herman Rimm 2024-10-07 09:55:14 +02:00
parent 3c93c81204
commit d9d5fd9219
No known key found for this signature in database
GPG key ID: 0DF3F878D2F3C62D
2 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/configuration.md
View file

@ -17,7 +17,7 @@ Conduit's configuration file is divided into the following sections:
## Global ## 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 > **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` | | `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 | | `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_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_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` | | `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"` | | `default_room_version` | `string` | The default room version (`"6"`-`"10"`)| `"10"` |

1
src/config/mod.rs
View file

@ -13,6 +13,7 @@ mod proxy;
use self::proxy::ProxyConfig; use self::proxy::ProxyConfig;
// Make sure to update docs/configuration.md accordingly.
#[derive(Clone, Debug, Deserialize)] #[derive(Clone, Debug, Deserialize)]
pub struct Config { pub struct Config {
#[serde(default = "default_address")] #[serde(default = "default_address")]