diff options
author | Gustav Eek <gustav.eek@fripost.org> | 2019-07-05 22:23:01 +0200 |
---|---|---|
committer | Guilhem Moulin <guilhem@fripost.org> | 2019-11-13 19:45:23 +0100 |
commit | a8479a847118a2713ec69cc1fb667e5214956637 (patch) | |
tree | 7cd9a0d43d6b5d5bdbc14d5bd103c548ac550da9 /doc/development.md | |
parent | cf99cc234d1b0b0a55ae83c06eacdf7ba1e973c6 (diff) |
Add "getting started" documentation.
Diffstat (limited to 'doc/development.md')
-rw-r--r-- | doc/development.md | 25 |
1 files changed, 9 insertions, 16 deletions
diff --git a/doc/development.md b/doc/development.md index 49e8d74..b5624f0 100644 --- a/doc/development.md +++ b/doc/development.md @@ -11,9 +11,6 @@ a new temporary directory: $ BASEDIR="$(mktemp --tmpdir --directory)" -(The leading `$ ` in this document are command-line prompt strings, and -are not part of the command themselves.) - Dovecot configuration ===================== @@ -26,7 +23,7 @@ will be skipped). log_path = "$BASEDIR/dovecot.log" ssl = no mail_home = "$BASEDIR/%u" - mail_location = maildir:~/mail + mail_location = maildir:~/Mail EOF Here are some details on the above: @@ -37,11 +34,6 @@ Here are some details on the above: It's annoying to clutter syslog with test entries, so instead we make it log to a file under `$BASEDIR`. -`ssl` - - : Not required, but turned off here so dumping the configuration with - `` `doveconf -c "$BASEDIR/dovecot.conf" -n` `` doesn't spew a warning. - `mail_home` : Dovecot needs the name of the user to (pre-)authenticate. It is shown @@ -67,7 +59,7 @@ Here are some details on the above: `mail_location` : The user's mail storage resides — in [Maildir](https://wiki.dovecot.org/MailLocation/Maildir) - format — in a directory `mail` under their home directory. This is + format — in a directory `Mail` under their home directory. This is enough if you're fine with the default IMAP hierarchy delimiter (which depends on the mail format) is used, and if you need a single [IMAP namespace](https://tools.ietf.org/html/rfc2342). For more @@ -84,12 +76,13 @@ pre-authenticated [IMAP4rev1] in the test environment for username $ env -i PATH="/usr/bin:/bin" USER="testuser" \ doveadm -c "$BASEDIR/dovecot.conf" exec imap - * PREAUTH [CAPABILITY IMAP4rev1 …] Logged in as testuser - a LIST "" "*" - * LIST (\HasNoChildren) "." INBOX - a OK List completed (0.002 + 0.000 + 0.001 secs). - q LOGOUT - q OK Logout completed (0.001 + 0.000 secs). + S: * PREAUTH [CAPABILITY IMAP4rev1 …] Logged in as testuser + C: a LIST "" "*" + S: * LIST (\HasNoChildren) "." INBOX + S: a OK List completed (0.002 + 0.000 + 0.001 secs). + C: q LOGOUT + S: * BYE Logging out + S: q OK Logout completed (0.001 + 0.000 secs). For mailbox (create, delete, rename) and message (add, flag update) manipulation you can use your mail client, the relevant [IMAP4rev1] |