Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

From Nix

Nix Package

You can get a Nix package for Venator from packages.${pkgs.stdenv.hostPlatform.system}.default, using the flake.nix or default.nix at the root of this repo. This package includes the venatorctl binary, docs, and a systemd service.

NixOS Module

Venator defines a NixOS module in flake.nix and default.nix at the root of our repo.

Here’s a basic example of how to use the module:

imports = [ inputs.venator.nixosModules.default ];

services.matrix-venator = {
  enable = true;
  configurePostgres = true;

  settings = {
    server_name = "venator.localhost";
    registration.admin_pre_shared_secret = "preSharedSecret";

	# Many more settings are allowed, see below.
  };
};

For a list of attributes available in the NixOS module, see the module reference. 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.