/mailinabox-extra

Mail-in-a-Box with some extra features

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

Mail-in-a-Box Extra

This is an experimental implementation of Mail-in-a-box with the following additional features:

  • Quotas -- has the same quota support as MiaB with quotas.

  • Mailgraph -- display statistics for your mail server

  • Postgrey Off -- ability to turn off postgrey support

  • Policy SPF -- ability to turn on SPF checks for incoming mail

Quotas can be set and viewed in the control panel

To set quotas from the command line, use:

tools/mail.py user quota <email> <quota>

To set the system default quota for new users, use:

tools/mail.py system default-quota <quota>

Mailbox size recalculation by Dovecot can be forced using the command:

doveadm quota recalc -A

Please report any bugs on github.

Installing v0.4x-extra

To install the latest version, log into your box and execute the following commands:

$ git clone https://github.com/uksitebuilder/mailinabox-extra.git mailinabox
$ cd mailinabox
$ sudo bash setup/bootstrap.sh

Follow the standard directions for setting up an MiaB installation. There are no special installation steps for installing this version.

The default quota is set to 0 which means unlimited. If you want to set a different default quota, follow the directions above.

Upgrading v0.4x to v.0.4x-extra

  • Rename your mailinabox directory to something like miab.old

  • Clone this repository using:

    git clone https://github.com/ukitebuilder/mailinabox-extra.git mailinabox

  • cd into mailinabox and run sudo bash setup/bootstrap.sh On occasion there are lock errors when updating Munin. Just re-run sudo setup/start.sh until the error does not occur.

  • Note: all existing users at the time of the upgrade will have there quota set to 0 (unlimited).

Upgrading MiaB extra to a New Version

  • cd into the mailinabox directory.

  • Execute git pull to download the latest changes.

  • Execute sudo bash setup/bootstrap.sh to checkout the latest version and re-run setup.

Issues

  • When a user's quota is changed, any IMAP session running for that user will not recognize the new quota. To solve this a dovecot reload could be issued causing all current IMAP sessions to be terminated. On a system with many users, it might not be desirable to reset all users sessions to fix the quota for one user. Also if the administrator is setting the quota for several users it would result in the continual reset of those connections.

Changes

v0.57a-extra-0.14-beta

  • Update to mail-in-a-box v57a

v0.55-extra-0.14-beta

  • Update to mail-in-a-box v55

v0.53-extra-0.14-beta

  • Update to mail-in-a-box v0.53

v0.52-extra-0.14-beta

  • Update to mail-in-a-box v0.52

v0.51-extra-0.14-beta

  • Update to mail-in-a-box v0.51

v0.50-extra-0.14-beta

  • Update to mail-in-a-box v0.50

v0.48-extra-0.14-beta

  • Update to mail-in-a-box v0.48

v0.46-extra-0.14-beta

  • Update to mail-in-a-box v0.46

v0.45-extra-0.14-beta

  • Update to mail-in-a-box v0.45

v0.44-extra-0.14-beta

  • Update to mail-in-a-box v0.44

v0.43-extra-0.14-beta

  • Fix bug that crashed user list when there is an archived user.

v0.43-extra-0.13-beta

  • Fix problem with the dns authentication scripts for Let's Encrypt crashing the DNS server.

v0.43-extra-0.12-beta

  • Fix bug introduced by last version. Remove postfix parameters associated with POSTSRSD instead of setting them to blank.

v0.43-extra-0.11-beta

  • Check the mailinabox-extra repository for the latest version.

  • Remove the POSTSRSD option from the options dialog as some problems have been encountered with the implementation.

v0.43-extra-0.10-beta

  • Initial release of the a custom repository with extra features for MiaB

Reference Documents

[BEGIN Official README]

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 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:

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 18.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 v57a

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.