beenull/power-mailinabox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A Mail-in-a-Box with extra capabilities and more customizability. Not just for power users!
1863 commits 16 branches 101 tags 4.8 MiB
Python 52.2%
Shell 24.1%
HTML 22.7%
PHP 0.9%
Handlebars 0.1%
Find a file
John Supplee 38ac127344 v0.50 (September 25, 2020) 
--------------------------
 
 Setup:
 
 * When upgrading from versions before v0.40, setup will now warn that ownCloud/Nextcloud data cannot be migrated rather than failing the installation.
 
 Mail:
 
 * An MTA-STS policy for incoming mail is now published (in DNS and over HTTPS) when the primary hostname and email address domain both have a signed TLS certificate installed, allowing senders to know that an encrypted connection should be enforced.
 * The per-IP connection limit to the IMAP server has been doubled to allow more devices to connect at once, especially with multiple users behind a NAT.
 
 DNS:
 
 * autoconfig and autodiscover subdomains and CalDAV/CardDAV SRV records are no longer generated for domains that don't have user accounts since they are unnecessary.
 * IPv6 addresses can now be specified for secondary DNS nameservers in the control panel.
 
 TLS:
 
 * TLS certificates are now provisioned in groups by parent domain to limit easy domain enumeration and make provisioning more resilient to errors for particular domains.
 
 Control Panel:
 
 * The control panel API is now fully documented at https://mailinabox.email/api-docs.html.
 * User passwords can now have spaces.
 * Status checks for automatic subdomains have been moved into the section for the parent domain.
 * Typo fixed.
 
 Web:
 
 * The default web page served on fresh installations now adds the `noindex` meta tag.
 * The HSTS header is revised to also be sent on non-success responses.
 -----BEGIN PGP SIGNATURE-----
 
 iQFDBAABCgAtFiEEX0wOcxPM10RpOyrquSBB9MEL3YEFAl9t2AgPHGp0QG9jY2Ft
 cy5pbmZvAAoJELkgQfTBC92BZNkH/1jIGoWTz0xlS+e+TeXpHoCp/7zYAvQq/a/y
 vj9t1N1+bBg6Ywbd8UxyvOHwuL/UQU/5LTq6hk3gD+2ARfJUvDRbb047Xzlisg3N
 LhNoVhVbsxqKP1X2ZjeIBq9DgzMavuB64Bwd5UNdceM0Addi8KuCDOMF+FNY2t8k
 xytGjYdBi1/BG6SLBX+FAm5yrJghmkUJs2FnJjebSyyeV2HP3L1iBrk2N8UBd6PU
 fVjde534lgygFZK/8yXJpY2olfLMYJv7CaOMxvaW6RpbMI8VeLwDLfRt5LcrQZqq
 YXkuEnUI0eygbQYkeK/Vr1Vey6uQAWzIfbImEglHfvOXsZSYFXs=
 =SJNM
 -----END PGP SIGNATURE-----

Merge tag 'v0.50' of https://github.com/mail-in-a-box/mailinabox into master

v0.50 (September 25, 2020)
--------------------------

Setup:

* When upgrading from versions before v0.40, setup will now warn that ownCloud/Nextcloud data cannot be migrated rather than failing the installation.

Mail:

* An MTA-STS policy for incoming mail is now published (in DNS and over HTTPS) when the primary hostname and email address domain both have a signed TLS certificate installed, allowing senders to know that an encrypted connection should be enforced.
* The per-IP connection limit to the IMAP server has been doubled to allow more devices to connect at once, especially with multiple users behind a NAT.

DNS:

* autoconfig and autodiscover subdomains and CalDAV/CardDAV SRV records are no longer generated for domains that don't have user accounts since they are unnecessary.
* IPv6 addresses can now be specified for secondary DNS nameservers in the control panel.

TLS:

* TLS certificates are now provisioned in groups by parent domain to limit easy domain enumeration and make provisioning more resilient to errors for particular domains.

Control Panel:

* The control panel API is now fully documented at https://mailinabox.email/api-docs.html.
* User passwords can now have spaces.
* Status checks for automatic subdomains have been moved into the section for the parent domain.
* Typo fixed.

