diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/matrix/synapse.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/matrix/synapse.nix | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/nixpkgs/nixos/modules/services/matrix/synapse.nix b/nixpkgs/nixos/modules/services/matrix/synapse.nix index 7291c0fcbcdd..bc88fb53012b 100644 --- a/nixpkgs/nixos/modules/services/matrix/synapse.nix +++ b/nixpkgs/nixos/modules/services/matrix/synapse.nix @@ -219,7 +219,7 @@ in { type = types.nullOr types.port; default = null; example = 8448; - description = lib.mdDoc '' + description = '' The port to listen for HTTP(S) requests on. ''; }; @@ -245,7 +245,7 @@ in { "0.0.0.0" ] ''; - description = lib.mdDoc '' + description = '' IP addresses to bind the listener to. ''; }; @@ -288,7 +288,7 @@ in { ]; default = "http"; example = "metrics"; - description = lib.mdDoc '' + description = '' The type of the listener, usually http. ''; }; @@ -303,7 +303,7 @@ in { Enabled for the main instance listener, unless it is configured with a UNIX domain socket path. ''; example = false; - description = lib.mdDoc '' + description = '' Whether to enable TLS on the listener socket. ::: {.note} @@ -319,7 +319,7 @@ in { Enabled if the listener is configured with a UNIX domain socket path ''; example = true; - description = lib.mdDoc '' + description = '' Use the X-Forwarded-For (XFF) header as the client IP and not the actual client IP. ''; @@ -341,7 +341,7 @@ in { "replication" "static" ]); - description = lib.mdDoc '' + description = '' List of resources to host on this listener. ''; example = [ @@ -351,7 +351,7 @@ in { compress = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether synapse should compress HTTP responses to clients that support it. This should be disabled if running synapse behind a load balancer that can do automatic compression. @@ -359,7 +359,7 @@ in { }; }; }); - description = lib.mdDoc '' + description = '' List of HTTP resources to serve on this listener. ''; }; @@ -367,7 +367,7 @@ in { }); in { services.matrix-synapse = { - enable = mkEnableOption (lib.mdDoc "matrix.org synapse"); + enable = mkEnableOption "matrix.org synapse, the reference homeserver"; enableRegistrationScript = mkOption { type = types.bool; @@ -389,7 +389,7 @@ in { serviceUnit = lib.mkOption { type = lib.types.str; readOnly = true; - description = lib.mdDoc '' + description = '' The systemd unit (a service or a target) for other services to depend on if they need to be started after matrix-synapse. @@ -401,7 +401,7 @@ in { configFile = mkOption { type = types.path; readOnly = true; - description = lib.mdDoc '' + description = '' Path to the configuration file on the target system. Useful to configure e.g. workers that also need this. ''; @@ -410,7 +410,7 @@ in { package = mkOption { type = types.package; readOnly = true; - description = lib.mdDoc '' + description = '' Reference to the `matrix-synapse` wrapper with all extras (e.g. for `oidc` or `saml2`) added to the `PYTHONPATH` of all executables. @@ -445,7 +445,7 @@ in { "user-search" # Support internationalized domain names in user-search ] ''; - description = lib.mdDoc '' + description = '' Explicitly install extras provided by matrix-synapse. Most will require some additional configuration. @@ -467,7 +467,7 @@ in { matrix-synapse-pam ]; ''; - description = lib.mdDoc '' + description = '' List of additional Matrix plugins to make available. ''; }; @@ -475,7 +475,7 @@ in { withJemalloc = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to preload jemalloc to reduce memory fragmentation and overall usage. ''; }; @@ -483,7 +483,7 @@ in { dataDir = mkOption { type = types.str; default = "/var/lib/matrix-synapse"; - description = lib.mdDoc '' + description = '' The directory where matrix-synapse stores its stateful data such as certificates, media and uploads. ''; @@ -492,7 +492,7 @@ in { log = mkOption { type = types.attrsOf format.type; defaultText = literalExpression defaultCommonLogConfigText; - description = mdDoc '' + description = '' Default configuration for the loggers used by `matrix-synapse` and its workers. The defaults are added with the default priority which means that these will be merged with additional declarations. These additional @@ -534,7 +534,7 @@ in { settings = mkOption { default = { }; - description = mdDoc '' + description = '' The primary synapse configuration. See the [sample configuration](https://github.com/element-hq/synapse/blob/v${pkgs.matrix-synapse-unwrapped.version}/docs/sample_config.yaml) for possible values. @@ -553,7 +553,7 @@ in { example = "example.com"; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; - description = lib.mdDoc '' + description = '' 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. @@ -565,7 +565,7 @@ in { enable_registration = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable registration for new users. ''; }; @@ -573,7 +573,7 @@ in { registration_shared_secret = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc '' + description = '' If set, allows registration by anyone who also has the shared secret, even if registration is otherwise disabled. @@ -584,7 +584,7 @@ in { macaroon_secret_key = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc '' + description = '' Secret key for authentication tokens. If none is specified, the registration_shared_secret is used, if one is given; otherwise, a secret key is derived from the signing key. @@ -596,7 +596,7 @@ in { enable_metrics = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable collection and rendering of performance metrics ''; }; @@ -604,7 +604,7 @@ in { report_stats = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not to report anonymized homeserver usage statistics. ''; }; @@ -612,7 +612,7 @@ in { signing_key_path = mkOption { type = types.path; default = "${cfg.dataDir}/homeserver.signing.key"; - description = lib.mdDoc '' + description = '' Path to the signing key to sign messages with. ''; }; @@ -621,7 +621,7 @@ in { type = types.path; default = "/run/matrix-synapse.pid"; readOnly = true; - description = lib.mdDoc '' + description = '' The file to store the PID in. ''; }; @@ -630,7 +630,7 @@ in { type = types.path; default = genLogConfigFile "synapse"; defaultText = logConfigText "synapse"; - description = lib.mdDoc '' + description = '' The file that holds the logging configuration. ''; }; @@ -641,7 +641,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 = lib.mdDoc '' + description = '' Directory where uploaded images and attachments are stored. ''; }; @@ -650,7 +650,7 @@ in { type = types.nullOr types.str; default = null; example = "https://example.com:8448/"; - description = lib.mdDoc '' + description = '' The public-facing base URL for the client API (not including _matrix/...) ''; }; @@ -659,7 +659,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/fullchain.pem"; - description = lib.mdDoc '' + description = '' 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 @@ -672,7 +672,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/key.pem"; - description = lib.mdDoc '' + description = '' PEM encoded private key for TLS. Specify null if synapse is not speaking TLS directly. ''; @@ -682,7 +682,7 @@ in { type = types.bool; default = true; example = false; - description = lib.mdDoc '' + description = '' Whether to enable presence tracking. Presence tracking allows users to see the state (e.g online/offline) @@ -713,7 +713,7 @@ in { compress = false; }]; }; - description = lib.mdDoc '' + description = '' List of ports that Synapse should listen on, their purpose and their configuration. By default, synapse will be configured for client and federation traffic on port 8008, and @@ -735,7 +735,7 @@ in { then "psycopg2" else "sqlite3" ''; - description = lib.mdDoc '' + description = '' The database engine name. Can be sqlite3 or psycopg2. ''; }; @@ -752,7 +752,7 @@ in { psycopg2 = "matrix-synapse"; }.''${${options.services.matrix-synapse.settings}.database.name}; ''; - description = lib.mdDoc '' + description = '' Name of the database when using the psycopg2 backend, path to the database location when using sqlite3. ''; @@ -770,7 +770,7 @@ in { psycopg2 = "matrix-synapse"; }.''${cfg.settings.database.name}; ''; - description = lib.mdDoc '' + description = '' Username to connect with psycopg2, set to null when using sqlite3. ''; @@ -780,7 +780,7 @@ in { type = types.bool; default = true; example = false; - description = lib.mdDoc '' + description = '' Is the preview URL API enabled? If enabled, you *must* specify an explicit url_preview_ip_range_blacklist of IPs that the spider is denied from accessing. @@ -810,7 +810,7 @@ in { "fec0::/10" "ff00::/8" ]; - description = lib.mdDoc '' + description = '' List of IP address CIDR ranges that the URL preview spider is denied from accessing. ''; @@ -819,7 +819,7 @@ in { url_preview_ip_range_whitelist = mkOption { type = types.listOf types.str; default = [ ]; - description = lib.mdDoc '' + description = '' 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. ''; @@ -847,7 +847,7 @@ in { { netloc = "www.acme.com"; path = "/foo"; } # block http(s)://www.acme.com/foo ] ''; - description = lib.mdDoc '' + description = '' Optional list of URL matches that the URL preview spider is denied from accessing. ''; @@ -857,7 +857,7 @@ in { type = types.str; default = "50M"; example = "100M"; - description = lib.mdDoc '' + description = '' The largest allowed upload size in bytes ''; }; @@ -866,7 +866,7 @@ in { type = types.str; default = "32M"; example = "64M"; - description = lib.mdDoc '' + description = '' Maximum number of pixels that will be thumbnailed ''; }; @@ -875,7 +875,7 @@ in { type = types.bool; default = false; example = true; - description = lib.mdDoc '' + description = '' 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 @@ -893,7 +893,7 @@ in { "turns:turn.example.com:5349?transport=udp" "turns:turn.example.com:5349?transport=tcp" ]; - description = lib.mdDoc '' + description = '' The public URIs of the TURN server to give to clients ''; }; @@ -903,7 +903,7 @@ in { example = literalExpression '' config.services.coturn.static-auth-secret ''; - description = mdDoc '' + description = '' The shared secret used to compute passwords for the TURN server. Secrets should be passed in via `extraConfigFiles`! @@ -917,7 +917,7 @@ in { server_name = mkOption { type = types.str; example = "matrix.org"; - description = lib.mdDoc '' + description = '' Hostname of the trusted server. ''; }; @@ -929,7 +929,7 @@ in { "ed25519:auto" = "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"; }; }]; - description = lib.mdDoc '' + description = '' The trusted servers to download signing keys from. ''; }; @@ -937,7 +937,7 @@ in { app_service_config_files = mkOption { type = types.listOf types.path; default = [ ]; - description = lib.mdDoc '' + description = '' A list of application service config file to use ''; }; @@ -949,14 +949,14 @@ in { enabled = lib.mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to use redis support ''; }; }; }; default = { }; - description = lib.mdDoc '' + description = '' Redis configuration for synapse. See the @@ -970,7 +970,7 @@ in { workers = lib.mkOption { default = { }; - description = lib.mdDoc '' + description = '' Options for configuring workers. Worker support will be enabled if at least one worker is configured here. See the [worker documention](https://element-hq.github.io/synapse/latest/workers.html#worker-configuration) @@ -1007,7 +1007,7 @@ in { worker_listeners = lib.mkOption { default = [ ]; type = types.listOf (listenerType true); - description = lib.mdDoc '' + description = '' List of ports that this worker should listen on, their purpose and their configuration. ''; }; @@ -1015,7 +1015,7 @@ in { type = types.path; default = genLogConfigFile "synapse-${name}"; defaultText = logConfigText "synapse-${name}"; - description = lib.mdDoc '' + description = '' The file for log configuration. See the [python documentation](https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema) @@ -1050,7 +1050,7 @@ in { extraConfigFiles = mkOption { type = types.listOf types.path; default = [ ]; - description = lib.mdDoc '' + description = '' Extra config files to include. The configuration files will be included based on the command line @@ -1063,7 +1063,7 @@ in { configureRedisLocally = lib.mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to automatically configure a local redis server for matrix-synapse. ''; }; |