diff options
author | pennae <github@quasiparticle.net> | 2022-08-30 14:08:50 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-31 17:27:36 +0200 |
commit | f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f (patch) | |
tree | 8635d6ef91a1d530e32d8eb0e360c42b1c755b6d /nixos/modules/services/matrix | |
parent | 722b99bc0eb57711c0498a86a3f55e6c69cdb05f (diff) | |
download | nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar.gz nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar.bz2 nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar.lz nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar.xz nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.tar.zst nixpkgs-f2ea09ecbe1fa1da32eaa6e036d64ac324a2986f.zip |
nixos/*: convert options with listings
minor rendering changes.
Diffstat (limited to 'nixos/modules/services/matrix')
-rw-r--r-- | nixos/modules/services/matrix/dendrite.nix | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/nixos/modules/services/matrix/dendrite.nix b/nixos/modules/services/matrix/dendrite.nix index 51eaa4f1271..9279af246f4 100644 --- a/nixos/modules/services/matrix/dendrite.nix +++ b/nixos/modules/services/matrix/dendrite.nix @@ -50,26 +50,26 @@ in type = lib.types.nullOr lib.types.path; example = "/var/lib/dendrite/registration_secret"; default = null; - description = '' - Environment file as defined in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + description = lib.mdDoc '' + Environment file as defined in {manpage}`systemd.exec(5)`. Secrets may be passed to the service without adding them to the world-readable Nix store, by specifying placeholder variables as the option value in Nix and setting these variables accordingly in the environment file. Currently only used for the registration secret to allow secure registration when client_api.registration_disabled is true. - <programlisting> + ``` # snippet of dendrite-related config services.dendrite.settings.client_api.registration_shared_secret = "$REGISTRATION_SHARED_SECRET"; - </programlisting> + ``` - <programlisting> + ``` # content of the environment file REGISTRATION_SHARED_SECRET=verysecretpassword - </programlisting> + ``` Note that this file needs to be available on the host on which - <literal>dendrite</literal> is running. + `dendrite` is running. ''; }; loadCredential = lib.mkOption { |