From 1761de5d03e1c0ada24bb8f2f4b99f70baa47d0c Mon Sep 17 00:00:00 2001 From: avdb13 Date: Wed, 3 Jul 2024 08:11:35 +0200 Subject: [PATCH] docs --- docs/configuration.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index edc924f1..b32b7abd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -44,6 +44,7 @@ The `global` section contains the following fields: | `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"` | +| `default_rooms` | `array` | The list of rooms that will be joined by default on registration | N/A | | `join_by_default` | `array` | Room aliases and IDs that will be joined by default at registration | N/A | | `allow_jaeger` | `boolean` | Allow Jaeger tracing | `false` | | `tracing_flame` | `boolean` | Enable flame tracing | `false` | @@ -110,3 +111,15 @@ exclude = ["*.clearnet.onion"] [global] {{#include ../conduit-example.toml:22:}} ``` + + +### Default rooms +There is a shorthand syntax specialized for convenience for these values. The server name is optional for local room IDs. +The same rule applies to local aliases in addition to not requiring the pound sign prefix. + +#### Example +In this example, the two configuration options are equivalent: +```toml +default_rooms = ["#home", "lounge", "!abc123", "#conduit:fachschaften.org"] +default_rooms = ["#home:conduit.rs", "#lounge:conduit.rs", "!abc123:conduit.rs", "#conduit:fachschaften.org"] +```