have the README refer to the website for details

This commit is contained in:
Joshua Tauberer 2014-07-06 11:31:11 -04:00
parent 49d5561933
commit 05664f0a3b
1 changed files with 4 additions and 11 deletions

View File

@ -11,20 +11,13 @@ Why build this? Mass electronic surveillance by governments revealed over the la
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](http://www.postfix.org/) for sending/receiving mail, with STARTTLS required to protect your password and [opportunistic TLS](https://en.wikipedia.org/wiki/Opportunistic_encryption) to prevent mass surveillance.
* An [IMAP server](http://dovecot.org/) for checking your mail, with SSL/TLS required to protect your password.
* [Webmail](http://roundcube.net/) over HTTPS so you can check your email from any web browser.
* [Spam filtering](https://spamassassin.apache.org/) that puts spam into a spam folder and [greylisting](http://postgrey.schweikert.ch/) to stop spam as it arrives.
* [SPF](https://en.wikipedia.org/wiki/Sender_Policy_Framework), [DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail), and [DMARC](https://en.wikipedia.org/wiki/DMARC) to prove to recipients that your email was from you --- the machine acts as its own DNS nameserver to automatically set this up.
* [DNSSEC](https://en.wikipedia.org/wiki/DNSSEC) and [DANE TLSA](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities) to force cryptographically-secure communications in certain cases, especially between Mail-in-a-Boxes, if you add "DS" records to your domain registration.
* A command-line tool and an HTTP-based API for administering mailboxes and mail aliases.
* Basic system services like a firewall, intrusion protection, and setting the system clock.
Mail-in-a-Box turns a fresh Ubuntu 14.04 LTS 64-bit machine into a working mail server, including [SMTP](http://www.postfix.org/), [IMAP](http://dovecot.org/), [webmail](http://roundcube.net/), [spam filtering](https://spamassassin.apache.org/), [greylisting](http://postgrey.schweikert.ch/), DNS, [SPF](https://en.wikipedia.org/wiki/Sender_Policy_Framework), [DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail), [DMARC](https://en.wikipedia.org/wiki/DMARC), [DNSSEC](https://en.wikipedia.org/wiki/DNSSEC), [DANE TLSA](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities), and basic system services like a firewall, intrusion protection, and setting the system clock.
This setup is what has been powering my own personal email since September 2013.
Please see the initial and very barebones [Documentation](docs/index.md) for more information on how to set up a Mail-in-a-Box. But in short, it's like this:
Please see [mailinabox.email](https://mailinabox.email) for more information and how to set up a Mail-in-a-Box.
In short, it's like this:
# do this on a fresh install of Ubuntu 14.04 only!
sudo apt-get install -y git