git-mirrors/continuwuity
1
0
Fork 0
mirror of https://forgejo.ellis.link/continuwuation/continuwuity.git synced 2025-06-27 12:14:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: Allow controlling client message filtering

Browse source
This commit is contained in:
Jade Ellis 2025-04-24 00:40:36 +01:00 • committed by Jacob Taylor
parent 475d66e1ea
commit 0936ad1fb8
3 changed files with 200 additions and 217 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

195
conduwuit-example.toml
View file

@ -1,4 +1,4 @@
### continuwuity Configuration ### conduwuit Configuration
### ###
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE ### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
### OVERWRITTEN! ### OVERWRITTEN!
@ -13,7 +13,7 @@
### that say "YOU NEED TO EDIT THIS". ### that say "YOU NEED TO EDIT THIS".
### ###
### For more information, see: ### For more information, see:
### https://continuwuity.org/configuration.html ### https://conduwuit.puppyirl.gay/configuration.html
[global] [global]
@ -21,7 +21,7 @@
# suffix for user and room IDs/aliases. # suffix for user and room IDs/aliases.
# #
# See the docs for reverse proxying and delegation: # See the docs for reverse proxying and delegation:
# https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy # https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
# #
# Also see the `[global.well_known]` config section at the very bottom. # Also see the `[global.well_known]` config section at the very bottom.
# #
@ -32,11 +32,11 @@
# YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE # YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
# WIPE. # WIPE.
# #
# example: "continuwuity.org" # example: "conduwuit.woof"
# #
#server_name = #server_name =
# The default address (IPv4 or IPv6) continuwuity will listen on. # The default address (IPv4 or IPv6) conduwuit will listen on.
# #
# If you are using Docker or a container NAT networking setup, this must # If you are using Docker or a container NAT networking setup, this must
# be "0.0.0.0". # be "0.0.0.0".
@ -46,10 +46,10 @@
# #
#address = ["127.0.0.1", "::1"] #address = ["127.0.0.1", "::1"]
# The port(s) continuwuity will listen on. # The port(s) conduwuit will listen on.
# #
# For reverse proxying, see: # For reverse proxying, see:
# https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy # https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
# #
# If you are using Docker, don't change this, you'll need to map an # If you are using Docker, don't change this, you'll need to map an
# external port to this. # external port to this.
@ -58,17 +58,16 @@
# #
#port = 8008 #port = 8008
# The UNIX socket continuwuity will listen on. # The UNIX socket conduwuit will listen on.
# #
# continuwuity cannot listen on both an IP address and a UNIX socket. If # conduwuit cannot listen on both an IP address and a UNIX socket. If
# listening on a UNIX socket, you MUST remove/comment the `address` key. # listening on a UNIX socket, you MUST remove/comment the `address` key.
# #
# Remember to make sure that your reverse proxy has access to this socket # Remember to make sure that your reverse proxy has access to this socket
# file, either by adding your reverse proxy to the appropriate user group # file, either by adding your reverse proxy to the 'conduwuit' group or
# or granting world R/W permissions with `unix_socket_perms` (666 # granting world R/W permissions with `unix_socket_perms` (666 minimum).
# minimum).
# #
# example: "/run/continuwuity/continuwuity.sock" # example: "/run/conduwuit/conduwuit.sock"
# #
#unix_socket_path = #unix_socket_path =
@ -76,23 +75,23 @@
# #
#unix_socket_perms = 660 #unix_socket_perms = 660
# This is the only directory where continuwuity will save its data, # This is the only directory where conduwuit will save its data, including
# including media. Note: this was previously "/var/lib/matrix-conduit". # media. Note: this was previously "/var/lib/matrix-conduit".
# #
# YOU NEED TO EDIT THIS. # YOU NEED TO EDIT THIS.
# #
# example: "/var/lib/continuwuity" # example: "/var/lib/conduwuit"
# #
#database_path = #database_path =
# continuwuity supports online database backups using RocksDB's Backup # conduwuit supports online database backups using RocksDB's Backup engine
# engine API. To use this, set a database backup path that continuwuity # API. To use this, set a database backup path that conduwuit can write
# can write to. # to.
# #
# For more information, see: # For more information, see:
# https://continuwuity.org/maintenance.html#backups # https://conduwuit.puppyirl.gay/maintenance.html#backups
# #
# example: "/opt/continuwuity-db-backups" # example: "/opt/conduwuit-db-backups"
# #
#database_backup_path = #database_backup_path =
@ -113,14 +112,14 @@
# #
#new_user_displayname_suffix = "🏳️‍⚧️" #new_user_displayname_suffix = "🏳️‍⚧️"
# If enabled, continuwuity will send a simple GET request periodically to # If enabled, conduwuit will send a simple GET request periodically to
# `https://continuwuity.org/.well-known/continuwuity/announcements` for any new # `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
# announcements or major updates. This is not an update check endpoint. # announcements or major updates. This is not an update check endpoint.
# #
#allow_announcements_check = true #allow_announcements_check = true
# Set this to any float value to multiply continuwuity's in-memory LRU # Set this to any float value to multiply conduwuit's in-memory LRU caches
# caches with such as "auth_chain_cache_capacity". # with such as "auth_chain_cache_capacity".
# #
# May be useful if you have significant memory to spare to increase # May be useful if you have significant memory to spare to increase
# performance. # performance.
@ -132,7 +131,7 @@
# #
#cache_capacity_modifier = 1.0 #cache_capacity_modifier = 1.0
# Set this to any float value in megabytes for continuwuity to tell the # Set this to any float value in megabytes for conduwuit to tell the
# database engine that this much memory is available for database read # database engine that this much memory is available for database read
# caches. # caches.
# #
@ -146,7 +145,7 @@
# #
#db_cache_capacity_mb = varies by system #db_cache_capacity_mb = varies by system
# Set this to any float value in megabytes for continuwuity to tell the # Set this to any float value in megabytes for conduwuit to tell the
# database engine that this much memory is available for database write # database engine that this much memory is available for database write
# caches. # caches.
# #
@ -251,9 +250,9 @@
# Enable using *only* TCP for querying your specified nameservers instead # Enable using *only* TCP for querying your specified nameservers instead
# of UDP. # of UDP.
# #
# If you are running continuwuity in a container environment, this config # If you are running conduwuit in a container environment, this config
# option may need to be enabled. For more details, see: # option may need to be enabled. For more details, see:
# https://continuwuity.org/troubleshooting.html#potential-dns-issues-when-using-docker # https://conduwuit.puppyirl.gay/troubleshooting.html#potential-dns-issues-when-using-docker
# #
#query_over_tcp_only = false #query_over_tcp_only = false
@ -419,9 +418,9 @@
# tokens. Multiple tokens can be added if you separate them with # tokens. Multiple tokens can be added if you separate them with
# whitespace # whitespace
# #
# continuwuity must be able to access the file, and it must not be empty # conduwuit must be able to access the file, and it must not be empty
# #
# example: "/etc/continuwuity/.reg_token" # example: "/etc/conduwuit/.reg_token"
# #
#registration_token_file = #registration_token_file =
@ -513,16 +512,16 @@
#allow_room_creation = true #allow_room_creation = true
# Set to false to disable users from joining or creating room versions # Set to false to disable users from joining or creating room versions
# that aren't officially supported by continuwuity. # that aren't officially supported by conduwuit.
# #
# continuwuity officially supports room versions 6 - 11. # conduwuit officially supports room versions 6 - 11.
# #
# continuwuity has slightly experimental (though works fine in practice) # conduwuit has slightly experimental (though works fine in practice)
# support for versions 3 - 5. # support for versions 3 - 5.
# #
#allow_unstable_room_versions = true #allow_unstable_room_versions = true
# Default room version continuwuity will create rooms with. # Default room version conduwuit will create rooms with.
# #
# Per spec, room version 11 is the default. # Per spec, room version 11 is the default.
# #
@ -588,7 +587,7 @@
# Servers listed here will be used to gather public keys of other servers # Servers listed here will be used to gather public keys of other servers
# (notary trusted key servers). # (notary trusted key servers).
# #
# Currently, continuwuity doesn't support inbound batched key requests, so # Currently, conduwuit doesn't support inbound batched key requests, so
# this list should only contain other Synapse servers. # this list should only contain other Synapse servers.
# #
# example: ["matrix.org", "tchncs.de"] # example: ["matrix.org", "tchncs.de"]
@ -629,7 +628,7 @@
# #
#trusted_server_batch_size = 1024 #trusted_server_batch_size = 1024
# Max log level for continuwuity. Allows debug, info, warn, or error. # Max log level for conduwuit. Allows debug, info, warn, or error.
# #
# See also: # See also:
# https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives # https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
@ -650,9 +649,8 @@
# #
#log_span_events = "none" #log_span_events = "none"
# Configures whether CONTINUWUITY_LOG EnvFilter matches values using # Configures whether CONDUWUIT_LOG EnvFilter matches values using regular
# regular expressions. See the tracing_subscriber documentation on # expressions. See the tracing_subscriber documentation on Directives.
# Directives.
# #
#log_filter_regex = true #log_filter_regex = true
@ -720,7 +718,7 @@
# This takes priority over "turn_secret" first, and falls back to # This takes priority over "turn_secret" first, and falls back to
# "turn_secret" if invalid or failed to open. # "turn_secret" if invalid or failed to open.
# #
# example: "/etc/continuwuity/.turn_secret" # example: "/etc/conduwuit/.turn_secret"
# #
#turn_secret_file = #turn_secret_file =
@ -728,12 +726,12 @@
# #
#turn_ttl = 86400 #turn_ttl = 86400
# List/vector of room IDs or room aliases that continuwuity will make # List/vector of room IDs or room aliases that conduwuit will make newly
# newly registered users join. The rooms specified must be rooms that you # registered users join. The rooms specified must be rooms that you have
# have joined at least once on the server, and must be public. # joined at least once on the server, and must be public.
# #
# example: ["#continuwuity:continuwuity.org", # example: ["#conduwuit:puppygock.gay",
# "!main-1:continuwuity.org"] # "!eoIzvAvVwY23LPDay8:puppygock.gay"]
# #
#auto_join_rooms = [] #auto_join_rooms = []
@ -756,10 +754,10 @@
# #
#auto_deactivate_banned_room_attempts = false #auto_deactivate_banned_room_attempts = false
# RocksDB log level. This is not the same as continuwuity's log level. # RocksDB log level. This is not the same as conduwuit's log level. This
# This is the log level for the RocksDB engine/library which show up in # is the log level for the RocksDB engine/library which show up in your
# your database folder/path as `LOG` files. continuwuity will log RocksDB # database folder/path as `LOG` files. conduwuit will log RocksDB errors
# errors as normal through tracing or panics if severe for safety. # as normal through tracing or panics if severe for safety.
# #
#rocksdb_log_level = "error" #rocksdb_log_level = "error"
@ -779,7 +777,7 @@
# Set this to true to use RocksDB config options that are tailored to HDDs # Set this to true to use RocksDB config options that are tailored to HDDs
# (slower device storage). # (slower device storage).
# #
# It is worth noting that by default, continuwuity will use RocksDB with # It is worth noting that by default, conduwuit will use RocksDB with
# Direct IO enabled. *Generally* speaking this improves performance as it # Direct IO enabled. *Generally* speaking this improves performance as it
# bypasses buffered I/O (system page cache). However there is a potential # bypasses buffered I/O (system page cache). However there is a potential
# chance that Direct IO may cause issues with database operations if your # chance that Direct IO may cause issues with database operations if your
@ -787,7 +785,7 @@
# possibly ZFS filesystem. RocksDB generally deals/corrects these issues # possibly ZFS filesystem. RocksDB generally deals/corrects these issues
# but it cannot account for all setups. If you experience any weird # but it cannot account for all setups. If you experience any weird
# RocksDB issues, try enabling this option as it turns off Direct IO and # RocksDB issues, try enabling this option as it turns off Direct IO and
# feel free to report in the continuwuity Matrix room if this option fixes # feel free to report in the conduwuit Matrix room if this option fixes
# your DB issues. # your DB issues.
# #
# For more information, see: # For more information, see:
@ -842,7 +840,7 @@
# as they all differ. See their `kDefaultCompressionLevel`. # as they all differ. See their `kDefaultCompressionLevel`.
# #
# Note when using the default value we may override it with a setting # Note when using the default value we may override it with a setting
# tailored specifically for continuwuity. # tailored specifically conduwuit.
# #
#rocksdb_compression_level = 32767 #rocksdb_compression_level = 32767
@ -858,7 +856,7 @@
# algorithm. # algorithm.
# #
# Note when using the default value we may override it with a setting # Note when using the default value we may override it with a setting
# tailored specifically for continuwuity. # tailored specifically conduwuit.
# #
#rocksdb_bottommost_compression_level = 32767 #rocksdb_bottommost_compression_level = 32767
@ -898,13 +896,13 @@
# 0 = AbsoluteConsistency # 0 = AbsoluteConsistency
# 1 = TolerateCorruptedTailRecords (default) # 1 = TolerateCorruptedTailRecords (default)
# 2 = PointInTime (use me if trying to recover) # 2 = PointInTime (use me if trying to recover)
# 3 = SkipAnyCorruptedRecord (you now voided your Continuwuity warranty) # 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
# #
# For more information on these modes, see: # For more information on these modes, see:
# https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes # https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
# #
# For more details on recovering a corrupt database, see: # For more details on recovering a corrupt database, see:
# https://continuwuity.org/troubleshooting.html#database-corruption # https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption
# #
#rocksdb_recovery_mode = 1 #rocksdb_recovery_mode = 1
@ -944,7 +942,7 @@
# - Disabling repair mode and restarting the server is recommended after # - Disabling repair mode and restarting the server is recommended after
# running the repair. # running the repair.
# #
# See https://continuwuity.org/troubleshooting.html#database-corruption for more details on recovering a corrupt database. # See https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
# #
#rocksdb_repair = false #rocksdb_repair = false
@ -971,7 +969,7 @@
# Enables RocksDB compaction. You should never ever have to set this # Enables RocksDB compaction. You should never ever have to set this
# option to false. If you for some reason find yourself needing to use # option to false. If you for some reason find yourself needing to use
# this option as part of troubleshooting or a bug, please reach out to us # this option as part of troubleshooting or a bug, please reach out to us
# in the continuwuity Matrix room with information and details. # in the conduwuit Matrix room with information and details.
# #
# Disabling compaction will lead to a significantly bloated and # Disabling compaction will lead to a significantly bloated and
# explosively large database, gradually poor performance, unnecessarily # explosively large database, gradually poor performance, unnecessarily
@ -997,7 +995,7 @@
# purposes such as recovering/recreating your admin room, or inviting # purposes such as recovering/recreating your admin room, or inviting
# yourself back. # yourself back.
# #
# See https://continuwuity.org/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room. # See https://conduwuit.puppyirl.gay/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
# #
# Once this password is unset, all sessions will be logged out for # Once this password is unset, all sessions will be logged out for
# security purposes. # security purposes.
@ -1012,8 +1010,8 @@
# Allow local (your server only) presence updates/requests. # Allow local (your server only) presence updates/requests.
# #
# Note that presence on continuwuity is very fast unlike Synapse's. If # Note that presence on conduwuit is very fast unlike Synapse's. If using
# using outgoing presence, this MUST be enabled. # outgoing presence, this MUST be enabled.
# #
#allow_local_presence = true #allow_local_presence = true
@ -1021,7 +1019,7 @@
# #
# This option receives presence updates from other servers, but does not # This option receives presence updates from other servers, but does not
# send any unless `allow_outgoing_presence` is true. Note that presence on # send any unless `allow_outgoing_presence` is true. Note that presence on
# continuwuity is very fast unlike Synapse's. # conduwuit is very fast unlike Synapse's.
# #
#allow_incoming_presence = true #allow_incoming_presence = true
@ -1029,8 +1027,8 @@
# #
# This option sends presence updates to other servers, but does not # This option sends presence updates to other servers, but does not
# receive any unless `allow_incoming_presence` is true. Note that presence # receive any unless `allow_incoming_presence` is true. Note that presence
# on continuwuity is very fast unlike Synapse's. If using outgoing # on conduwuit is very fast unlike Synapse's. If using outgoing presence,
# presence, you MUST enable `allow_local_presence` as well. # you MUST enable `allow_local_presence` as well.
# #
#allow_outgoing_presence = true #allow_outgoing_presence = true
@ -1083,8 +1081,8 @@
# #
#typing_client_timeout_max_s = 45 #typing_client_timeout_max_s = 45
# Set this to true for continuwuity to compress HTTP response bodies using # Set this to true for conduwuit to compress HTTP response bodies using
# zstd. This option does nothing if continuwuity was not built with # zstd. This option does nothing if conduwuit was not built with
# `zstd_compression` feature. Please be aware that enabling HTTP # `zstd_compression` feature. Please be aware that enabling HTTP
# compression may weaken TLS. Most users should not need to enable this. # compression may weaken TLS. Most users should not need to enable this.
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
@ -1092,8 +1090,8 @@
# #
#zstd_compression = false #zstd_compression = false
# Set this to true for continuwuity to compress HTTP response bodies using # Set this to true for conduwuit to compress HTTP response bodies using
# gzip. This option does nothing if continuwuity was not built with # gzip. This option does nothing if conduwuit was not built with
# `gzip_compression` feature. Please be aware that enabling HTTP # `gzip_compression` feature. Please be aware that enabling HTTP
# compression may weaken TLS. Most users should not need to enable this. # compression may weaken TLS. Most users should not need to enable this.
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
@ -1104,8 +1102,8 @@
# #
#gzip_compression = false #gzip_compression = false
# Set this to true for continuwuity to compress HTTP response bodies using # Set this to true for conduwuit to compress HTTP response bodies using
# brotli. This option does nothing if continuwuity was not built with # brotli. This option does nothing if conduwuit was not built with
# `brotli_compression` feature. Please be aware that enabling HTTP # `brotli_compression` feature. Please be aware that enabling HTTP
# compression may weaken TLS. Most users should not need to enable this. # compression may weaken TLS. Most users should not need to enable this.
# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
@ -1167,7 +1165,7 @@
# Otherwise setting this to false reduces filesystem clutter and overhead # Otherwise setting this to false reduces filesystem clutter and overhead
# for managing these symlinks in the directory. This is now disabled by # for managing these symlinks in the directory. This is now disabled by
# default. You may still return to upstream Conduit but you have to run # default. You may still return to upstream Conduit but you have to run
# continuwuity at least once with this set to true and allow the # conduwuit at least once with this set to true and allow the
# media_startup_check to take place before shutting down to return to # media_startup_check to take place before shutting down to return to
# Conduit. # Conduit.
# #
@ -1212,8 +1210,8 @@
# #
#allowed_remote_server_names = [] #allowed_remote_server_names = []
# Vector list of regex patterns of server names that continuwuity will # Vector list of regex patterns of server names that conduwuit will refuse
# refuse to download remote media from. # to download remote media from.
# #
# example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"] # example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
# #
@ -1227,7 +1225,7 @@
# #
#forbidden_remote_room_directory_server_names = [] #forbidden_remote_room_directory_server_names = []
# Vector list of regex patterns of server names that continuwuity will not # Vector list of regex patterns of server names that conduwuit will not
# send messages to the client from. # send messages to the client from.
# #
# Note that there is no way for clients to receive messages once a server # Note that there is no way for clients to receive messages once a server
@ -1251,7 +1249,7 @@
#send_messages_from_ignored_users_to_client = false #send_messages_from_ignored_users_to_client = false
# Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you # Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
# do not want continuwuity to send outbound requests to. Defaults to # do not want conduwuit to send outbound requests to. Defaults to
# RFC1918, unroutable, loopback, multicast, and testnet addresses for # RFC1918, unroutable, loopback, multicast, and testnet addresses for
# security. # security.
# #
@ -1401,26 +1399,26 @@
# Allow admins to enter commands in rooms other than "#admins" (admin # Allow admins to enter commands in rooms other than "#admins" (admin
# room) by prefixing your message with "\!admin" or "\\!admin" followed up # room) by prefixing your message with "\!admin" or "\\!admin" followed up
# a normal continuwuity admin command. The reply will be publicly visible # a normal conduwuit admin command. The reply will be publicly visible to
# to the room, originating from the sender. # the room, originating from the sender.
# #
# example: \\!admin debug ping puppygock.gay # example: \\!admin debug ping puppygock.gay
# #
#admin_escape_commands = true #admin_escape_commands = true
# Automatically activate the continuwuity admin room console / CLI on # Automatically activate the conduwuit admin room console / CLI on
# startup. This option can also be enabled with `--console` continuwuity # startup. This option can also be enabled with `--console` conduwuit
# argument. # argument.
# #
#admin_console_automatic = false #admin_console_automatic = false
# List of admin commands to execute on startup. # List of admin commands to execute on startup.
# #
# This option can also be configured with the `--execute` continuwuity # This option can also be configured with the `--execute` conduwuit
# argument and can take standard shell commands and environment variables # argument and can take standard shell commands and environment variables
# #
# For example: `./continuwuity --execute "server admin-notice continuwuity # For example: `./conduwuit --execute "server admin-notice conduwuit has
# has started up at $(date)"` # started up at $(date)"`
# #
# example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]` # example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
# #
@ -1428,7 +1426,7 @@
# Ignore errors in startup commands. # Ignore errors in startup commands.
# #
# If false, continuwuity will error and fail to start if an admin execute # If false, conduwuit will error and fail to start if an admin execute
# command (`--execute` / `admin_execute`) fails. # command (`--execute` / `admin_execute`) fails.
# #
#admin_execute_errors_ignore = false #admin_execute_errors_ignore = false
@ -1449,14 +1447,15 @@
# The default room tag to apply on the admin room. # The default room tag to apply on the admin room.
# #
# On some clients like Element, the room tag "m.server_notice" is a # On some clients like Element, the room tag "m.server_notice" is a
# special pinned room at the very bottom of your room list. The # special pinned room at the very bottom of your room list. The conduwuit
# continuwuity admin room can be pinned here so you always have an # admin room can be pinned here so you always have an easy-to-access
# easy-to-access shortcut dedicated to your admin room. # shortcut dedicated to your admin room.
# #
#admin_room_tag = "m.server_notice" #admin_room_tag = "m.server_notice"
# Sentry.io crash/panic reporting, performance monitoring/metrics, etc. # Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
# This is NOT enabled by default. # This is NOT enabled by default. conduwuit's default Sentry reporting
# endpoint domain is `o4506996327251968.ingest.us.sentry.io`.
# #
#sentry = false #sentry = false
@ -1464,7 +1463,7 @@
# #
#sentry_endpoint = "" #sentry_endpoint = ""
# Report your continuwuity server_name in Sentry.io crash reports and # Report your conduwuit server_name in Sentry.io crash reports and
# metrics. # metrics.
# #
#sentry_send_server_name = false #sentry_send_server_name = false
@ -1501,7 +1500,7 @@
# Enable the tokio-console. This option is only relevant to developers. # Enable the tokio-console. This option is only relevant to developers.
# #
# For more information, see: # For more information, see:
# https://continuwuity.org/development.html#debugging-with-tokio-console # https://conduwuit.puppyirl.gay/development.html#debugging-with-tokio-console
# #
#tokio_console = false #tokio_console = false
@ -1641,29 +1640,19 @@
# #
#server = #server =
# URL to a support page for the server, which will be served as part of # This item is undocumented. Please contribute documentation for it.
# the MSC1929 server support endpoint at /.well-known/matrix/support.
# Will be included alongside any contact information
# #
#support_page = #support_page =
# Role string for server support contacts, to be served as part of the # This item is undocumented. Please contribute documentation for it.
# MSC1929 server support endpoint at /.well-known/matrix/support.
# #
#support_role = "m.role.admin" #support_role =
# Email address for server support contacts, to be served as part of the # This item is undocumented. Please contribute documentation for it.
# MSC1929 server support endpoint.
# This will be used along with support_mxid if specified.
# #
#support_email = #support_email =
# Matrix ID for server support contacts, to be served as part of the # This item is undocumented. Please contribute documentation for it.
# MSC1929 server support endpoint.
# This will be used along with support_email if specified.
#
# If no email or mxid is specified, all of the server's admins will be
# listed.
# #
#support_mxid = #support_mxid =

