README: suggest ControlPath=$XDG_RUNTIME_DIR/ssh-imap-%C for the SSH transport

Not a good idea to use a world-writable directory, see ssh_config(5)…

Note that variable expansion is only available in OpenSSH 8.4 and later,
cf. https://bugzilla.mindrot.org/show_bug.cgi?id=3140 .

2 files changed, 4 insertions, 1 deletions

diff --git a/Changelog b/Changelog
index 196c01d..4bc426b 100644
--- a/Changelog
+++ b/Changelog
@@ -25,6 +25,9 @@ interimap (0.5.5) upstream;
  - documentation: simplify SSL options in the sample configuration files.
  - README: suggest 'restrict,command="/usr/bin/doveadm exec imap"' as
    authorized_keys(5) options.
+ - README: suggest ControlPath=$XDG_RUNTIME_DIR/ssh-imap-%C for the SSH
+   transport (note that variable expansion is only available in OpenSSH
+   8.4 and later).
 
  -- Guilhem Moulin <guilhem@fripost.org>  Fri, 11 Dec 2020 14:55:53 +0100
 
diff --git a/README b/README
index cee8443..d2b8942 100644
--- a/README
+++ b/README
@@ -59,7 +59,7 @@ type=imaps.
       Host imap.example.net
           IdentityFile ~/.ssh/id-interimap
           IdentitiesOnly yes
-          ControlPath /run/shm/%u@%n
+          ControlPath ${XDG_RUNTIME_DIR}/ssh-imap-%C
           ControlMaster auto
           ControlPersist 10m
           StrictHostKeyChecking yes