Add secret management command line options to documentation. (#247)

This commit is contained in:
Gnuxie
2024-02-09 18:39:24 +00:00
committed by GitHub
parent 561cd96488
commit 945c737df6
2 changed files with 15 additions and 3 deletions
+4 -2
View File
@@ -7,6 +7,8 @@ homeserverUrl: "https://matrix.org"
rawHomeserverUrl: "https://matrix.org"
# Matrix Access Token to use, Draupnir will only use this if pantalaimon.use is false.
# This option can be loaded from a file by passing "--access-token-path <path>" at the command line,
# which would allow using secret management systems such as systemd's service credentials.
accessToken: "YOUR_TOKEN_HERE"
# Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
@@ -26,6 +28,8 @@ pantalaimon:
# The password Draupnir will login with.
#
# After successfully logging in once, this will be ignored, so this value can be blanked after first startup.
# This option can be loaded from a file by passing "--pantalaimon-password-path <path>" at the command line,
# which would allow using secret management systems such as systemd's service credentials.
password: your_password
# Experimental usage of the matrix-bot-sdk rust crypto.
@@ -242,8 +246,6 @@ health:
# and 1.0 means "trace performance at every opportunity".
# tracesSampleRate: 0.5
# Options for exposing web APIs.
web:
# Whether to enable web APIs.
+11 -1
View File
@@ -20,11 +20,20 @@ admin, and the server needs to be Synapse.
See the [sample configuration](../config/default.yaml) for documentation about individual config keys.
## Secret Management
If you need to use a secret management system, such as systemd's service credentials,
the following options are available at the command line:
- The access token can be provided with the option `--access-token-path`.
- The Pantalaimon password can be provided with the option `--pantalaimon-password-path`.
## Installation
On a high level, installing Draupnir works like the following;
1. Creating an account for draupnir.
(Optional) Disable rate limits for that account.
(Optional) Disable rate limits for that account.
2. Install draupnir, see below.
3. Configure draupnir see [further below](#post-install).
4. Start draupnir.
@@ -32,6 +41,7 @@ On a high level, installing Draupnir works like the following;
Draupnir can be installed in two ways, via Docker, or building it yourself.
See the below links for corresponding installation documentation;
- [Docker](./setup_docker.md)
- [Building It](./setup_selfbuild.md)