diff options
Diffstat (limited to 'nixos/modules/services/matrix/synapse.nix')
| -rw-r--r-- | nixos/modules/services/matrix/synapse.nix | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix index 3d5d10cdf07..0dbfcc17638 100644 --- a/nixos/modules/services/matrix/synapse.nix +++ b/nixos/modules/services/matrix/synapse.nix @@ -143,7 +143,7 @@ in { configFile = mkOption { type = types.path; readOnly = true; - description = '' + description = lib.mdDoc '' Path to the configuration file on the target system. Useful to configure e.g. workers that also need this. ''; @@ -153,7 +153,7 @@ in { type = types.package; default = pkgs.matrix-synapse; defaultText = literalExpression "pkgs.matrix-synapse"; - description = '' + description = lib.mdDoc '' Overridable attribute of the matrix synapse server package to use. ''; }; @@ -167,7 +167,7 @@ in { matrix-synapse-pam ]; ''; - description = '' + description = lib.mdDoc '' List of additional Matrix plugins to make available. ''; }; @@ -175,7 +175,7 @@ in { withJemalloc = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to preload jemalloc to reduce memory fragmentation and overall usage. ''; }; @@ -183,7 +183,7 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/matrix-synapse"; - description = '' + description = lib.mdDoc '' The directory where matrix-synapse stores its stateful data such as certificates, media and uploads. ''; @@ -210,7 +210,7 @@ in { example = "example.com"; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = '' + description = lib.mdDoc '' The domain name of the server, with optional explicit port. This is used by remote servers to look up the server address. This is also the last part of your UserID. @@ -222,7 +222,7 @@ in { enable_registration = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable registration for new users. ''; }; @@ -253,7 +253,7 @@ in { enable_metrics = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable collection and rendering of performance metrics ''; }; @@ -261,7 +261,7 @@ in { report_stats = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether or not to report anonymized homeserver usage statistics. ''; }; @@ -269,7 +269,7 @@ in { signing_key_path = mkOption { type = types.path; default = "${cfg.dataDir}/homeserver.signing.key"; - description = '' + description = lib.mdDoc '' Path to the signing key to sign messages with. ''; }; @@ -278,7 +278,7 @@ in { type = types.path; default = "/run/matrix-synapse.pid"; readOnly = true; - description = '' + description = lib.mdDoc '' The file to store the PID in. ''; }; @@ -286,7 +286,7 @@ in { log_config = mkOption { type = types.path; default = ./synapse-log_config.yaml; - description = '' + description = lib.mdDoc '' The file that holds the logging configuration. ''; }; @@ -297,7 +297,7 @@ in { then "${cfg.dataDir}/media_store" else "${cfg.dataDir}/media"; defaultText = "${cfg.dataDir}/media_store for when system.stateVersion is at least 22.05, ${cfg.dataDir}/media when lower than 22.05"; - description = '' + description = lib.mdDoc '' Directory where uploaded images and attachments are stored. ''; }; @@ -306,7 +306,7 @@ in { type = types.nullOr types.str; default = null; example = "https://example.com:8448/"; - description = '' + description = lib.mdDoc '' The public-facing base URL for the client API (not including _matrix/...) ''; }; @@ -315,7 +315,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/fullchain.pem"; - description = '' + description = lib.mdDoc '' PEM encoded X509 certificate for TLS. You can replace the self-signed certificate that synapse autogenerates on launch with your own SSL certificate + key pair @@ -328,7 +328,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/key.pem"; - description = '' + description = lib.mdDoc '' PEM encoded private key for TLS. Specify null if synapse is not speaking TLS directly. ''; @@ -338,7 +338,7 @@ in { type = types.bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Whether to enable presence tracking. Presence tracking allows users to see the state (e.g online/offline) @@ -352,7 +352,7 @@ in { port = mkOption { type = types.port; example = 8448; - description = '' + description = lib.mdDoc '' The port to listen for HTTP(S) requests on. ''; }; @@ -369,7 +369,7 @@ in { "0.0.0.0" ] ''; - description = '' + description = lib.mdDoc '' IP addresses to bind the listener to. ''; }; @@ -383,7 +383,7 @@ in { ]; default = "http"; example = "metrics"; - description = '' + description = lib.mdDoc '' The type of the listener, usually http. ''; }; @@ -392,7 +392,7 @@ in { type = types.bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Whether to enable TLS on the listener socket. ''; }; @@ -401,7 +401,7 @@ in { type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Use the X-Forwarded-For (XFF) header as the client IP and not the actual client IP. ''; @@ -422,7 +422,7 @@ in { "replication" "static" ]); - description = '' + description = lib.mdDoc '' List of resources to host on this listener. ''; example = [ @@ -431,7 +431,7 @@ in { }; compress = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Should synapse compress HTTP responses to clients that support it? This should be disabled if running synapse behind a load balancer that can do automatic compression. @@ -439,7 +439,7 @@ in { }; }; }); - description = '' + description = lib.mdDoc '' List of HTTP resources to serve on this listener. ''; }; @@ -459,7 +459,7 @@ in { compress = false; } ]; } ]; - description = '' + description = lib.mdDoc '' List of ports that Synapse should listen on, their purpose and their configuration. ''; }; @@ -477,7 +477,7 @@ in { then "psycopg2" else "sqlite3" ''; - description = '' + description = lib.mdDoc '' The database engine name. Can be sqlite3 or psycopg2. ''; }; @@ -494,7 +494,7 @@ in { psycopg2 = "matrix-synapse"; }.''${${options.services.matrix-synapse.settings}.database.name}; ''; - description = '' + description = lib.mdDoc '' Name of the database when using the psycopg2 backend, path to the database location when using sqlite3. ''; @@ -506,7 +506,7 @@ in { sqlite3 = null; psycopg2 = "matrix-synapse"; }.${cfg.settings.database.name}; - description = '' + description = lib.mdDoc '' Username to connect with psycopg2, set to null when using sqlite3. ''; @@ -546,7 +546,7 @@ in { "fec0::/10" "ff00::/8" ]; - description = '' + description = lib.mdDoc '' List of IP address CIDR ranges that the URL preview spider is denied from accessing. ''; @@ -555,7 +555,7 @@ in { url_preview_ip_range_whitelist = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List of IP address CIDR ranges that the URL preview spider is allowed to access even if they are specified in url_preview_ip_range_blacklist. ''; @@ -564,7 +564,7 @@ in { url_preview_url_blacklist = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Optional list of URL matches that the URL preview spider is denied from accessing. ''; @@ -574,7 +574,7 @@ in { type = types.str; default = "50M"; example = "100M"; - description = '' + description = lib.mdDoc '' The largest allowed upload size in bytes ''; }; @@ -583,7 +583,7 @@ in { type = types.str; default = "32M"; example = "64M"; - description = '' + description = lib.mdDoc '' Maximum number of pixels that will be thumbnailed ''; }; @@ -592,7 +592,7 @@ in { type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to generate new thumbnails on the fly to precisely match the resolution requested by the client. If true then whenever a new resolution is requested by the client the server will @@ -610,7 +610,7 @@ in { "turns:turn.example.com:5349?transport=udp" "turns:turn.example.com:5349?transport=tcp" ]; - description = '' + description = lib.mdDoc '' The public URIs of the TURN server to give to clients ''; }; @@ -633,7 +633,7 @@ in { server_name = mkOption { type = types.str; example = "matrix.org"; - description = '' + description = lib.mdDoc '' Hostname of the trusted server. ''; }; @@ -646,7 +646,7 @@ in { "ed25519:auto" = "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"; } ''; - description = '' + description = lib.mdDoc '' Attribute set from key id to base64 encoded public key. If specified synapse will check that the response is signed @@ -661,7 +661,7 @@ in { "ed25519:auto" = "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"; }; } ]; - description = '' + description = lib.mdDoc '' The trusted servers to download signing keys from. ''; }; @@ -669,7 +669,7 @@ in { app_service_config_files = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' A list of application service config file to use ''; }; @@ -681,7 +681,7 @@ in { extraConfigFiles = mkOption { type = types.listOf types.path; default = []; - description = '' + description = lib.mdDoc '' Extra config files to include. The configuration files will be included based on the command line |