aboutsummaryrefslogtreecommitdiffstats
path: root/doc/getting-started.md
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2019-12-13 20:31:27 +0100
committerGuilhem Moulin <guilhem@fripost.org>2019-12-13 20:31:27 +0100
commit443faa349a8b7691f98df7e88101d2115386ba39 (patch)
tree08856f6c2a76e8212468108426101c13f9d9beba /doc/getting-started.md
parent9fc54714f768fa77895f8a9d9b56f6c5c833ea8c (diff)
parentccb2ef57e36b0fa3a5e02de710d5b763a9472646 (diff)
Merge branch 'master' into debian
Diffstat (limited to 'doc/getting-started.md')
-rw-r--r--doc/getting-started.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/getting-started.md b/doc/getting-started.md
index 9499cbb..da8f116 100644
--- a/doc/getting-started.md
+++ b/doc/getting-started.md
@@ -102,7 +102,6 @@ Dovecot configuration:
mail_location = maildir:~/Mail
namespace {
inbox = yes
- list = yes
separator = /
}
EOF
@@ -181,23 +180,27 @@ for the sake of clarity we start from an empty file here.
# ignore the mailbox named 'virtual' and its descendants
# WARN: for version 0.4 and earlier it should be ^virtual(?:/|$)
ignore-mailbox = ^virtual(?:\x00|$)
-
EOF
2. Next, append a `[local]` section pointing to the wrapper defined
above:
$ cat >>${XDG_CONFIG_HOME:-~/.config}/interimap/config <<-EOF
+
[local]
type = tunnel
command = exec ~/.local/bin/dovecot-imap
-
EOF
+ (The command will be passed to `` `/bin/sh -c` `` as it contains
+ the metacharacter `~`. We use the `exec` built-in utility so the
+ shell process doesn't linger around during the IMAP session.)
+
3. And finally append a `[remote]` section with your account
information at `imap.example.org` (adapt the values accordingly):
$ cat >>${XDG_CONFIG_HOME:-~/.config}/interimap/config <<-EOF
+
[remote]
type = imaps
host = imap.example.net
@@ -219,7 +222,7 @@ synchronize.
A user unit for systemd is provided. Run the following command to
enable and start the service:
- $ systemctl --user enable --now interimap
+ $ systemctl --user enable --now interimap.service
By default the connection to the IMAP servers remains open, and a status
update is requested every minute. Thanks to the [`QRESYNC`][RFC 7162]
@@ -240,7 +243,7 @@ updates to 20s:
<!-- -->
$ systemctl --user daemon-reload
<!-- -->
- $ systemctl --user restart interimap
+ $ systemctl --user restart interimap.service
Email client configuration
@@ -263,7 +266,7 @@ Further Reading and Resources
Other use-cases:
-: *TODO*
+: [Multi-remote setup](multi-account.html)
Benchmarks: