Skip to content

Commit fb3dca7

Browse files
committed
Fix some unintentional changes
1 parent 294590e commit fb3dca7

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,20 @@ homeserver:
4141

4242
# Configuration specific to the IRC service
4343
ircService:
44+
45+
# WARNING: The bridge needs to send plaintext passwords to the IRC server, it cannot
46+
# send a password hash. As a result, passwords (NOT hashes) are stored encrypted in
47+
# the database.
48+
#
49+
# To generate a .pem file:
50+
# $ openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048
51+
#
52+
# The path to the RSA PEM-formatted private key to use when encrypting IRC passwords
53+
# for storage in the database. Passwords are stored by using the admin room command
54+
# `!storepass example.com passw0rd. When a connection is made to IRC on behalf of
55+
# the Matrix user, this password will be sent as the server password (PASS command).
56+
passwordEncryptionKeyPath: "/data/passkey.pem" # does not typically need modification
57+
4458
# Config for Matrix -> IRC bridging
4559
matrixHandler:
4660
# Cache this many Matrix events in memory to be used for m.relates_to messages (usually replies).
@@ -152,4 +166,4 @@ database:
152166
# Either a PostgreSQL connection string, or a path to the NeDB storage directory.
153167
# For postgres, it must start with postgres://
154168
# For NeDB, it must start with nedb://. The path is relative to the project directory.
155-
connectionString: {{ matrix_appservice_irc_database_connectionString
169+
connectionString: {{ matrix_appservice_irc_database_connectionString | to_json }}

0 commit comments

Comments
 (0)