diff options
author | Jason Phan <jason@ket.so> | 2020-11-02 12:37:33 -0600 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2020-11-17 09:56:08 -0500 |
commit | 09f3aec2549fd3b519ad0985491656dbbb65c732 (patch) | |
tree | 0d3fba8bc1c56d6b572f5e52562a7abf961a9ae0 /lists.sr.ht/configuration.md | |
parent | 61dff648826303a902d35f9dd641f0a8d501cbc0 (diff) | |
download | sr.ht-docs-09f3aec2549fd3b519ad0985491656dbbb65c732.tar.gz |
Update lists.sr.ht installation/config pages
Diffstat (limited to 'lists.sr.ht/configuration.md')
-rw-r--r-- | lists.sr.ht/configuration.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/lists.sr.ht/configuration.md b/lists.sr.ht/configuration.md new file mode 100644 index 0000000..41f9a80 --- /dev/null +++ b/lists.sr.ht/configuration.md @@ -0,0 +1,54 @@ +--- +title: lists.sr.ht Configuration +--- + +This document covers the configuration process for lists.sr.ht. + +# LMTP daemon installation + +The LMTP daemon is available in the `lists.sr.ht` package, at the binary +`lists-srht-lmtp`. It needs to run on your mail server, and you need to +configure your MTA to forward emails to it. Alternatively, it may be configured +to accept SMTP and run on another server. See `config.ini` for details. + +The LMTP daemon uses the same config file as the others, and there are some +options there specifically catered to it. The most important is the Unix socket +path for the LMTP socket - and the user/group it should be assigned to. Make +sure that this is readable and writable by your MTA. + +Enable the `lists.sr.ht-lmtp` service and configure your MTA to forward emails +to the socket. + +# Mail Server + +The precise configuration of your mail server is a very subjective matter, and +we don't have a one-size-fits-all solution to give you. Here's an example of +forwarding to lists.sr.ht with postfix: + + # main.cf + local_transport = local:$myhostname + transport_maps = hash:/etc/postfix/transport + + # /etc/postfix/transport + lists.sr.ht lmtp:unix:/tmp/lists.sr.ht-lmtp.sock + sr.ht local:sr.ht + +This forwards mail to @lists.sr.ht to the LMTP socket, and processes mail to +@sr.ht to local mailboxes. This is just one part of your setup, however, and +the remainder of your postfix (or other mail server) configuration is left as +an exercise to the reader. + +<div class="alert alert-info"> + <strong>Note:</strong> A minimal, local mail server setup which can be used + to work on lists.sr.ht is described in this + <a href="https://drewdevault.com/2018/08/05/Local-mail-server.html" + class="alert-link">article</a>. +</div> + +# Celery Worker + +On servers which should process forwarding and archival, install the +`lists.sr.ht` package and enable the `lists.sr.ht-process` service. Make sure +you review the config file for worker-specific options as well. The Redis +instance you use here should be shared with the LMTP daemon and other worker +nodes to ensure that messages can be distributed correctly. |