mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-06 06:27:38 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: Move *-only.md tutorials to their own section

Browse source
This commit is contained in:
fox.cpp 2020-07-18 11:42:13 +03:00
parent d6105aed26
commit 03ff67069e
No known key found for this signature in database
GPG key ID: 5B991F6215D2FCC0
3 changed files with 6 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

60
docs/tutorials/imap-only.md
View file

@ -1,60 +0,0 @@
# Using maddy with an external SMTP server
It is possible to use maddy as an IMAP server only
and have it interface with external SMTP server using
standard protocols.
Here is the minimal configuration that creates
a local IMAP index, credentials database and IMAP
endpoint:
```
# Credentials DB.
pass_table local_authdb {
table sql_table {
driver sqlite3
dsn credentials.db
table_name passwords
}
}
# IMAP storage/index.
imapsql local_mailboxes {
driver sqlite3
dsn imapsql.db
}
# IMAP endpoint using these above.
imap tls://0.0.0.0:993 tcp://0.0.0.0:143 {
auth &local_authdb
storage &local_mailboxes
}
```
To accept local messages from an external SMTP server
it is possible to create an LMTP endpoint:
```
# LMTP endpoint on Unix socket delivering to IMAP storage
# in previous config snippet.
lmtp unix:/run/maddy/lmtp.sock {
hostname mx.maddy.test
deliver_to &local_mailboxes
}
```
Look up documentation for your SMTP server on how to make it
send messages using LMTP to /run/maddy/lmtp.sock.
To handle authentiation for Submission (client-server SMTP) SMTP server
needs to access credentials database used by maddy. maddy implements
server side of Dovecot authentication protocol so you can use
it if SMTP server implements "Dovecot SASL" client.
To create a Dovecot-compatible sasld endpoint, add the following configuration
block:
```
# Dovecot-compatible sasld endpoint using data from local_authdb.
dovecot_sasld unix:/run/maddy/auth-client.sock {
auth &local_authdb
}
```

92
docs/tutorials/smtp-only.md
View file

@ -1,92 +0,0 @@
# Using maddy with an external IMAP server
Builtin maddy IMAP server may not match your requirements in terms of
performance, reliabilty or anything. For this reason it is possible to
integrate it with any external IMAP server that implements necessary
protocols.
## Dovecot
It is possible to replace builtin IMAP server with Dovecot.
Here are necessary bits to change in configuration.
1. Get rid of `imap` endpoint and existing `local_authdb` and `local_mailboxes`
blocks.
2. Setup Dovecot to provide LMTP endpoint
Here is an example configuration snippet:
```
# /etc/dovecot/dovecot.conf
protocols = imap lmtp
# /etc/dovecot/conf.d/10-master.conf
service lmtp {
unix_listener /var/run/maddy/dovecot-lmtp.sock {
mode = 0600
user = maddy
}
}
```
Add `local_mailboxes` block to maddy config using `target.lmtp` module:
```
target.lmtp local_mailboxes {
targets unix:///var/run/maddy/dovecot-lmtp.sock
}
```
### Authentication
In addition to MTA service, maddy also provides Submission service, but it
needs authentication provider data to work correctly, maddy can use Dovecot
SASL authentication protocol for it.
You need the following in Dovecot's `10-master.conf`:
```
service auth {
unix_listener auth-maddy-client {
mode = 0660
user = maddy
}
}
```
Then just configure `dovecot_sasl` module for `submission`:
```
submission ... {
auth dovecot_sasl unix:///var/run/dovecot/auth-client
... other configuration ...
}
```
## Other IMAP servers
Integration with other IMAP servers might be more problematic because there is
no standard protocol for authentication delegation. You might need to configure
the IMAP server to implement MSA functionality by forwarding messages to maddy
for outbound delivery. This might require more configuration changes on maddy
side since by default it will not allow relay on port 25 even for localhost
addresses. The easiest way is to create another SMTP endpoint on some port
(probably Submission port):
```
smtp tcp://127.0.0.1:587 {
deliver_to &remote_queue
}
```
And configure IMAP servers's Submission service to forward outbound messages
there.
Depending on how Submission service is implemented you may also need to route
messages for local domains back to it via LMTP:
```
smtp tcp://127.0.0.1:587 {
destination $(local_domains) {
deliver_to &local_mailboxes
}
default_destination {
deliver_to &remote_queue
}
}
```