diff options
| author | Drew DeVault <sir@cmpwn.com> | 2020-03-26 10:21:05 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2020-03-26 10:21:05 -0400 |
| commit | e62d312b36d5816b6ccfe7e23d04bf55d9425d38 (patch) | |
| tree | 2199e1ccf8c4a49240d726f3d72067242a5f360d /lists.sr.ht | |
| parent | ef4f23fae41c927a529352a5e9f31a4d9b7346d9 (diff) | |
| download | sr.ht-docs-e62d312b36d5816b6ccfe7e23d04bf55d9425d38.tar.gz | |
Overhaul installation documentation
Diffstat (limited to 'lists.sr.ht')
| -rw-r--r-- | lists.sr.ht/installation.md | 43 |
1 files changed, 21 insertions, 22 deletions
diff --git a/lists.sr.ht/installation.md b/lists.sr.ht/installation.md index 66f83fc..da123ed 100644 --- a/lists.sr.ht/installation.md +++ b/lists.sr.ht/installation.md @@ -2,23 +2,27 @@ title: lists.sr.ht installation --- -lists.sr.ht is the mailing list service for lists.sr.ht. There are a number of -important components: +lists.sr.ht is the mailing list service for lists.sr.ht. -- The **LMTP daemon**, which receives incoming email from a separate mail - server (e.g. postfix), does minimal processing & validation, and - dispatches it to the **celery worker**. -- The **celery worker** is distributed on as many cores and/or servers as you - like and can take its time processing emails. It's responsible for forwarwding - and archiving emails. -- The **web interface** displays the archive, manages subscriptions, etc, on the - web. +# Installation -# LMTP daemon installation +lists.sr.ht is a standard sr.ht web service and can be installed through the +[standard procedure](/installation.md). However, there are several additional +steps required. + +## Daemons + +- `lists.sr.ht`: the web service +- `lists.sr.ht-webhooks`: webhook delivery service +- `lists.sr.ht-lmtp`: incoming mail delivery service +- `lists.sr.ht-process`: mail processing service + +## 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. +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 @@ -47,18 +51,13 @@ This forwards mail to @lists.sr.ht to the LMTP socket, and processes mail to remainder of your postfix (or other mail server) configuration is left as an exercise to the reader. -# Celery worker installation +## Celery worker installation On servers which should process forwarding and archival, install the -`lists.sr.ht` package and enable the `lists.sr.ht-worker` 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. - -# Web service installation - -The lists.sr.ht web service is a standard sr.ht web service and can be installed -through the [standard procedure](/installation.md). +`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. # Hacking on lists.sr.ht |