202
src/core/config/mod.rs
View file

@ -27,7 +27,7 @@ use self::proxy::ProxyConfig;
pub use self::{check::check, manager::Manager}; pub use self::{check::check, manager::Manager};
use crate::{Result, err, error::Error, utils::sys}; use crate::{Result, err, error::Error, utils::sys};
/// All the config options for continuwuity. /// All the config options for conduwuit.
#[allow(clippy::struct_excessive_bools)] #[allow(clippy::struct_excessive_bools)]
#[allow(rustdoc::broken_intra_doc_links, rustdoc::bare_urls)] #[allow(rustdoc::broken_intra_doc_links, rustdoc::bare_urls)]
#[derive(Clone, Debug, Deserialize)] #[derive(Clone, Debug, Deserialize)]
@ -35,7 +35,7 @@ use crate::{Result, err, error::Error, utils::sys};
filename = "conduwuit-example.toml", filename = "conduwuit-example.toml",
section = "global", section = "global",
undocumented = "# This item is undocumented. Please contribute documentation for it.", undocumented = "# This item is undocumented. Please contribute documentation for it.",
header = r#"### continuwuity Configuration header = r#"### conduwuit Configuration
### ###
### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE ### THIS FILE IS GENERATED. CHANGES/CONTRIBUTIONS IN THE REPO WILL BE
### OVERWRITTEN! ### OVERWRITTEN!
@ -50,7 +50,7 @@ use crate::{Result, err, error::Error, utils::sys};
### that say "YOU NEED TO EDIT THIS". ### that say "YOU NEED TO EDIT THIS".
### ###
### For more information, see: ### For more information, see:
### https://continuwuity.org/configuration.html ### https://conduwuit.puppyirl.gay/configuration.html
"#, "#,
ignore = "catchall well_known tls blurhashing allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure" ignore = "catchall well_known tls blurhashing allow_invalid_tls_certificates_yes_i_know_what_the_fuck_i_am_doing_with_this_and_i_know_this_is_insecure"
)] )]
@ -59,7 +59,7 @@ pub struct Config {
/// suffix for user and room IDs/aliases. /// suffix for user and room IDs/aliases.
/// ///
/// See the docs for reverse proxying and delegation: /// See the docs for reverse proxying and delegation:
/// https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy /// https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
/// ///
/// Also see the `[global.well_known]` config section at the very bottom. /// Also see the `[global.well_known]` config section at the very bottom.
/// ///
@ -70,10 +70,10 @@ pub struct Config {
/// YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE /// YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
/// WIPE. /// WIPE.
/// ///
/// example: "continuwuity.org" /// example: "conduwuit.woof"
pub server_name: OwnedServerName, pub server_name: OwnedServerName,
/// The default address (IPv4 or IPv6) continuwuity will listen on. /// The default address (IPv4 or IPv6) conduwuit will listen on.
/// ///
/// If you are using Docker or a container NAT networking setup, this must /// If you are using Docker or a container NAT networking setup, this must
/// be "0.0.0.0". /// be "0.0.0.0".
@ -85,10 +85,10 @@ pub struct Config {
#[serde(default = "default_address")] #[serde(default = "default_address")]
address: ListeningAddr, address: ListeningAddr,
/// The port(s) continuwuity will listen on. /// The port(s) conduwuit will listen on.
/// ///
/// For reverse proxying, see: /// For reverse proxying, see:
/// https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy /// https://conduwuit.puppyirl.gay/deploying/generic.html#setting-up-the-reverse-proxy
/// ///
/// If you are using Docker, don't change this, you'll need to map an /// If you are using Docker, don't change this, you'll need to map an
/// external port to this. /// external port to this.
@ -103,17 +103,16 @@ pub struct Config {
#[serde(default)] #[serde(default)]
pub tls: TlsConfig, pub tls: TlsConfig,
/// The UNIX socket continuwuity will listen on. /// The UNIX socket conduwuit will listen on.
/// ///
/// continuwuity cannot listen on both an IP address and a UNIX socket. If /// conduwuit cannot listen on both an IP address and a UNIX socket. If
/// listening on a UNIX socket, you MUST remove/comment the `address` key. /// listening on a UNIX socket, you MUST remove/comment the `address` key.
/// ///
/// Remember to make sure that your reverse proxy has access to this socket /// Remember to make sure that your reverse proxy has access to this socket
/// file, either by adding your reverse proxy to the appropriate user group /// file, either by adding your reverse proxy to the 'conduwuit' group or
/// or granting world R/W permissions with `unix_socket_perms` (666 /// granting world R/W permissions with `unix_socket_perms` (666 minimum).
/// minimum).
/// ///
/// example: "/run/continuwuity/continuwuity.sock" /// example: "/run/conduwuit/conduwuit.sock"
pub unix_socket_path: Option<PathBuf>, pub unix_socket_path: Option<PathBuf>,
/// The default permissions (in octal) to create the UNIX socket with. /// The default permissions (in octal) to create the UNIX socket with.
@ -122,22 +121,22 @@ pub struct Config {
#[serde(default = "default_unix_socket_perms")] #[serde(default = "default_unix_socket_perms")]
pub unix_socket_perms: u32, pub unix_socket_perms: u32,
/// This is the only directory where continuwuity will save its data, /// This is the only directory where conduwuit will save its data, including
/// including media. Note: this was previously "/var/lib/matrix-conduit". /// media. Note: this was previously "/var/lib/matrix-conduit".
/// ///
/// YOU NEED TO EDIT THIS. /// YOU NEED TO EDIT THIS.
/// ///
/// example: "/var/lib/continuwuity" /// example: "/var/lib/conduwuit"
pub database_path: PathBuf, pub database_path: PathBuf,
/// continuwuity supports online database backups using RocksDB's Backup /// conduwuit supports online database backups using RocksDB's Backup engine
/// engine API. To use this, set a database backup path that continuwuity /// API. To use this, set a database backup path that conduwuit can write
/// can write to. /// to.
/// ///
/// For more information, see: /// For more information, see:
/// https://continuwuity.org/maintenance.html#backups /// https://conduwuit.puppyirl.gay/maintenance.html#backups
/// ///
/// example: "/opt/continuwuity-db-backups" /// example: "/opt/conduwuit-db-backups"
pub database_backup_path: Option<PathBuf>, pub database_backup_path: Option<PathBuf>,
/// The amount of online RocksDB database backups to keep/retain, if using /// The amount of online RocksDB database backups to keep/retain, if using
@ -161,7 +160,7 @@ pub struct Config {
#[serde(default = "default_new_user_displayname_suffix")] #[serde(default = "default_new_user_displayname_suffix")]
pub new_user_displayname_suffix: String, pub new_user_displayname_suffix: String,
/// If enabled, continuwuity will send a simple GET request periodically to /// If enabled, conduwuit will send a simple GET request periodically to
/// `https://continuwuity.org/.well-known/continuwuity/announcements` for any new /// `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
/// announcements or major updates. This is not an update check endpoint. /// announcements or major updates. This is not an update check endpoint.
/// ///
@ -169,8 +168,8 @@ pub struct Config {
#[serde(alias = "allow_check_for_updates", default = "true_fn")] #[serde(alias = "allow_check_for_updates", default = "true_fn")]
pub allow_announcements_check: bool, pub allow_announcements_check: bool,
/// Set this to any float value to multiply continuwuity's in-memory LRU /// Set this to any float value to multiply conduwuit's in-memory LRU caches
/// caches with such as "auth_chain_cache_capacity". /// with such as "auth_chain_cache_capacity".
/// ///
/// May be useful if you have significant memory to spare to increase /// May be useful if you have significant memory to spare to increase
/// performance. /// performance.
@ -187,7 +186,7 @@ pub struct Config {
)] )]
pub cache_capacity_modifier: f64, pub cache_capacity_modifier: f64,
/// Set this to any float value in megabytes for continuwuity to tell the /// Set this to any float value in megabytes for conduwuit to tell the
/// database engine that this much memory is available for database read /// database engine that this much memory is available for database read
/// caches. /// caches.
/// ///
@ -203,7 +202,7 @@ pub struct Config {
#[serde(default = "default_db_cache_capacity_mb")] #[serde(default = "default_db_cache_capacity_mb")]
pub db_cache_capacity_mb: f64, pub db_cache_capacity_mb: f64,
/// Set this to any float value in megabytes for continuwuity to tell the /// Set this to any float value in megabytes for conduwuit to tell the
/// database engine that this much memory is available for database write /// database engine that this much memory is available for database write
/// caches. /// caches.
/// ///
@ -320,9 +319,9 @@ pub struct Config {
/// Enable using *only* TCP for querying your specified nameservers instead /// Enable using *only* TCP for querying your specified nameservers instead
/// of UDP. /// of UDP.
/// ///
/// If you are running continuwuity in a container environment, this config /// If you are running conduwuit in a container environment, this config
/// option may need to be enabled. For more details, see: /// option may need to be enabled. For more details, see:
/// https://continuwuity.org/troubleshooting.html#potential-dns-issues-when-using-docker /// https://conduwuit.puppyirl.gay/troubleshooting.html#potential-dns-issues-when-using-docker
#[serde(default)] #[serde(default)]
pub query_over_tcp_only: bool, pub query_over_tcp_only: bool,
@ -535,9 +534,9 @@ pub struct Config {
/// tokens. Multiple tokens can be added if you separate them with /// tokens. Multiple tokens can be added if you separate them with
/// whitespace /// whitespace
/// ///
/// continuwuity must be able to access the file, and it must not be empty /// conduwuit must be able to access the file, and it must not be empty
/// ///
/// example: "/etc/continuwuity/.reg_token" /// example: "/etc/conduwuit/.reg_token"
pub registration_token_file: Option<PathBuf>, pub registration_token_file: Option<PathBuf>,
/// Controls whether encrypted rooms and events are allowed. /// Controls whether encrypted rooms and events are allowed.
@ -628,16 +627,16 @@ pub struct Config {
pub allow_room_creation: bool, pub allow_room_creation: bool,
/// Set to false to disable users from joining or creating room versions /// Set to false to disable users from joining or creating room versions
/// that aren't officially supported by continuwuity. /// that aren't officially supported by conduwuit.
/// ///
/// continuwuity officially supports room versions 6 - 11. /// conduwuit officially supports room versions 6 - 11.
/// ///
/// continuwuity has slightly experimental (though works fine in practice) /// conduwuit has slightly experimental (though works fine in practice)
/// support for versions 3 - 5. /// support for versions 3 - 5.
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
pub allow_unstable_room_versions: bool, pub allow_unstable_room_versions: bool,
/// Default room version continuwuity will create rooms with. /// Default room version conduwuit will create rooms with.
/// ///
/// Per spec, room version 11 is the default. /// Per spec, room version 11 is the default.
/// ///
@ -711,7 +710,7 @@ pub struct Config {
/// Servers listed here will be used to gather public keys of other servers /// Servers listed here will be used to gather public keys of other servers
/// (notary trusted key servers). /// (notary trusted key servers).
/// ///
/// Currently, continuwuity doesn't support inbound batched key requests, so /// Currently, conduwuit doesn't support inbound batched key requests, so
/// this list should only contain other Synapse servers. /// this list should only contain other Synapse servers.
/// ///
/// example: ["matrix.org", "tchncs.de"] /// example: ["matrix.org", "tchncs.de"]
@ -756,7 +755,7 @@ pub struct Config {
#[serde(default = "default_trusted_server_batch_size")] #[serde(default = "default_trusted_server_batch_size")]
pub trusted_server_batch_size: usize, pub trusted_server_batch_size: usize,
/// Max log level for continuwuity. Allows debug, info, warn, or error. /// Max log level for conduwuit. Allows debug, info, warn, or error.
/// ///
/// See also: /// See also:
/// https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives /// https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
@ -781,9 +780,8 @@ pub struct Config {
#[serde(default = "default_log_span_events")] #[serde(default = "default_log_span_events")]
pub log_span_events: String, pub log_span_events: String,
/// Configures whether CONTINUWUITY_LOG EnvFilter matches values using /// Configures whether CONDUWUIT_LOG EnvFilter matches values using regular
/// regular expressions. See the tracing_subscriber documentation on /// expressions. See the tracing_subscriber documentation on Directives.
/// Directives.
/// ///
/// default: true /// default: true
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
@ -865,7 +863,7 @@ pub struct Config {
/// This takes priority over "turn_secret" first, and falls back to /// This takes priority over "turn_secret" first, and falls back to
/// "turn_secret" if invalid or failed to open. /// "turn_secret" if invalid or failed to open.
/// ///
/// example: "/etc/continuwuity/.turn_secret" /// example: "/etc/conduwuit/.turn_secret"
pub turn_secret_file: Option<PathBuf>, pub turn_secret_file: Option<PathBuf>,
/// TURN TTL, in seconds. /// TURN TTL, in seconds.
@ -874,12 +872,12 @@ pub struct Config {
#[serde(default = "default_turn_ttl")] #[serde(default = "default_turn_ttl")]
pub turn_ttl: u64, pub turn_ttl: u64,
/// List/vector of room IDs or room aliases that continuwuity will make /// List/vector of room IDs or room aliases that conduwuit will make newly
/// newly registered users join. The rooms specified must be rooms that you /// registered users join. The rooms specified must be rooms that you have
/// have joined at least once on the server, and must be public. /// joined at least once on the server, and must be public.
/// ///
/// example: ["#continuwuity:continuwuity.org", /// example: ["#conduwuit:puppygock.gay",
/// "!main-1:continuwuity.org"] /// "!eoIzvAvVwY23LPDay8:puppygock.gay"]
/// ///
/// default: [] /// default: []
#[serde(default = "Vec::new")] #[serde(default = "Vec::new")]
@ -904,10 +902,10 @@ pub struct Config {
#[serde(default)] #[serde(default)]
pub auto_deactivate_banned_room_attempts: bool, pub auto_deactivate_banned_room_attempts: bool,
/// RocksDB log level. This is not the same as continuwuity's log level. /// RocksDB log level. This is not the same as conduwuit's log level. This
/// This is the log level for the RocksDB engine/library which show up in /// is the log level for the RocksDB engine/library which show up in your
/// your database folder/path as `LOG` files. continuwuity will log RocksDB /// database folder/path as `LOG` files. conduwuit will log RocksDB errors
/// errors as normal through tracing or panics if severe for safety. /// as normal through tracing or panics if severe for safety.
/// ///
/// default: "error" /// default: "error"
#[serde(default = "default_rocksdb_log_level")] #[serde(default = "default_rocksdb_log_level")]
@ -932,7 +930,7 @@ pub struct Config {
/// Set this to true to use RocksDB config options that are tailored to HDDs /// Set this to true to use RocksDB config options that are tailored to HDDs
/// (slower device storage). /// (slower device storage).
/// ///
/// It is worth noting that by default, continuwuity will use RocksDB with /// It is worth noting that by default, conduwuit will use RocksDB with
/// Direct IO enabled. *Generally* speaking this improves performance as it /// Direct IO enabled. *Generally* speaking this improves performance as it
/// bypasses buffered I/O (system page cache). However there is a potential /// bypasses buffered I/O (system page cache). However there is a potential
/// chance that Direct IO may cause issues with database operations if your /// chance that Direct IO may cause issues with database operations if your
@ -940,7 +938,7 @@ pub struct Config {
/// possibly ZFS filesystem. RocksDB generally deals/corrects these issues /// possibly ZFS filesystem. RocksDB generally deals/corrects these issues
/// but it cannot account for all setups. If you experience any weird /// but it cannot account for all setups. If you experience any weird
/// RocksDB issues, try enabling this option as it turns off Direct IO and /// RocksDB issues, try enabling this option as it turns off Direct IO and
/// feel free to report in the continuwuity Matrix room if this option fixes /// feel free to report in the conduwuit Matrix room if this option fixes
/// your DB issues. /// your DB issues.
/// ///
/// For more information, see: /// For more information, see:
@ -1001,7 +999,7 @@ pub struct Config {
/// as they all differ. See their `kDefaultCompressionLevel`. /// as they all differ. See their `kDefaultCompressionLevel`.
/// ///
/// Note when using the default value we may override it with a setting /// Note when using the default value we may override it with a setting
/// tailored specifically for continuwuity. /// tailored specifically conduwuit.
/// ///
/// default: 32767 /// default: 32767
#[serde(default = "default_rocksdb_compression_level")] #[serde(default = "default_rocksdb_compression_level")]
@ -1019,7 +1017,7 @@ pub struct Config {
/// algorithm. /// algorithm.
/// ///
/// Note when using the default value we may override it with a setting /// Note when using the default value we may override it with a setting
/// tailored specifically for continuwuity. /// tailored specifically conduwuit.
/// ///
/// default: 32767 /// default: 32767
#[serde(default = "default_rocksdb_bottommost_compression_level")] #[serde(default = "default_rocksdb_bottommost_compression_level")]
@ -1061,13 +1059,13 @@ pub struct Config {
/// 0 = AbsoluteConsistency /// 0 = AbsoluteConsistency
/// 1 = TolerateCorruptedTailRecords (default) /// 1 = TolerateCorruptedTailRecords (default)
/// 2 = PointInTime (use me if trying to recover) /// 2 = PointInTime (use me if trying to recover)
/// 3 = SkipAnyCorruptedRecord (you now voided your Continuwuity warranty) /// 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
/// ///
/// For more information on these modes, see: /// For more information on these modes, see:
/// https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes /// https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
/// ///
/// For more details on recovering a corrupt database, see: /// For more details on recovering a corrupt database, see:
/// https://continuwuity.org/troubleshooting.html#database-corruption /// https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption
/// ///
/// default: 1 /// default: 1
#[serde(default = "default_rocksdb_recovery_mode")] #[serde(default = "default_rocksdb_recovery_mode")]
@ -1111,7 +1109,7 @@ pub struct Config {
/// - Disabling repair mode and restarting the server is recommended after /// - Disabling repair mode and restarting the server is recommended after
/// running the repair. /// running the repair.
/// ///
/// See https://continuwuity.org/troubleshooting.html#database-corruption for more details on recovering a corrupt database. /// See https://conduwuit.puppyirl.gay/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
#[serde(default)] #[serde(default)]
pub rocksdb_repair: bool, pub rocksdb_repair: bool,
@ -1136,7 +1134,7 @@ pub struct Config {
/// Enables RocksDB compaction. You should never ever have to set this /// Enables RocksDB compaction. You should never ever have to set this
/// option to false. If you for some reason find yourself needing to use /// option to false. If you for some reason find yourself needing to use
/// this option as part of troubleshooting or a bug, please reach out to us /// this option as part of troubleshooting or a bug, please reach out to us
/// in the continuwuity Matrix room with information and details. /// in the conduwuit Matrix room with information and details.
/// ///
/// Disabling compaction will lead to a significantly bloated and /// Disabling compaction will lead to a significantly bloated and
/// explosively large database, gradually poor performance, unnecessarily /// explosively large database, gradually poor performance, unnecessarily
@ -1164,7 +1162,7 @@ pub struct Config {
/// purposes such as recovering/recreating your admin room, or inviting /// purposes such as recovering/recreating your admin room, or inviting
/// yourself back. /// yourself back.
/// ///
/// See https://continuwuity.org/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room. /// See https://conduwuit.puppyirl.gay/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
/// ///
/// Once this password is unset, all sessions will be logged out for /// Once this password is unset, all sessions will be logged out for
/// security purposes. /// security purposes.
@ -1180,8 +1178,8 @@ pub struct Config {
/// Allow local (your server only) presence updates/requests. /// Allow local (your server only) presence updates/requests.
/// ///
/// Note that presence on continuwuity is very fast unlike Synapse's. If /// Note that presence on conduwuit is very fast unlike Synapse's. If using
/// using outgoing presence, this MUST be enabled. /// outgoing presence, this MUST be enabled.
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
pub allow_local_presence: bool, pub allow_local_presence: bool,
@ -1189,7 +1187,7 @@ pub struct Config {
/// ///
/// This option receives presence updates from other servers, but does not /// This option receives presence updates from other servers, but does not
/// send any unless `allow_outgoing_presence` is true. Note that presence on /// send any unless `allow_outgoing_presence` is true. Note that presence on
/// continuwuity is very fast unlike Synapse's. /// conduwuit is very fast unlike Synapse's.
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
pub allow_incoming_presence: bool, pub allow_incoming_presence: bool,
@ -1197,8 +1195,8 @@ pub struct Config {
/// ///
/// This option sends presence updates to other servers, but does not /// This option sends presence updates to other servers, but does not
/// receive any unless `allow_incoming_presence` is true. Note that presence /// receive any unless `allow_incoming_presence` is true. Note that presence
/// on continuwuity is very fast unlike Synapse's. If using outgoing /// on conduwuit is very fast unlike Synapse's. If using outgoing presence,
/// presence, you MUST enable `allow_local_presence` as well. /// you MUST enable `allow_local_presence` as well.
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
pub allow_outgoing_presence: bool, pub allow_outgoing_presence: bool,
@ -1261,8 +1259,8 @@ pub struct Config {
#[serde(default = "default_typing_client_timeout_max_s")] #[serde(default = "default_typing_client_timeout_max_s")]
pub typing_client_timeout_max_s: u64, pub typing_client_timeout_max_s: u64,
/// Set this to true for continuwuity to compress HTTP response bodies using /// Set this to true for conduwuit to compress HTTP response bodies using
/// zstd. This option does nothing if continuwuity was not built with /// zstd. This option does nothing if conduwuit was not built with
/// `zstd_compression` feature. Please be aware that enabling HTTP /// `zstd_compression` feature. Please be aware that enabling HTTP
/// compression may weaken TLS. Most users should not need to enable this. /// compression may weaken TLS. Most users should not need to enable this.
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH /// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
@ -1270,8 +1268,8 @@ pub struct Config {
#[serde(default)] #[serde(default)]
pub zstd_compression: bool, pub zstd_compression: bool,
/// Set this to true for continuwuity to compress HTTP response bodies using /// Set this to true for conduwuit to compress HTTP response bodies using
/// gzip. This option does nothing if continuwuity was not built with /// gzip. This option does nothing if conduwuit was not built with
/// `gzip_compression` feature. Please be aware that enabling HTTP /// `gzip_compression` feature. Please be aware that enabling HTTP
/// compression may weaken TLS. Most users should not need to enable this. /// compression may weaken TLS. Most users should not need to enable this.
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before /// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
@ -1282,8 +1280,8 @@ pub struct Config {
#[serde(default)] #[serde(default)]
pub gzip_compression: bool, pub gzip_compression: bool,
/// Set this to true for continuwuity to compress HTTP response bodies using /// Set this to true for conduwuit to compress HTTP response bodies using
/// brotli. This option does nothing if continuwuity was not built with /// brotli. This option does nothing if conduwuit was not built with
/// `brotli_compression` feature. Please be aware that enabling HTTP /// `brotli_compression` feature. Please be aware that enabling HTTP
/// compression may weaken TLS. Most users should not need to enable this. /// compression may weaken TLS. Most users should not need to enable this.
/// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH /// See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
@ -1344,7 +1342,7 @@ pub struct Config {
/// Otherwise setting this to false reduces filesystem clutter and overhead /// Otherwise setting this to false reduces filesystem clutter and overhead
/// for managing these symlinks in the directory. This is now disabled by /// for managing these symlinks in the directory. This is now disabled by
/// default. You may still return to upstream Conduit but you have to run /// default. You may still return to upstream Conduit but you have to run
/// continuwuity at least once with this set to true and allow the /// conduwuit at least once with this set to true and allow the
/// media_startup_check to take place before shutting down to return to /// media_startup_check to take place before shutting down to return to
/// Conduit. /// Conduit.
#[serde(default)] #[serde(default)]
@ -1393,8 +1391,8 @@ pub struct Config {
#[serde(default, with = "serde_regex")] #[serde(default, with = "serde_regex")]
pub allowed_remote_server_names: RegexSet, pub allowed_remote_server_names: RegexSet,
/// Vector list of regex patterns of server names that continuwuity will /// Vector list of regex patterns of server names that conduwuit will refuse
/// refuse to download remote media from. /// to download remote media from.
/// ///
/// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"] /// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
/// ///
@ -1412,7 +1410,7 @@ pub struct Config {
#[serde(default, with = "serde_regex")] #[serde(default, with = "serde_regex")]
pub forbidden_remote_room_directory_server_names: RegexSet, pub forbidden_remote_room_directory_server_names: RegexSet,
/// Vector list of regex patterns of server names that continuwuity will not /// Vector list of regex patterns of server names that conduwuit will not
/// send messages to the client from. /// send messages to the client from.
/// ///
/// Note that there is no way for clients to receive messages once a server /// Note that there is no way for clients to receive messages once a server
@ -1438,7 +1436,7 @@ pub struct Config {
pub send_messages_from_ignored_users_to_client: bool, pub send_messages_from_ignored_users_to_client: bool,
/// Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you /// Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
/// do not want continuwuity to send outbound requests to. Defaults to /// do not want conduwuit to send outbound requests to. Defaults to
/// RFC1918, unroutable, loopback, multicast, and testnet addresses for /// RFC1918, unroutable, loopback, multicast, and testnet addresses for
/// security. /// security.
/// ///
@ -1606,26 +1604,26 @@ pub struct Config {
/// Allow admins to enter commands in rooms other than "#admins" (admin /// Allow admins to enter commands in rooms other than "#admins" (admin
/// room) by prefixing your message with "\!admin" or "\\!admin" followed up /// room) by prefixing your message with "\!admin" or "\\!admin" followed up
/// a normal continuwuity admin command. The reply will be publicly visible /// a normal conduwuit admin command. The reply will be publicly visible to
/// to the room, originating from the sender. /// the room, originating from the sender.
/// ///
/// example: \\!admin debug ping puppygock.gay /// example: \\!admin debug ping puppygock.gay
#[serde(default = "true_fn")] #[serde(default = "true_fn")]
pub admin_escape_commands: bool, pub admin_escape_commands: bool,
/// Automatically activate the continuwuity admin room console / CLI on /// Automatically activate the conduwuit admin room console / CLI on
/// startup. This option can also be enabled with `--console` continuwuity /// startup. This option can also be enabled with `--console` conduwuit
/// argument. /// argument.
#[serde(default)] #[serde(default)]
pub admin_console_automatic: bool, pub admin_console_automatic: bool,
/// List of admin commands to execute on startup. /// List of admin commands to execute on startup.
/// ///
/// This option can also be configured with the `--execute` continuwuity /// This option can also be configured with the `--execute` conduwuit
/// argument and can take standard shell commands and environment variables /// argument and can take standard shell commands and environment variables
/// ///
/// For example: `./continuwuity --execute "server admin-notice continuwuity /// For example: `./conduwuit --execute "server admin-notice conduwuit has
/// has started up at $(date)"` /// started up at $(date)"`
/// ///
/// example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]` /// example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
/// ///
@ -1635,7 +1633,7 @@ pub struct Config {
/// Ignore errors in startup commands. /// Ignore errors in startup commands.
/// ///
/// If false, continuwuity will error and fail to start if an admin execute /// If false, conduwuit will error and fail to start if an admin execute
/// command (`--execute` / `admin_execute`) fails. /// command (`--execute` / `admin_execute`) fails.
#[serde(default)] #[serde(default)]
pub admin_execute_errors_ignore: bool, pub admin_execute_errors_ignore: bool,
@ -1660,16 +1658,17 @@ pub struct Config {
/// The default room tag to apply on the admin room. /// The default room tag to apply on the admin room.
/// ///
/// On some clients like Element, the room tag "m.server_notice" is a /// On some clients like Element, the room tag "m.server_notice" is a
/// special pinned room at the very bottom of your room list. The /// special pinned room at the very bottom of your room list. The conduwuit
/// continuwuity admin room can be pinned here so you always have an /// admin room can be pinned here so you always have an easy-to-access
/// easy-to-access shortcut dedicated to your admin room. /// shortcut dedicated to your admin room.
/// ///
/// default: "m.server_notice" /// default: "m.server_notice"
#[serde(default = "default_admin_room_tag")] #[serde(default = "default_admin_room_tag")]
pub admin_room_tag: String, pub admin_room_tag: String,
/// Sentry.io crash/panic reporting, performance monitoring/metrics, etc. /// Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
/// This is NOT enabled by default. /// This is NOT enabled by default. conduwuit's default Sentry reporting
/// endpoint domain is `o4506996327251968.ingest.us.sentry.io`.
#[serde(default)] #[serde(default)]
pub sentry: bool, pub sentry: bool,
@ -1680,7 +1679,7 @@ pub struct Config {
#[serde(default = "default_sentry_endpoint")] #[serde(default = "default_sentry_endpoint")]
pub sentry_endpoint: Option<Url>, pub sentry_endpoint: Option<Url>,
/// Report your continuwuity server_name in Sentry.io crash reports and /// Report your conduwuit server_name in Sentry.io crash reports and
/// metrics. /// metrics.
#[serde(default)] #[serde(default)]
pub sentry_send_server_name: bool, pub sentry_send_server_name: bool,
@ -1721,7 +1720,7 @@ pub struct Config {
/// Enable the tokio-console. This option is only relevant to developers. /// Enable the tokio-console. This option is only relevant to developers.
/// ///
/// For more information, see: /// For more information, see:
/// https://continuwuity.org/development.html#debugging-with-tokio-console /// https://conduwuit.puppyirl.gay/development.html#debugging-with-tokio-console
#[serde(default)] #[serde(default)]
pub tokio_console: bool, pub tokio_console: bool,
@ -1897,28 +1896,12 @@ pub struct WellKnownConfig {
/// example: "matrix.example.com:443" /// example: "matrix.example.com:443"
pub server: Option<OwnedServerName>, pub server: Option<OwnedServerName>,
/// URL to a support page for the server, which will be served as part of
/// the MSC1929 server support endpoint at /.well-known/matrix/support.
/// Will be included alongside any contact information
pub support_page: Option<Url>, pub support_page: Option<Url>,
/// Role string for server support contacts, to be served as part of the
/// MSC1929 server support endpoint at /.well-known/matrix/support.
///
/// default: "m.role.admin"
pub support_role: Option<ContactRole>, pub support_role: Option<ContactRole>,
/// Email address for server support contacts, to be served as part of the
/// MSC1929 server support endpoint.
/// This will be used along with support_mxid if specified.
pub support_email: Option<String>, pub support_email: Option<String>,
/// Matrix ID for server support contacts, to be served as part of the
/// MSC1929 server support endpoint.
/// This will be used along with support_email if specified.
///
/// If no email or mxid is specified, all of the server's admins will be
/// listed.
pub support_mxid: Option<OwnedUserId>, pub support_mxid: Option<OwnedUserId>,
} }
@ -1979,11 +1962,7 @@ impl Config {
where where
I: Iterator<Item = &'a Path>, I: Iterator<Item = &'a Path>,
{ {
let envs = [ let envs = [Env::var("CONDUIT_CONFIG"), Env::var("CONDUWUIT_CONFIG")];
Env::var("CONDUIT_CONFIG"),
Env::var("CONDUWUIT_CONFIG"),
Env::var("CONTINUWUITY_CONFIG"),
];
let config = envs let config = envs
.into_iter() .into_iter()
@ -1992,8 +1971,7 @@ impl Config {
.chain(paths.map(Toml::file)) .chain(paths.map(Toml::file))
.fold(Figment::new(), |config, file| config.merge(file.nested())) .fold(Figment::new(), |config, file| config.merge(file.nested()))
.merge(Env::prefixed("CONDUIT_").global().split("__")) .merge(Env::prefixed("CONDUIT_").global().split("__"))
.merge(Env::prefixed("CONDUWUIT_").global().split("__")) .merge(Env::prefixed("CONDUWUIT_").global().split("__"));
.merge(Env::prefixed("CONTINUWUITY_").global().split("__"));
Ok(config) Ok(config)
} }

20
src/service/moderation.rs
View file

@ -10,14 +10,16 @@ pub struct Service {
} }
struct Services { struct Services {
pub config: Dep<config::Service> // pub server: Arc<Server>,
pub config: Dep<config::Service>,
} }
impl crate::Service for Service { impl crate::Service for Service {
fn build(args: crate::Args<'_>) -> Result<Arc<Self>> { fn build(args: crate::Args<'_>) -> Result<Arc<Self>> {
Ok(Arc::new(Self { Ok(Arc::new(Self {
services: Services { services: Services {
config: args.depend::<config::Service>("config") // server: args.server.clone(),
config: args.depend::<config::Service>("config"),
}, },
})) }))
} }
@ -25,6 +27,20 @@ impl crate::Service for Service {
fn name(&self) -> &str { crate::service::make_name(std::module_path!()) } fn name(&self) -> &str { crate::service::make_name(std::module_path!()) }
} }
#[implement(Service)]
#[must_use]
pub fn is_remote_server_ignored(&self, server_name: &ServerName) -> bool {
// We must never block federating with ourselves
if server_name == self.services.config.server_name {
return false;
}
self.services
.config
.ignore_messages_from_server_names
.is_match(server_name.host())
}
#[implement(Service)] #[implement(Service)]
#[must_use] #[must_use]
pub fn is_remote_server_forbidden(&self, server_name: &ServerName) -> bool { pub fn is_remote_server_forbidden(&self, server_name: &ServerName) -> bool {