mirror of https://github.com/mail-in-a-box/mailinabox.git synced 2024-12-25 07:47:05 +00:00

Go to file

Joshua Tauberer 870b82637a fix some wrong variable names, fixes #1353		2018-11-30 10:46:54 -05:00
conf	fixes nginx warning about duplicate ssl configuration (#1460 )	2018-10-25 15:18:21 -04:00
management	fix some wrong variable names, fixes #1353	2018-11-30 10:46:54 -05:00
ppa	update PPA build URL for postgrey 1.35. Fixes #1211 (#1212 )	2017-07-21 15:13:57 -04:00
setup	turn on bash strict mode to better catch setup errors	2018-11-30 10:46:54 -05:00
tests	fix some wrong variable names, fixes #1353	2018-11-30 10:46:54 -05:00
tools	update to PHP 7.2	2018-10-03 13:00:15 -04:00
.editorconfig	added editorconfig setup (#1037 )	2017-01-15 10:44:13 -05:00
.gitignore	adding a fully qualified domain name for the hostname and ignoring the .vagrant dir (#1027 )	2016-12-20 16:32:06 -05:00
CHANGELOG.md	minimal changeset to get things working on 18.04	2018-10-03 13:00:06 -04:00
CODE_OF_CONDUCT.md	some improvements suggested by the community	2016-08-15 20:09:05 -04:00
CONTRIBUTING.md	Add some development instructions to CONTRIBUTING.md (#1348 )	2018-02-05 08:41:19 -05:00
LICENSE	add CC0 1.0 Universal in LICENSE	2014-04-23 15:49:23 -04:00
README.md	update reference to Ubuntu 14.04 to 18.04 in README.md and security.md and drop mentions of our custom packages that we no longer maintain	2018-10-03 13:00:15 -04:00
security.md	update reference to Ubuntu 14.04 to 18.04 in README.md and security.md and drop mentions of our custom packages that we no longer maintain	2018-10-03 13:00:15 -04:00
Vagrantfile	minimal changeset to get things working on 18.04	2018-10-03 13:00:06 -04:00

README.md

Mail-in-a-Box

By @JoshData and contributors.

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.

Please see https://mailinabox.email for the project's website and setup guide!

Our goals are to:

Make deploying a good mail server easy.
Promote decentralization, innovation, and privacy on the web.
Have automated, auditable, and idempotent configuration.
Not make a totally unhackable, NSA-proof server.
Not make something customizable by power users.

Additionally, this project has a Code of Conduct, which supersedes the goals above. Please review it when joining our community.

The Box

Mail-in-a-Box turns a fresh Ubuntu 18.04 LTS 64-bit machine into a working mail server by installing and configuring various components.

It is a one-click email appliance. There are no user-configurable setup options. It "just works".

The components installed are:

SMTP (postfix), IMAP (dovecot), CardDAV/CalDAV (Nextcloud), Exchange ActiveSync (z-push)
Webmail (Roundcube), static website hosting (nginx)
Spam filtering (spamassassin), greylisting (postgrey)
DNS (nsd4) with SPF, DKIM (OpenDKIM), DMARC, DNSSEC, DANE TLSA, and SSHFP records automatically set
Backups (duplicity), firewall (ufw), intrusion protection (fail2ban), system monitoring (munin)

It also includes:

A control panel and API for adding/removing mail users, aliases, custom DNS records, etc. and detailed system monitoring.

For more information on how Mail-in-a-Box handles your privacy, see the security details page.

Installation

See the setup guide for detailed, user-friendly instructions.

For experts, start with a completely fresh (really, I mean it) Ubuntu 18.04 LTS 64-bit machine. On the machine...

Clone this repository:

$ git clone https://github.com/mail-in-a-box/mailinabox
$ cd mailinabox

Optional: Download my PGP key and then verify that the sources were signed by me:

$ curl -s https://keybase.io/joshdata/key.asc | gpg --import
gpg: key C10BDD81: public key "Joshua Tauberer <jt@occams.info>" imported

$ git verify-tag v0.28
gpg: Signature made ..... using RSA key ID C10BDD81
gpg: Good signature from "Joshua Tauberer <jt@occams.info>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 5F4C 0E73 13CC D744 693B  2AEA B920 41F4 C10B DD81

You'll get a lot of warnings, but that's OK. Check that the primary key fingerprint matches the fingerprint in the key details at https://keybase.io/joshdata and on my personal homepage. (Of course, if this repository has been compromised you can't trust these instructions.)

Checkout the tag corresponding to the most recent release:

$ git checkout v0.28

Begin the installation.

$ sudo setup/start.sh

For help, DO NOT contact me directly --- I don't do tech support by email or tweet (no exceptions).

Post your question on the discussion forum instead, where me and other Mail-in-a-Box users may be able to help you.

Contributing and Development

Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome. See CONTRIBUTING to get started.

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 and Modoboa.

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.
In August 2013 I began Mail-in-a-Box by combining my own mail server configuration with the setup in "NSA-proof your email in 2 hours" and making the setup steps reproducible with bash scripts.
Mail-in-a-Box was a semifinalist in the 2014 Knight News Challenge, but it was not selected as a winner.
Mail-in-a-Box hit the front page of Hacker News in April 2014, September 2014, May 2015, and November 2016.
FastCompany mentioned Mail-in-a-Box a roundup of privacy projects on June 26, 2015.