services.matrix-venator.enable
Whether to enable Venator, a versatile capital Matrix homeserver written from scratch in mautrix-go.
Type: boolean
Default:
false
Example:
true
services.matrix-venator.enableWrapper
Whether to add a wrapped venatorctl to the path that refers to the server’s config file
Type: boolean
Default:
true
Example:
false
services.matrix-venator.package
The default package to use.
Type: package
Default:
pkgs.default
services.matrix-venator.configFile
A YAML file containing the Venator config.
Warning: Please note that this overrides services.matrix-venator.settings!
Type: absolute path
Default:
"YAML file generated from {option}`services.matrix-venator.settings`"
services.matrix-venator.configurePostgres
Whether to enable postgres locally using services.postgresql.
Type: boolean
Default:
false
Example:
true
services.matrix-venator.environmentFile
EnvironmentFile as defined in systemd.exec(5).
Type: null or absolute path
Default:
null
Example:
"/run/secrets/matrix-venator.env"
services.matrix-venator.settings
The Venator server configuration. Any setting that would be allowed in the YAML Venator config is allowed in services.matrix-venator.settings, even if it is not explicitly listed.
Type: open submodule of attribute set of (attribute set)
Example:
{
registration = {
admin_pre_shared_secret_file = "/etc/matrix-venator/someSecretFile.txt";
enabled = true;
};
server_name = "venator.example.com";
}
services.matrix-venator.settings.database.url
PostgreSQL database URL
Type: null or string
Default:
null
Example:
"postgresql://venator:venator@localhost:5432/venator?sslmode=disable"
services.matrix-venator.settings.database.urlFile
Path to a file containing the PostgreSQL database URL
Type: null or absolute path
Default:
null
services.matrix-venator.settings.listeners
List of addresses and ports Venator will listen on.
These listeners are used for both the Client-Server and Server-Server APIs.
Type: list of (submodule)
Default:
[
{
port = 8008;
tls = false;
}
{
port = 8448;
tls = false;
}
]
services.matrix-venator.settings.listeners.*.port
port
Type: signed integer
Example:
8448
services.matrix-venator.settings.listeners.*.tls
Whether to enable tls.
Type: boolean
Default:
false
Example:
true
services.matrix-venator.settings.logging.writers
List of log writers for Venator to use.
The full schema can be found at https://pkg.go.dev/go.mau.fi/zeroconfig#readme-config-reference.
Type: list of (open submodule of attribute set of string)
Default:
[
{
format = "pretty-colored";
type = "stdout";
}
]
services.matrix-venator.settings.logging.writers.*.type
The type of writer to use
Type: string
Default:
"stdout"
Example:
"file"
services.matrix-venator.settings.registration.enabled
Whether to enable registration
Type: boolean
Default:
true
Example:
false
services.matrix-venator.settings.registration.admin_pre_shared_secret
The admin pre-shared secret as text.
Warning: Please note that this copies the admin pre-shared secret into the world-readable Nix store.
It is recommended to use admin_pre_shared_secret_file instead.
Type: null or string
Default:
null
services.matrix-venator.settings.registration.admin_pre_shared_secret_file
Path to a file containing the admin pre-shared secret.
Type: null or absolute path
Default:
null
services.matrix-venator.settings.registration.requires_token
Whether registration requires a token
Type: boolean
Default:
true
Example:
false
services.matrix-venator.settings.server_name
Name of the server
Type: string
Example:
"venator.localhost:8008"