nixos/mautrix-telegram: add documentation for setting arbitrary secrets #103347
Conversation
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: mautrix/telegram#332). This is required to e.g. set `bridge.login_shared_secret`, which was not documented before.
ofborg
bot
added
6.topic: nixos
| <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> |
There was a problem hiding this comment.
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.
|
I marked this as stale due to inactivity. → More info |
stale
bot
added
the
2.status: stale
|
@CRTified is there an upstream documentation page that explains this behavior to which we can add a link instead of giving an incomplete list of environment variables? |
stale
bot
removed
the
2.status: stale
|
@doronbehar I was not able to find any documentation in the official docs, probably because this was integrated only due to the PR that I referenced when opening this PR (and that contribution came from @pacien). This would suggest that setting these options with other means is not the intended method of configuration. There's also this "long standing" issue that some configuration options are not accessible from the environment anymore: mautrix/telegram#584 |
|
I marked this as stale due to inactivity. → More info |
stale
bot
added
the
2.status: stale
Artturin
added
the
12.approvals: 1
stale
bot
removed
the
2.status: stale
stale
bot
added
the
2.status: stale
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: mautrix/telegram#332). This is required to e.g. set `bridge.login_shared_secret`, which was not documented before. GitHub: closes NixOS#103347
Motivation for this change
services.mautrix-telegram.environmentFilecan be used to set arbitrary options and is not limitedto the five tokens listed in the original documentation.
In my case, I used it to set
bridge.login_shared_secret(as a secret, it should not be added to the store), which maps to the environment valueMAUTRIX_TELEGRAM_BRIDGE_LOGIN_SHARED_SECRET.This PR adds documentation on how to override arbitrary other settings.
This is possible because of the changes here: mautrix/telegram#332
Things done
sandboxinnix.confon non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)@pacien might want to have a look at this, too.