sr.ht-docs/lists.sr.ht/installation.md -rw-r--r-- 2.4 KiB
1406791aDrew DeVault ops/scale.md: drop (obsolete) disk usage info 4 days ago

#title: lists.sr.ht installation

lists.sr.ht is the mailing list service for lists.sr.ht.


lists.sr.ht is a standard sr.ht web service and can be installed through the standard procedure. However, there are several additional steps required.


  • 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.