| 1 |
.. _imap-admin-quotas: |
| 2 |
|
| 3 |
====== |
| 4 |
Quotas |
| 5 |
====== |
| 6 |
|
| 7 |
Cyrus IMAP features a flexible Quota scheme with support for limiting |
| 8 |
various resources, such as storage or number of folders or messages. |
| 9 |
|
| 10 |
.. toctree:: |
| 11 |
:maxdepth: 1 |
| 12 |
:glob: |
| 13 |
|
| 14 |
quotas/* |
| 15 |
|
| 16 |
.. _imap-admin-quotas-repair: |
| 17 |
|
| 18 |
Monitor and Repair |
| 19 |
================== |
| 20 |
|
| 21 |
Quotas may be monitored and repaired via the :cyrusman:`quota(8)` |
| 22 |
command: |
| 23 |
|
| 24 |
* :ref:`imap-reference-manpages-systemcommands-quota` |
| 25 |
|
| 26 |
.. _imap-admin-quotas-config: |
| 27 |
|
| 28 |
Controlling Quota Behavior |
| 29 |
========================== |
| 30 |
|
| 31 |
How restrictive quotas will be may be tailored to the needs of different |
| 32 |
sites, via the use of several settings in :cyrusman:`imapd.conf(5)`: |
| 33 |
|
| 34 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 35 |
:start-after: startblob lmtp_over_quota_perm_failure |
| 36 |
:end-before: endblob lmtp_over_quota_perm_failure |
| 37 |
|
| 38 |
|
| 39 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 40 |
:start-after: startblob lmtp_strict_quota |
| 41 |
:end-before: endblob lmtp_strict_quota |
| 42 |
|
| 43 |
|
| 44 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 45 |
:start-after: startblob quotawarnpercent |
| 46 |
:end-before: endblob quotawarnpercent |
| 47 |
|
| 48 |
|
| 49 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 50 |
:start-after: startblob quotawarnsize |
| 51 |
:end-before: endblob quotawarnsize |
| 52 |
|
| 53 |
|
| 54 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 55 |
:start-after: startblob quotawarnmsg |
| 56 |
:end-before: endblob quotawarnmsg |
| 57 |
|
| 58 |
|
| 59 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 60 |
:start-after: startblob autocreate_quota |
| 61 |
:end-before: endblob autocreate_quota |
| 62 |
|
| 63 |
|
| 64 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 65 |
:start-after: startblob autocreate_quota_messages |
| 66 |
:end-before: endblob autocreate_quota_messages |
| 67 |
|
| 68 |
.. _imap-admin-quotas-database: |
| 69 |
|
| 70 |
Quota Database |
| 71 |
============== |
| 72 |
|
| 73 |
Quota information is stored either in a database (i.e. twoskip, |
| 74 |
skiplist) or in "quotalegacy" format, which is a filesystem hierarchy. |
| 75 |
This is controlled by the ``quota_db`` setting in |
| 76 |
:cyrusman:`imapd.conf(5)`. Here's more about the pertinent settings: |
| 77 |
|
| 78 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 79 |
:start-after: startblob quota_db |
| 80 |
:end-before: endblob quota_db |
| 81 |
|
| 82 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 83 |
:start-after: startblob quota_db_path |
| 84 |
:end-before: endblob quota_db_path |
| 85 |
|
| 86 |
.. _imap-admin-quotas-convert-db: |
| 87 |
|
| 88 |
Converting Quotas Database |
| 89 |
========================== |
| 90 |
|
| 91 |
The :cyrusman:`cvt_cyrusdb(8)` utility may be used to convert between |
| 92 |
formats. It's usage with ``quotalegacy`` is a special case, in that |
| 93 |
the first argument ("<old db>") will be the path to the *base* of the |
| 94 |
``quotalegacy`` directory structure, not to a particular file. |
| 95 |
|
| 96 |
For example, given this typical layout: |
| 97 |
|
| 98 |
:: |
| 99 |
|
| 100 |
/var/lib/imap/ |
| 101 |
| /quota/ |
| 102 |
| /A/ |
| 103 |
| /user/ |
| 104 |
| /bob/ |
| 105 |
|
| 106 |
The proper ``cvt_cyrusdb`` command would be: |
| 107 |
|
| 108 |
:: |
| 109 |
|
| 110 |
cvt_cyrusdb /var/lib/imap/quota quotalegacy /var/lib/imap/quotas.db twoskip |
| 111 |
|
| 112 |
.. _imap-admin-quotas-end: |
| 113 |
|
| 114 |
Back to :ref:`imap-admin` |