Module config 

Loads and validates server configuration.

Configuration types preserve startup sources for reloads and expose typed settings to the rest of the workspace. Field documentation also supplies the generated example configuration.

Re-exports

pub use self::check::check;

pub use self::ip_source::IpSource;

pub use self::manager::Manager;

pub use self::sources::Sources;

Modules

check

Validates configuration before startup and reload.

identity_provider_serde 🔒

ip_source

Defines sources for trusted client IP extraction.

manager

Maintains the active reloadable configuration.

net 🔒

proxy

Defines outbound proxy configuration and domain matching.

regenerate 🔒

room_version

Defines supported Matrix room-version policy.

sources

Defines the inputs used to assemble configuration.

well_known

Converts discovery configuration into Matrix API values.

Structs

AppService

Defines one inline Matrix application service registration.

AppServiceNamespace

Defines one namespace claimed by an application service.

Config

All the config options for tuwunel.

Figment

Combiner of [Provider]s for configuration value extraction.

IdentityProvider

Configures one OpenID Connect identity provider.

JwtConfig

Configures authentication using JSON Web Tokens.

LdapConfig

Configures LDAP authentication and directory-backed administration.

RegenerateOptions

Selects how an existing configuration is regenerated.

RegenerationSummary

Summarizes a completed configuration regeneration.

SmtpConfig

Configures outbound email verification through SMTP.

StorageProviderLocal

Configures local filesystem object storage.

StorageProviderS3

Configures an S3-compatible object storage provider.

SupportContact

Defines a contact published by the support discovery endpoint.

SupportPolicy

Defines one policy published by the support discovery endpoint.

SupportPolicyTranslation

Defines one localized support policy document.

TermsPolicy

Defines a policy document required during registration.

TermsPolicyTranslation

Defines one localized registration policy document.

TlsConfig

Configures direct TLS listener behavior.

WellKnownConfig

Configures Matrix discovery documents and related response data.

Enums

FigmentValue

An enum representing all possible figment value variants.

Overwrite

Selects whether an existing output may be replaced.

StorageProvider

Selects the backend for a named media storage provider.

Constants

ENV_PREFIXES 🔒

TUWUNEL_CONFIG_SECTION_APPSERVICE 🔒

TUWUNEL_CONFIG_SECTION_APPSERVICENAMESPACE 🔒

TUWUNEL_CONFIG_SECTION_CONFIG 🔒

TUWUNEL_CONFIG_SECTION_IDENTITYPROVIDER 🔒

TUWUNEL_CONFIG_SECTION_JWTCONFIG 🔒

TUWUNEL_CONFIG_SECTION_LDAPCONFIG 🔒

TUWUNEL_CONFIG_SECTION_SMTPCONFIG 🔒

TUWUNEL_CONFIG_SECTION_STORAGEPROVIDERLOCAL 🔒

TUWUNEL_CONFIG_SECTION_STORAGEPROVIDERS3 🔒

TUWUNEL_CONFIG_SECTION_SUPPORTCONTACT 🔒

TUWUNEL_CONFIG_SECTION_SUPPORTPOLICY 🔒

TUWUNEL_CONFIG_SECTION_SUPPORTPOLICYTRANSLATION 🔒

TUWUNEL_CONFIG_SECTION_TERMSPOLICY 🔒

TUWUNEL_CONFIG_SECTION_TERMSPOLICYTRANSLATION 🔒

TUWUNEL_CONFIG_SECTION_TLSCONFIG 🔒

TUWUNEL_CONFIG_SECTION_WELLKNOWNCONFIG 🔒

Statics

DEPRECATED_KEYS 🔒

Items listed here generate a deprecation warning when configured.

KNOWN_KEYS 🔒

Items matched here will not generate an “unknown to tuwunel” warning when configured. This is important for environment variables which share the TUWUNEL_ prefix namespace but aren’t config items; match them here in their split+lowercased format.

Functions

default_access_token_ttl 🔒

default_admin_log_capture 🔒

default_admin_output_max_events 🔒

default_admin_room_tag 🔒

default_appservice_idle_timeout 🔒

default_appservice_timeout 🔒

default_auth_chain_cache_capacity 🔒

default_cache_capacity_modifier 🔒

default_client_receive_timeout 🔒

default_client_request_timeout 🔒

default_client_response_timeout 🔒

default_client_shutdown_timeout 🔒

default_client_sync_timeout_default 🔒

default_client_sync_timeout_max 🔒

default_client_sync_timeout_min 🔒

default_conduit_media_directory_depth 🔒

default_conduit_media_directory_length 🔒

default_database_backups_to_keep 🔒

default_database_path 🔒

default_db_cache_capacity_mb 🔒

default_db_pool_max_workers 🔒

default_db_pool_queue_mult 🔒

default_db_pool_workers 🔒

default_db_pool_workers_limit 🔒

default_db_write_buffer_capacity_mb 🔒

default_default_room_version

Returns the default Matrix room version.

default_deprioritize_joins_through_servers 🔒

default_dns_attempts 🔒

default_dns_cache_entries 🔒

default_dns_min_ttl 🔒

default_dns_min_ttl_nxdomain 🔒

default_dns_timeout 🔒

default_eventid_backoff_cache_capacity 🔒

