Go to file
KiekerJan 6d3d2ceb82 store munin files in MiaB storage dir 2022-12-05 15:38:36 +01:00
.github/workflows Create codeql-analysis.yml 2021-08-16 11:53:31 +02:00
api First steps in migrating to dkimpy-milter 2021-12-11 00:54:56 +01:00
conf merge master 2022-09-17 16:53:08 +02:00
management Merge pull request #15 from hughsw/add-custom-rsync-port 2022-11-28 20:30:24 +01:00
setup store munin files in MiaB storage dir 2022-12-05 15:38:36 +01:00
tests merge upstream 2022-10-15 16:38:47 +02:00
tools merge upstream changes proposed for 2204 2022-09-17 16:41:35 +02:00
.editorconfig Use correct setting for .editorconfig indent_style (#1670) 2019-11-03 13:31:29 -05:00
.gitignore Add OpenAPI HTTP spec (#1804) 2020-08-22 15:44:19 -04:00
CHANGELOG.md merge upstream 60.1 2022-10-30 23:01:19 +01:00
CODE_OF_CONDUCT.md some improvements suggested by the community 2016-08-15 20:09:05 -04:00
CONTRIBUTING.md merge master 2022-02-02 12:15:22 +01:00
LICENSE add CC0 1.0 Universal in LICENSE 2014-04-23 15:49:23 -04:00
README.md merge upstream 60.1 2022-10-30 23:01:19 +01:00
Vagrantfile merge prelim 22.04 changes from upstream 2022-02-16 23:32:30 +01:00
security.md Updates to security.md 2021-10-23 08:57:05 -04:00

README.md

Modifications are go

This is not the original Mail-in-a-Box. See https://github.com/mail-in-a-box/mailinabox for the real deal! Many thanks to @JoshData and other contributors. I made a number of modifications to the original Mail-in-a-Box, some to fix bugs, some to ease maintenance for my personal installation, to learn and to add functionality.

Functionality changes and additions

  • Change installation target to Ubuntu 22.04.
  • Add geoipblocking on the admin web console
    This applies geoip filtering on acces to the admin panel of the box. Order of filtering: block continents that are not allowed, block countries that are not allowed, allow countries that are allowed (overriding continent filtering). Edit /etc/nginx/conf.d/10-geoblock.conf to configure.
  • Add geoipblocking for ssh access
    This applies geoip filtering for access to the ssh server. Edit /etc/geoiplookup.conf. All countries defined in this file are allowed. Works for alternate ssh ports.
    This uses goiplookup from https://github.com/axllent/goiplookup
  • Make fail2ban more strict
    enable postfix filters, lengthen bantime and findtime
  • Add fail2ban jails for both above mentioned geoipblocking filters
  • Add fail2ban filters for web scanners and badbots
  • Add xapian full text searching to dovecot (from https://github.com/grosjo/fts-xapian)
  • Add rkhunter
  • Configure domain names for which only www will be hosted
    Edit /etc/miabwwwdomains.conf to configure. The box will handle incoming traffic asking for these domain names. The DNS entries are entered in an external DNS provider! If you want this box to handle the DNS entries, simply add a mail alias. (existing functionality of the vanilla Mail-in-a-Box)
  • Add some munin plugins
  • Update nextcloud to 24.0.0 And updated apps
  • Add nextcloud notes app
  • Add roundcube context menu plugin
  • Add roundcube two factor authentication plugin
  • Use shorter TTL values in the DNS server
    To be used before for example when changing IP addresses. Shortening TTL values will propagate changes faster. For reference, default TTL is 1 day, short TTL is 5 minutes. To use, edit file /etc/forceshortdnsttl and add a line for each domain for which shorter TTLs should be used. To use short TTLs for all known domains, add "forceshortdnsttl"
  • Use the box as a Hidden Master in the DNS system
    Thus only the secondary DNS servers are used as public DNS servers. When using a hidden master, no glue records are necessary at your domain hoster. To use, first setup secondary DNS servers via the Custom DNS administration page. At least two secondary servers should be set. When that functions, edit file /etc/usehiddenmasterdns and add a line for each domain for which Hidden Master should be used. To use Hidden Master for all known domains, add "usehiddenmasterdns".
  • Daily ip blacklist check
    Using check-dnsbl.py from https://github.com/gsauthof/utility
  • Updated ssl security for web and email
    Removed older cryptos following internet.nl recommendations
  • Replace opendkim with dkimpy (https://launchpad.net/dkimpy-milter) Added support for Ed25519 signing
  • Replace bind9 with unbound DNS resolver
  • Make backup target folder configurable set BACKUP_ROOT to the backup target folder (default is same as STORAGE_ROOT)

Bug fixes

Maintenance (personal)

  • Automatically clean spam and trash folders after 120 days
  • Removed Z-Push
  • After a backup, restarting of services is moved to before the execution of the after-backup script. This enables mail delivery while the after-backup script runs.
  • Add weekly pflogsumm log analysis
  • Enable mail delivery to root, forwarded to administrator
  • Remove nextcloud skeleton to save disk space

Fun

  • Add option to define ADMIN_IP_ADDRESS
    Currently only used to ignore fail2ban jails
  • Add dynamic dns tools in the tools directory
    Can be used to control DNS entries on the mail-in-a-box to point to a machine with a non-fixed (e.g. residential) ip address

Original mailinabox content starts here:

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.

In The Box

Mail-in-a-Box turns a fresh Ubuntu 22.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:

It also includes system management tools:

  • Comprehensive health monitoring that checks each day that services are running, ports are open, TLS certificates are valid, and DNS records are correct
  • A control panel for adding/removing mail users, aliases, custom DNS records, configuring backups, etc.
  • An API for all of the actions on the control panel

Internationalized domain names are supported and configured easily (but SMTPUTF8 is not supported, unfortunately).

It also supports static website hosting since the box is serving HTTPS anyway. (To serve a website for your domains elsewhere, just add a custom DNS "A" record in you Mail-in-a-Box's control panel to point domains to another server.)

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 22.04 LTS 64-bit machine. On the machine...

Clone this repository and checkout the tag corresponding to the most recent release:

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

Begin the installation.

$ sudo setup/start.sh

The installation will install, uninstall, and configure packages to turn the machine into a working, good mail server.

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

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

Note that while we want everything to "just work," we can't control the rest of the Internet. Other mail services might block or spam-filter email sent from your Mail-in-a-Box. This is a challenge faced by everyone who runs their own mail server, with or without Mail-in-a-Box. See our discussion forum for tips about that.

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.