Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/mautrix-telegram: add documentation for setting arbitrary secrets #103347

Closed
wants to merge 1 commit into from
Closed

nixos/mautrix-telegram: add documentation for setting arbitrary secrets #103347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion nixos/modules/services/misc/mautrix-telegram.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,19 @@ in {
default = null;
description = ''
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.
<literal>MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN</literal>,
<literal>MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN</literal>,
<literal>MAUTRIX_TELEGRAM_TELEGRAM_API_ID</literal>,
<literal>MAUTRIX_TELEGRAM_TELEGRAM_API_HASH</literal> and optionally
<literal>MAUTRIX_TELEGRAM_TELEGRAM_BOT_TOKEN</literal>.
</para>

<para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blindly relying on how the manual is assembled (i.e. that each description is inside a <para> right now) is IMHO not a good idea, this can easily cause some weird side-effects as soon as some config of our docbook build changes.

These environment variables can also be used to set other options by
replacing hierachy levels by <literal>.</literal>, converting the name
to uppercase and prepending <literal>MAUTRIX_TELEGRAM_</literal>.
For example, the first value above maps to <option>appservice.as_token</option>.
'';
};

Expand Down