Change default emoji due to inconsistent support. (closes #80)

Move config item to more prominent location.

Signed-off-by: Jason Volk <jason@zemos.net>
This commit is contained in:
Jason Volk
2025-06-24 20:42:37 +00:00
parent 578cf9d2d7
commit 84ce3e0d0e
3 changed files with 38 additions and 38 deletions

View File

@@ -1,4 +1,4 @@
# Tuwunel <sup>🎔</sup>
# Tuwunel <sup>💕</sup>
![GitHub License](https://img.shields.io/github/license/matrix-construct/tuwunel?style=flat&color=%238A2BE2)
![GitHub Created At](https://img.shields.io/github/created-at/matrix-construct/tuwunel?style=flat&color=%238A2BE2)
@@ -160,7 +160,7 @@ and not all project staff will be present there. There will be at least some pre
offer assistance so long as the room remains in minimally good standing.
## Tuwunel <sup>🎔</sup>
## Tuwunel <sup>💕</sup>
Tuwunel's theme is **empathy** in communication defined by the works of
[Edith Stein](https://plato.stanford.edu/entries/stein/). Empathy is the basis for how we approach

View File

@@ -78,6 +78,24 @@ pub struct Config {
/// example: "girlboss.ceo"
pub server_name: OwnedServerName,
/// This is the only directory where tuwunel will save its data, including
/// media. Note: this was previously "/var/lib/matrix-conduit".
///
/// YOU NEED TO EDIT THIS.
///
/// example: "/var/lib/tuwunel"
pub database_path: PathBuf,
/// Text which will be added to the end of the user's displayname upon
/// registration with a space before the text. In Conduit, this was the
/// lightning bolt emoji.
///
/// To disable, set this to "" (an empty string).
///
/// default: "💕"
#[serde(default = "default_new_user_displayname_suffix")]
pub new_user_displayname_suffix: String,
#[allow(clippy::doc_link_with_quotes)]
/// The default address (IPv4 or IPv6) tuwunel will listen on.
///
@@ -127,14 +145,6 @@ pub struct Config {
#[serde(default = "default_unix_socket_perms")]
pub unix_socket_perms: u32,
/// This is the only directory where tuwunel will save its data, including
/// media. Note: this was previously "/var/lib/matrix-conduit".
///
/// YOU NEED TO EDIT THIS.
///
/// example: "/var/lib/tuwunel"
pub database_path: PathBuf,
/// tuwunel supports online database backups using RocksDB's Backup engine
/// API. To use this, set a database backup path that tuwunel can write
/// to.
@@ -152,16 +162,6 @@ pub struct Config {
#[serde(default = "default_database_backups_to_keep")]
pub database_backups_to_keep: i16,
/// Text which will be added to the end of the user's displayname upon
/// registration with a space before the text. In Conduit, this was the
/// lightning bolt emoji.
///
/// To disable, set this to "" (an empty string).
///
/// default: "🎔"
#[serde(default = "default_new_user_displayname_suffix")]
pub new_user_displayname_suffix: String,
/// Set this to any float value to multiply tuwunel's in-memory LRU caches
/// with such as "auth_chain_cache_capacity".
///
@@ -2530,7 +2530,7 @@ fn default_url_preview_max_spider_size() -> usize {
256_000 // 256KB
}
fn default_new_user_displayname_suffix() -> String { "🎔".to_owned() }
fn default_new_user_displayname_suffix() -> String { "💕".to_owned() }
fn default_sentry_endpoint() -> Option<Url> {
let url = "https://8994b1762a6a95af9502a7900edabc4c@o4509498990067712.ingest.us.sentry.io/4509498993213440"

View File

@@ -36,6 +36,23 @@
#
#server_name =
# This is the only directory where tuwunel will save its data, including
# media. Note: this was previously "/var/lib/matrix-conduit".
#
# YOU NEED TO EDIT THIS.
#
# example: "/var/lib/tuwunel"
#
#database_path =
# Text which will be added to the end of the user's displayname upon
# registration with a space before the text. In Conduit, this was the
# lightning bolt emoji.
#
# To disable, set this to "" (an empty string).
#
#new_user_displayname_suffix = "💕"
# The default address (IPv4 or IPv6) tuwunel will listen on.
#
# If you are using Docker or a container NAT networking setup, this must
@@ -75,15 +92,6 @@
#
#unix_socket_perms = 660
# This is the only directory where tuwunel will save its data, including
# media. Note: this was previously "/var/lib/matrix-conduit".
#
# YOU NEED TO EDIT THIS.
#
# example: "/var/lib/tuwunel"
#
#database_path =
# tuwunel supports online database backups using RocksDB's Backup engine
# API. To use this, set a database backup path that tuwunel can write
# to.
@@ -100,14 +108,6 @@
#
#database_backups_to_keep = 1
# Text which will be added to the end of the user's displayname upon
# registration with a space before the text. In Conduit, this was the
# lightning bolt emoji.
#
# To disable, set this to "" (an empty string).
#
#new_user_displayname_suffix = "🎔"
# Set this to any float value to multiply tuwunel's in-memory LRU caches
# with such as "auth_chain_cache_capacity".
#