From 801292f1b21fb3b1d35e1398108fd49c43179a9a Mon Sep 17 00:00:00 2001 From: Thom Wiggers Date: Wed, 4 Dec 2024 11:00:34 +0100 Subject: [PATCH] Fix some unintentional changes --- .../templates/config.yaml.j2 | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2 b/roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2 index 6d91c90bc..fa9e52038 100644 --- a/roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2 @@ -41,6 +41,20 @@ homeserver: # Configuration specific to the IRC service ircService: + + # WARNING: The bridge needs to send plaintext passwords to the IRC server, it cannot + # send a password hash. As a result, passwords (NOT hashes) are stored encrypted in + # the database. + # + # To generate a .pem file: + # $ openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048 + # + # The path to the RSA PEM-formatted private key to use when encrypting IRC passwords + # for storage in the database. Passwords are stored by using the admin room command + # `!storepass example.com passw0rd. When a connection is made to IRC on behalf of + # the Matrix user, this password will be sent as the server password (PASS command). + passwordEncryptionKeyPath: "/data/passkey.pem" # does not typically need modification + # Config for Matrix -> IRC bridging matrixHandler: # Cache this many Matrix events in memory to be used for m.relates_to messages (usually replies). @@ -152,4 +166,4 @@ database: # Either a PostgreSQL connection string, or a path to the NeDB storage directory. # For postgres, it must start with postgres:// # For NeDB, it must start with nedb://. The path is relative to the project directory. - connectionString: {{ matrix_appservice_irc_database_connectionString + connectionString: {{ matrix_appservice_irc_database_connectionString | to_json }}