Web:

* The default web page served on fresh installations now adds the `noindex` meta tag.
* The HSTS header is revised to also be sent on non-success responses.

# gpg verification failed.

# Conflicts:
#	.gitignore
#	setup/bootstrap.sh
2020-10-11 18:16:36 +02:00
api Add OpenAPI HTTP spec (#1804) 2020-08-22 15:44:19 -04:00
conf v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
management v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
setup v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
tests add a test for fail2ban monitoring managesieve 2019-08-31 09:15:41 -04:00
tools v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
.editorconfig Use correct setting for .editorconfig indent_style (#1670) 2019-11-03 13:31:29 -05:00
.gitignore v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
CHANGELOG.md v0.50 2020-09-25 07:43:30 -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 v0.50 (September 25, 2020) 2020-10-11 18:16:36 +02:00
security.md MTA-STS tweaks, add status check using postfix-mta-sts-resolver, change to enforce 2020-05-29 15:36:52 -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 with Quotas

This is an experimental implementation of Mail-in-a-box with quota support.

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

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

$ git clone https://github.com/jrsupplee/mailinabox.git
$ 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-quota

This is experimental software. You have been warned.

  • Rename your mailinabox directory to something like miab.old

  • Clone this repository using:

    git clone https://github.com/jrsupplee/mailinabox.git

  • 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 with quotas 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.50-quota-0.22-beta

  • Update to v0.50 of Mail-in-a-Box

v0.48-quota-0.22-beta

  • Update to v0.48 of Mail-in-a-Box

v0.46-quota-0.22-beta

  • Update to v0.46 of Mail-in-a-Box

v0.45-quota-0.22-beta

  • Update to v0.45 of Mail-in-a-Box

v0.44-quota-0.22-beta

  • Update to v0.44 of Mail-in-a-Box

v0.43-quota-0.22-beta

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

v0.43-quota-0.21-beta

  • Remove extra features from the master branch

v0.43-quota-0.20-beta

  • Hide set quota for a mailbox that has been archived

v0.43-quota-0.19-beta

  • Add user quota API documentation to the mail users page

v0.43-quota-0.18-beta

  • Update to v0.43 of Mail-in-a-Box

v0.42b-quota-0.18-beta

  • Update to v0.42b of Mail-in-a-Box

v0.41-quota-0.18-beta

  • Bump version to add a new annotated tag. The last version had a plain tag which is not seen when checking for the latest version.

v0.41-quota-0.17-beta

  • Change status of project to beta. No changes to the code

v0.41-quota-0.17-alpha

  • Update the README

v0.41-quota-0.16-alpha

  • Update to v0.41 of Mail-in-a-Box

v0.40-quota-0.16-alpha

  • Fix problem with quota field on control panel that prevented adding users.

v0.40-quota-0.15-alpha

  • Fix bug where quotas are not recalculated when a user's quota is changed in control panel

v0.40-quota-0.14-alpha

  • When updating a user's quota, execute doveadm quota recalc -u <email> to forces an immediate recalculation of the user's quota.

  • Add a thousands separator (,) to the messages count in the control panel user list.

  • Execute doveadm quota recalc -A to force a recalculation of all user quotas when running start.sh.

  • Get rid of the error message complaining that the quota column already exists when upgrading from a previous version of v0.40-quota.

v0.40-quota-0.13-alpha

  • Add a default-quota setting in settings.yaml.

  • Add input for setting quota when entering a new user in control panel.

  • Modify tools/mail.py to allow for setting and getting the default system quota.

  • Modify tools/mail.py to allow for getting a user's quota setting.

  • Modify the mail users list in control panel to display percentage of quota used.

v0.40-quota-0.12-alpha

  • Update README

v0.40-quota-0.11-alpha

  • Read latest version from this repository not the Mail-in-a-Box master repository

v0.40-quota-0.1-alpha

  • First experimental release of Mail-in-a-Box for quotas.
  • Quotas are working and there is basic support in the control panel and tools/mail.py.

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

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:

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

Optional: Download Josh's PGP key and then verify that the sources were signed by him:

$ 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.50
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 his 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.50

Begin the installation.

$ sudo setup/start.sh

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.