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

docs

Browse source
This commit is contained in:
avdb13 2024-07-03 08:11:35 +02:00
parent 7e54066023
commit 1761de5d03
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/configuration.md
View file

@ -44,6 +44,7 @@ The `global` section contains the following fields:
| `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"` |
| `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 | | `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` | | `allow_jaeger` | `boolean` | Allow Jaeger tracing | `false` |
| `tracing_flame` | `boolean` | Enable flame tracing | `false` | | `tracing_flame` | `boolean` | Enable flame tracing | `false` |
@ -110,3 +111,15 @@ exclude = ["*.clearnet.onion"]
[global] [global]
{{#include ../conduit-example.toml:22:}} {{#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"]
```