Go to file
Joshua Tauberer 8bd62aa3bc increase duplicity's volume size from the default of 25MB to 100MB so we create fewer files 2014-06-09 13:47:41 +00:00
conf Filter privacy-sensitive headers on outgoing mail 2014-06-08 18:35:09 -04:00
docs rename the scripts directory to setup 2014-06-03 11:12:38 +00:00
management increase duplicity's volume size from the default of 25MB to 100MB so we create fewer files 2014-06-09 13:47:41 +00:00
notes notes for setting up dspam, but it crashed a lot so I'm not using it 2013-08-23 12:03:26 -04:00
setup re-do the backup script to use the duplicity program 2014-06-09 09:34:52 -04:00
tests fix shebang lines in the tests to take advantage of any activated python environment 2014-06-08 17:31:12 -04:00
tools use editconf.py to mangle /etc/postfix/master.cf 2014-06-08 17:31:12 -04:00
.gitignore move management into a daemon service running as root 2014-06-03 13:56:40 +00:00
CONTRIBUTING.md adding CONTRIBUTING.md, see #23 2014-04-23 15:52:49 -04:00
LICENSE add CC0 1.0 Universal in LICENSE 2014-04-23 15:49:23 -04:00
README.md rename the scripts directory to setup 2014-06-03 11:12:38 +00:00
Vagrantfile Support dual-stack IPv4/IPv6 mail servers 2014-06-08 18:32:52 -04:00

README.md

Mail-in-a-Box

Mail-in-a-Box helps individuals take back control of their email by defining a one-click, easy-to-deploy SMTP+everything else server: a mail server in a box.

This is a work in progress. I work on this in my limited free time.

Why build this? Mass electronic surveillance by governments revealed over the last year has spurred a new movement to re-decentralize the web, that is, to empower netizens to be their own service providers again. SMTP, the protocol of email, is decentralized in principle but highly centralized in practice due to the high cost of implementing all of the modern protocols that surround it. As a result, most individuals trade their independence for access to a “free” email service.

The Box

Mail-in-a-Box turns a fresh Ubuntu 14.04 LTS 64-bit machine into a working mail server, including:

  • An SMTP server for sending/receiving mail, with STARTTLS required for authentication, and greylisting to cut down on spam (postfix, postgrey).
  • An IMAP server for checking your mail, with SSL required (dovecot).
  • A webmail client over SSL so you can check your email from a web browser (roundcube, nginx).
  • Spam filtering with spam automatically going to your Spam folder (spamassassin).
  • DKIM signing on outgoing messages (opendkim).
  • The machine acts as its own DNS server and is automatically configured for SPF and DKIM (nsd).
  • Configuration of mailboxes and mail aliases is done using a command-line tool.
  • Basic system services like a firewall, intrusion protection, and setting the system clock are automatically configured (ufw, fail2ban, ntp).

This setup is what has been powering my own personal email since September 2013.

Please see the initial and very barebones Documentation for more information on how to set up a Mail-in-a-Box. But in short, it's like this:

# do this on a fresh install of Ubuntu 14.04 only!
sudo apt-get install -y git
git clone https://github.com/joshdata/mailinabox
cd mailinabox
sudo setup/start.sh

Status: This is a work in progress. It works for what it is, but it is missing such things as quotas, backup/restore, etc.

The Goals

  • Create a push-button "Email Appliance" for everyday users.
  • Promote decentralization, innovation, and privacy on the web.
  • Have automated, auditable, and idempotent configuration.

For more background, see The Rationale.

What I am not trying to do:

  • Not to be a mail server that the NSA cannot hack.
  • Not to be customizable by power users.

The Acknowledgements

This project was inspired in part by the "NSA-proof your email in 2 hours" blog post by Drew Crawford, Sovereign by Alex Payne, and conversations with @shevski, @konklone, and @GregElin.

Mail-in-a-Box is similar to iRedMail.

The History

  • In 2007 I wrote a relatively popular Mozilla Thunderbird extension that added client-side SPF and DKIM checks to mail to warn users about possible phishing: add-on page, source.
  • On March 13, 2014 I submitted Mail-in-a-Box to the Knight News Challenge.