magmaus3/continuwuity
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Fix configuration examples and defaults

Browse source
This commit is contained in:
Jade Ellis 2025-04-23 23:54:16 +01:00
parent 45872ede7a
commit 859ec56b4f
No known key found for this signature in database
GPG key ID: 8705A2A3EBF77BD2
2 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
conduwuit-example.toml
View file

@ -116,7 +116,7 @@
# `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
# announcements or major updates. This is not an update check endpoint.
#
#allow_announcements_check =
#allow_announcements_check = true
# Set this to any float value to multiply conduwuit's in-memory LRU caches
# with such as "auth_chain_cache_capacity".
@ -1207,7 +1207,7 @@
# You can set this to ["*"] to block all servers by default, and then
# use `allowed_remote_server_names` to allow only specific servers.
#
# example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
# example: ["badserver\\.tld$", "badphrase", "19dollarfortnitecards"]
#
#forbidden_remote_server_names = []
@ -1216,7 +1216,7 @@
#
# This option has no effect if `forbidden_remote_server_names` is empty.
#
# example: ["goodserver\.tld$", "goodphrase"]
# example: ["goodserver\\.tld$", "goodphrase"]
#
#allowed_remote_server_names = []

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

@ -163,6 +163,8 @@ pub struct Config {
/// If enabled, conduwuit will send a simple GET request periodically to
/// `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
/// announcements or major updates. This is not an update check endpoint.
///
/// default: true
#[serde(alias = "allow_check_for_updates", default = "true_fn")]
pub allow_announcements_check: bool,
@ -1384,7 +1386,7 @@ pub struct Config {
/// You can set this to ["*"] to block all servers by default, and then
/// use `allowed_remote_server_names` to allow only specific servers.
///
/// example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
/// example: ["badserver\\.tld$", "badphrase", "19dollarfortnitecards"]
///
/// default: []
#[serde(default, with = "serde_regex")]
@ -1395,7 +1397,7 @@ pub struct Config {
///
/// This option has no effect if `forbidden_remote_server_names` is empty.
///
/// example: ["goodserver\.tld$", "goodphrase"]
/// example: ["goodserver\\.tld$", "goodphrase"]
///
/// default: []
#[serde(default, with = "serde_regex")]