using upstream readme

README.md

@@ -1,213 +1,3 @@
-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 v5x-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 v5x to v5x-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.
-
-* API docs do not include the quota endpoints.  Quota API endpoints need to be added to `api/mainlinabox.yml`.
-
-
-Changes
--------
-
-### v57a-quota-0.22-beta
-
-* Update to v57a of Mail-in-a-Box
-
-### v56-quota
-
-* Update to v56 of Mail-in-a-Box
-
-### v0.55-quota-0.22-beta
-
-* Update to v55 of Mail-in-a-Box
-
-### v0.53-quota-0.22-beta
-
-* Update to v0.53 of Mail-in-a-Box
-
-### v0.52-quota-0.22-beta
-
-* Update to v0.52 of Mail-in-a-Box
-
-### v0.51-quota-0.22-beta
-
-* Update to v0.51 of Mail-in-a-Box
-
-### 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
--------------------
-
-* https://blog.sys4.de/postfix-dovecot-mailbox-quota-en.html
-* https://linuxize.com/post/install-and-configure-postfix-and-dovecot/
-
-
-\[BEGIN Official README]
-
 Mail-in-a-Box
 =============
 
@@ -289,7 +79,7 @@ This is a challenge faced by everyone who runs their own mail server, with or wi
 Contributing and Development
 ----------------------------
 
-Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome. See [CONTRIBUTING](CONTRIBUTING.md) to get started.
+Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome. See [CONTRIBUTING](CONTRIBUTING.md) to get started. 
 
 
 The Acknowledgements