From 4a8f6ceb6650d818d893a86d2216beea0cd2f0d1 Mon Sep 17 00:00:00 2001 From: CRTified Date: Tue, 10 Nov 2020 22:24:27 +0100 Subject: [PATCH] nixos/mautrix-telegram: add documentation for setting arbitrary secrets The change that allows setting the secrets by an environment file had the undocumented side effect of allowing to set any key by the environment file (Related PR: https://github.com/tulir/mautrix-telegram/pull/332). This is required to e.g. set `bridge.login_shared_secret`, which was not documented before. GitHub: closes #103347 --- nixos/modules/services/matrix/mautrix-telegram.nix | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/nixos/modules/services/matrix/mautrix-telegram.nix b/nixos/modules/services/matrix/mautrix-telegram.nix index fc8b95051ddb..0611f21367be 100644 --- a/nixos/modules/services/matrix/mautrix-telegram.nix +++ b/nixos/modules/services/matrix/mautrix-telegram.nix @@ -97,12 +97,18 @@ in { default = null; description = lib.mdDoc '' File containing environment variables to be passed to the mautrix-telegram service, - in which secret tokens can be specified securely by defining values for + in which secret tokens can be specified securely by defining values for e.g. `MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN`, `MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN`, `MAUTRIX_TELEGRAM_TELEGRAM_API_ID`, `MAUTRIX_TELEGRAM_TELEGRAM_API_HASH` and optionally `MAUTRIX_TELEGRAM_TELEGRAM_BOT_TOKEN`. + + These environment variables can also be used to set other options by + replacing hierachy levels by `.`, converting the name to uppercase + and prepending `MAUTRIX_TELEGRAM_`. + For example, the first value above maps to + {option}`settings.appservice.as_token`. ''; };