default_eventid_pdu_cache_capacity 🔒

default_eventidshort_cache_capacity 🔒

default_federation_idle_per_host 🔒

default_federation_idle_timeout 🔒

default_federation_keys_timeout 🔒

default_federation_timeout 🔒

default_fetch_prev_wait_ms 🔒

default_forward_extremities_emergency_max 🔒

default_forward_extremities_max 🔒

default_forward_extremities_prune_batch 🔒

default_ip_lookup_strategy 🔒

default_ip_range_denylist 🔒

default_jaeger_filter 🔒

default_jwt_algorithm 🔒

default_jwt_format 🔒

default_ldap_search_filter 🔒

default_ldap_uid_attribute 🔒

default_log

do debug logging by default for debug builds

default_log_span_events

Returns the default tracing span-event mode.

default_login_token_ttl 🔒

default_max_fetch_prev_events 🔒

default_max_join_attempts_per_join_request 🔒

default_max_make_join_attempts_per_join_attempt 🔒

default_max_pending_media_uploads 🔒

default_max_request_size 🔒

default_max_response_size 🔒

default_media_create_unused_expiration_time 🔒

default_media_rc_create_burst_count 🔒

default_media_rc_create_per_second 🔒

default_media_storage_providers 🔒

default_media_thumbnail_max_pixels 🔒

default_media_video_thumbnail_concurrency 🔒

default_media_video_thumbnail_max_size 🔒

default_media_video_thumbnail_timeout 🔒

default_mediaid_lazycontent_cache_capacity 🔒

default_multipart_part_size 🔒

default_multipart_threshold 🔒

default_new_user_displayname_suffix 🔒

default_notification_push_path 🔒

default_one_time_key_limit 🔒

default_openid_token_ttl 🔒

default_pdu_cache_capacity 🔒

default_policy_server_request_timeout 🔒

default_port 🔒

default_presence_idle_timeout_s 🔒

default_presence_offline_timeout_s 🔒

default_pusher_idle_timeout 🔒

default_redaction_retention_seconds 🔒

default_refresh_token_reuse_grace 🔒

default_rendezvous_max_sessions 🔒

default_rendezvous_rc_burst_count 🔒

default_rendezvous_rc_per_second 🔒

default_rendezvous_session_max_bytes 🔒

default_rendezvous_session_ttl 🔒

default_request_conn_timeout 🔒

default_request_idle_per_host 🔒

default_request_idle_timeout 🔒

default_request_timeout 🔒

default_request_total_timeout 🔒

default_resolve_state_locally_max 🔒

default_resolver_cache_capacity 🔒

default_rocksdb_bottommost_compression_level 🔒

Default RocksDB compression level is 32767, which is internally read by RocksDB as the default magic number and translated to the library’s default compression level as they all differ. See their kDefaultCompressionLevel.

default_rocksdb_compression_algo 🔒

default_rocksdb_compression_level 🔒

Default RocksDB compression level is 32767, which is internally read by RocksDB as the default magic number and translated to the library’s default compression level as they all differ. See their kDefaultCompressionLevel.

default_rocksdb_log_level 🔒

default_rocksdb_log_time_to_roll 🔒

default_rocksdb_max_log_file_size 🔒

default_rocksdb_max_log_files 🔒

default_rocksdb_parallelism_threads 🔒

default_rocksdb_recovery_mode 🔒

default_rocksdb_stats_level 🔒

default_sender_idle_timeout 🔒

default_sender_retry_backoff_limit 🔒

default_sender_retry_grace 🔒

default_sender_shutdown_timeout 🔒

default_sender_timeout 🔒

default_sentry_endpoint 🔒

default_sentry_filter 🔒

default_sentry_traces_sample_rate 🔒

default_servername_status_cache_capacity 🔒

default_servernameevent_data_cache_capacity 🔒

default_shorteventid_cache_capacity 🔒

default_shortstatekey_cache_capacity 🔒

default_spacehierarchy_cache_ttl_max 🔒

default_spacehierarchy_cache_ttl_min 🔒

default_sso_grant_session_duration 🔒

default_startup_netburst_keep 🔒

default_stateinfo_cache_capacity 🔒

default_statekeyshort_cache_capacity 🔒

default_stream_amplification 🔒

default_stream_width_default 🔒

default_stream_width_scale 🔒

default_tracing_flame_filter 🔒

default_tracing_flame_output_path 🔒

default_trusted_server_batch_concurrency 🔒

default_trusted_server_batch_size 🔒

default_trusted_servers 🔒

default_turn_ttl 🔒

default_typing_client_timeout_max_s 🔒

default_typing_client_timeout_min_s 🔒

default_typing_federation_timeout_s 🔒

default_unix_socket_perms 🔒

default_url_preview_max_media_size 🔒

default_url_preview_max_spider_size 🔒

default_well_known_conn_timeout 🔒

default_well_known_timeout 🔒

example_config

Renders the example configuration carried by this binary.

parallelism_scaled 🔒

parallelism_scaled_f64 🔒

parallelism_scaled_u32 🔒

regenerate_config

Regenerates the file-backed configuration retained by sources.

some_true_fn 🔒

true_fn 🔒

write_example_config

Writes the example configuration to a filesystem path.