mail_crypt: Clarify base64-encoded keys

sirainen · Oct 30, 2024 · 1eb5e54 · 1eb5e54
1 parent 7aa8c5e
commit 1eb5e54
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/core/plugins/mail_crypt.md b/docs/core/plugins/mail_crypt.md
@@ -347,7 +347,8 @@ crypt_global_private_key main {
 ## Base64-encoded Keys
 
 Mail-crypt plugin can read keys that are base64 encoded. This is intended
-mostly for providing PEM keys via userdb.
+mostly for providing PEM keys via userdb, because it may be difficult to get
+userdb to return multi-line values.
 
 Hence, this is possible:
 
@@ -369,7 +370,7 @@ passdb static {
   password = pass
   fields {
     crypt_global_public_key_file = ecpubkey.pem
-    crypt_global_private_key/main/private_key_file = inline:<content of ecprivkey.pem>
+    crypt_global_private_key/main/private_key_file = inline:<base64-encoded content of ecprivkey.pem>
   }
 }
 ```