Skip to main content

Module check

Module check 

Source
Expand description

Validates configuration before startup and reload.

Checks reject invalid combinations while emitting warnings for deprecated or risky values. Reload validation also prevents runtime changes to fixed identity and network fields.

Constantsยง

MAX_THUMBNAIL_CONCURRENCY ๐Ÿ”’
Slots either thumbnail concurrency knob may ask for.

Functionsยง

check
Validates a complete server configuration.
check_email ๐Ÿ”’
check_identity_provider_secret ๐Ÿ”’
check_identity_providers ๐Ÿ”’
check_jwt ๐Ÿ”’
check_media_providers ๐Ÿ”’
check_network ๐Ÿ”’
check_observability ๐Ÿ”’
check_password_hashing ๐Ÿ”’
check_profile_requests ๐Ÿ”’
check_registration ๐Ÿ”’
check_registration_terms ๐Ÿ”’
check_room_version ๐Ÿ”’
check_storage ๐Ÿ”’
check_thumbnails ๐Ÿ”’
check_turn_and_media_misc ๐Ÿ”’
check_url_previews ๐Ÿ”’
check_video_thumbnails ๐Ÿ”’
check_well_known_support_contact_validity ๐Ÿ”’
database_filesystem ๐Ÿ”’
Identify the filesystem that will host the database.
is_literal_dotted ๐Ÿ”’
Whether a pattern is a plain dotted name rather than an expression.
reload
Performs check() with additional checks specific to reloading old config with new config.
unusable_concurrency ๐Ÿ”’
Whether a concurrency knob names a number of slots that cannot serve.
valid_openpgp4fpr ๐Ÿ”’
validate_pgp_key ๐Ÿ”’
Validates an MSC4439 pgp_key: a URI, never inline key material.
warn_deprecated ๐Ÿ”’
Iterates over all the keys in the config file and warns if there is a deprecated key specified
warn_legacy_state_local ๐Ÿ”’
warn_literal_pattern ๐Ÿ”’
warn_literal_patterns ๐Ÿ”’
Warns where a pattern option holds text that reads as a plain name.
warn_loopback_in_container ๐Ÿ”’
warn_oidc_client_approval ๐Ÿ”’
warn_oidc_registration_token ๐Ÿ”’
warn_unknown_key ๐Ÿ”’
iterates over all the catchall keys (unknown config options) and warns or errors if there are any.