Skip to content

Commit 8f7ade4

Browse files
committed
document all the fancy admin room config options and arguments
Signed-off-by: strawberry <strawberry@puppygock.gay>
1 parent 8849a10 commit 8f7ade4

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

conduwuit-example.toml

+39-5
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@
6868
# only effective in release-mode; forced to false in debug-mode.
6969
#sentry_send_error = true
7070

71+
# Controls the tracing log level for Sentry to send things like breadcrumbs and transactions
72+
# Defaults to "info"
73+
#sentry_filter = "info"
74+
7175

7276
### Database configuration
7377

@@ -220,11 +224,6 @@ registration_token = "change this token for something specific to your server"
220224
# defaults to false
221225
# block_non_admin_invites = false
222226

223-
# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
224-
# will be publicly visible to the room, originating from the sender.
225-
# defaults to true
226-
#admin_escape_commands = true
227-
228227
# List of forbidden username patterns/strings. Values in this list are matched as *contains*.
229228
# This is checked upon username availability check, registration, and startup as warnings if any local users in your database
230229
# have a forbidden username.
@@ -318,6 +317,41 @@ allow_profile_lookup_federation_requests = true
318317
#auto_deactivate_banned_room_attempts = false
319318

320319

320+
### Admin Room and Console
321+
322+
# Controls whether the conduwuit admin room console / CLI will immediately activate on startup.
323+
# This option can also be enabled with `--console` conduwuit argument
324+
#
325+
# Defaults to false
326+
#admin_console_automatic = false
327+
328+
# Controls what admin commands will be executed on startup. This is a vector list of strings of admin commands to run.
329+
#
330+
# An example of this can be: `admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
331+
#
332+
# This option can also be configured with the `--execute` conduwuit argument and can take standard shell commands and environment variables
333+
#
334+
# Such example could be: `./conduwuit --execute "server admin-notice conduwuit has started up at $(date)"`
335+
#
336+
# Defaults to nothing.
337+
#admin_execute = [""]
338+
339+
# Controls whether conduwuit should error and fail to start if an admin execute command (`--execute` / `admin_execute`) fails
340+
#
341+
# Defaults to false
342+
#admin_execute_errors_ignore = false
343+
344+
# Controls the max log level for admin command log captures (logs generated from running admin commands)
345+
#
346+
# Defaults to "info" on release builds, else "debug" on debug builds
347+
#admin_log_capture = info
348+
349+
# Allows admins to enter commands in rooms other than #admins by prefixing with \!admin. The reply
350+
# will be publicly visible to the room, originating from the sender.
351+
# defaults to true
352+
#admin_escape_commands = true
353+
354+
321355
### Misc
322356

323357
# max log level for conduwuit. allows debug, info, warn, or error

0 commit comments

Comments
 (0)