aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Phan <jason@ket.so>2020-11-02 12:37:33 -0600
committerDrew DeVault <sir@cmpwn.com>2020-11-17 09:56:08 -0500
commit09f3aec2549fd3b519ad0985491656dbbb65c732 (patch)
tree0d3fba8bc1c56d6b572f5e52562a7abf961a9ae0
parent61dff648826303a902d35f9dd641f0a8d501cbc0 (diff)
downloadsr.ht-docs-09f3aec2549fd3b519ad0985491656dbbb65c732.tar.gz
Update lists.sr.ht installation/config pages
-rw-r--r--lists.sr.ht/configuration.md54
-rw-r--r--lists.sr.ht/configuration_reference.md5
-rw-r--r--lists.sr.ht/installation.md67
3 files changed, 68 insertions, 58 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.
diff --git a/lists.sr.ht/configuration_reference.md b/lists.sr.ht/configuration_reference.md
new file mode 100644
index 0000000..28cf657
--- /dev/null
+++ b/lists.sr.ht/configuration_reference.md
@@ -0,0 +1,5 @@
+---
+title: lists.sr.ht Configuration Reference
+---
+
+This document covers the configuration options for the lists.sr.ht service.
diff --git a/lists.sr.ht/installation.md b/lists.sr.ht/installation.md
index da123ed..ad30830 100644
--- a/lists.sr.ht/installation.md
+++ b/lists.sr.ht/installation.md
@@ -1,67 +1,18 @@
---
-title: lists.sr.ht installation
+title: lists.sr.ht Installation
---
-lists.sr.ht is the mailing list service for lists.sr.ht.
+This document covers the installation steps for lists.sr.ht, a mailing list
+service.
# 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.
+lists.sr.ht can be installed with the [standard package
+installation process](/installation.md#installing-from-packages).
## 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. 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 setup
-
-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.
-
-## Celery worker installation
-
-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.
-
-# Hacking on lists.sr.ht
-
-A minimal local mail server setup which can be used to work on lists.sr.ht is
-described [in this article][article].
-
-[article]: https://drewdevault.com/2018/08/05/Local-mail-server.html
+- `lists.sr.ht` - The web service.
+- `lists.sr.ht-lmtp` - Incoming mail service.
+- `lists.sr.ht-process` - Mail processing service.
+- `lists.sr.ht-webhooks` - Webhook delivery service.