This is a fork of https://github.com/exec64/nanolist
nanolist is a lightweight mailing list manager written in Go. It’s easy to deploy, and easy to manage. It was written as an antithesis of the experience of setting up other mailing list software.
nanolist is controlled by emailing nanolist with a command in the subject.
The following commands are available:
help- Reply with a list of valid commands
lists- Reply with a list of available mailing lists
subscribe list-id- Subscribe to receive mail sent to the given list
unsubscribe list-id- Unsubscribe from receiving mail sent to the given list
Frequently Asked Questions
Is there a web interface?
No. If you’d like an online browsable archive of emails, look into tools such as hypermail or minbox, which generate HTML archives from a list of emails.
If you’d like to advertise the lists on your website, it’s recommended to do
that manually, in whatever way looks best. Subscribe buttons can be achieved
How do I integrate this with my preferred mail transfer agent?
Below are instructions for postfix and OpenSMTPD. The gist of it is: have your
mail server pipe emails for any mailing list addresses to
nanolist will handle any messages sent to it this way, and reply using the
configured SMTP server.
Why would anyone want this?
Some people prefer mailing lists for patch submission and review, some people want to play mailing-list based games such as nomic, and some people are just nostalgic.
First, you’ll need to build and install the nanolist binary:
git clone https://git.fusch.online/nanolist.git nanolist cd nanolist go build go install
Second, you’ll need to write a config to either
You can also specify a custom config file location by invoking nanolist
The contents of the config file should look like this:
# File for event and error logging. nanolist does not rotate its logs # automatically. Recommended path is /var/log/mail/nanolist # You'll need to set permissions on it depending on which account your # MTA runs nanolist as. log = /path/to/logfile # An sqlite3 database is used for storing the email addresses # subscribed to each mailing list. Recommended location is # /var/db/nanolist.db. You'll need to set permissions on it depending # on which account your MTA runs nanolist as. database = /path/to/sqlite/database # Address nanolist should receive user commands on command_address = firstname.lastname@example.org # SMTP details for sending mail smtp_hostname = "smtp.example.com" smtp_port = 25 smtp_username = "nanolist" smtp_password = "hunter2" # Create a [list.id] section for each mailing list. # The 'list.' prefix tells nanolist you're creating a mailing list. The # rest is the id of the mailing list. [list.golang] # Address this list should receieve mail on address = email@example.com # Information to show in the list of mailing lists name = "Go programming" description = "General discussion of Go programming" # bcc all posts to the listed addresses for archival bcc = firstname.lastname@example.org, email@example.com [list.announcements] address = firstname.lastname@example.org name = "Announcements" description = "Important announcements" # List of email addresses that are permitted to post to this list posters = email@example.com, firstname.lastname@example.org [list.fight-club] address = email@example.com # Don't tell users this list exists hidden = true # Only let subscribed users post to this list subscribers_only = true
Hook the desired incoming addresses to nanolist:
nanolist: "| /path/to/bin/nanolist message"
newaliases for the change to take effect.
This creates an alias that pipes messages sent to the
nanolist alias to the
The final step is telling your preferred MTA to route mail to this address when needed.
For postfix edit
/etc/postfix/aliases and add:
firstname.lastname@example.org nanolist email@example.com nanolist firstname.lastname@example.org nanolist email@example.com nanolist
and restart postfix.
OpenSMTPD (old syntax for linux systems)
This will run nanolist on messages received on the nanolist.example.com subdomain.
list: nanolist golang: nanolist announce: nanolist robertpaulson99: nanolist nanolist: nanolist
/etc/smtpd.conf (replacing $USER with the user you want to run nanolist
as) and add:
table nanolist file:/etc/nanolist/aliases accept from any for domain "nanolist.example.com" alias <nanolist> deliver to mda "/usr/bin/nanolist message" as $USER
newaliases for the change to take effect and restart OpenSMTPD.
Congratulations, you’ve now set up 3 mailing lists of your own!
nanolist is made available under the BSD-3-Clause license.