README
branchv0.7.x
changeset 712 6be7e9085e94
parent 701 110491a871a7
equal deleted inserted replaced
711:2a75058fc064 712:6be7e9085e94
    16 Features
    16 Features
    17 ========
    17 ========
    18 • General features
    18 • General features
    19 
    19 
    20   ‣ Unicode/UTF-8 capable (input/storage/output)
    20   ‣ Unicode/UTF-8 capable (input/storage/output)
    21   ‣ supports IDN_ (also ccTLDs/ccIDNs and 'new' gTLDs)
    21   ‣ supports IDN_ (also `IDN ccTLDs`_/ccIDNs and 'new' gTLDs)
    22   ‣ supports the mailbox format Maildir_ and Dovecot's own high-performance
    22   ‣ supports the mailbox format Maildir_ and Dovecot's own high-performance
    23     mailbox formats single- and multi-\ dbox_
    23     mailbox formats single- and multi-\ dbox_
    24   ‣ configurable basic mailbox structure, including sub-mailboxes
    24   ‣ configurable basic mailbox structure, including sub-mailboxes
    25   ‣ multilingual — currently:
    25   ‣ multilingual — currently:
    26 
    26 
    74       postmaster@example.org  →  postmaster+example.org@admin.example.org
    74       postmaster@example.org  →  postmaster+example.org@admin.example.org
    75       postmaster@example.com  →  postmaster+example.com@admin.example.org
    75       postmaster@example.com  →  postmaster+example.com@admin.example.org
    76 
    76 
    77 Installation Prerequisites
    77 Installation Prerequisites
    78 ==========================
    78 ==========================
    79 You already should have installed and configured Postfix and Dovecot with
    79 You already should have installed and configured Postfix and Dovecot (≥ 2.0.0)
    80 PostgreSQL support. You also need access to a local or remote PostgreSQL
    80 with PostgreSQL support. You also need access to a local or remote PostgreSQL
    81 server.
    81 server.
    82 
    82 
    83 To verify that your Dovecot and Postfix installation has support for
    83 To verify that your Dovecot and Postfix installation has support for
    84 PostgreSQL use the ``postconf`` and ``dovecot`` commands as shown below::
    84 PostgreSQL use the ``postconf`` and ``dovecot`` commands as shown below::
    85 
    85 
    88         hostname ~ # postconf -a | grep dovecot
    88         hostname ~ # postconf -a | grep dovecot
    89         dovecot
    89         dovecot
    90         hostname ~ # dovecot --build-options | grep postgresql
    90         hostname ~ # dovecot --build-options | grep postgresql
    91         SQL drivers: mysql postgresql sqlite
    91         SQL drivers: mysql postgresql sqlite
    92 
    92 
    93 vmm depends on Python (≥ 2.4.0) and Psycopg_ (≥ 2.0) or pyPgSQL_ (≥ 2.5.1).
    93 Dependences
    94 Psycopg and pyPgSQL are depending on parts of the *eGenix.com mx Base
    94 -----------
    95 Distribution* (mxDateTime_ and mxTools_).
    95 vmm (≥ 0.7.0) depends on Python (≥ 3.2) and Psycopg_ (≥ 2.0).
    96 
       
    97 If you are using Python ≤ 2.5.0:
       
    98 
       
    99   • if you want to store your users' passwords as ``PLAIN-MD4`` digest in the
       
   100     database, vmm will try to use ``Crypto.Hash.MD4`` from PyCrypto_
       
   101   • if you are using Dovecot ≥ v1.1.0 and you want to store your users'
       
   102     passwords as ``SHA256`` or ``SSHA256`` hashes, vmm will try to use
       
   103     ``Crypto.Hash.SHA256`` from PyCrypto. For ``SHA256``/``SSHA256`` you
       
   104     should have installed PyCrypto, at least in version 2.1.0alpha1.
       
   105 
       
   106   When the Crypto.Hash module couldn't be imported, vmm will use
       
   107   dovecotpw/doveadm, if  the *misc.password_scheme* setting in your *vmm.cfg*
       
   108   is set to ``PLAIN-MD4``, ``SHA256`` or ``SSHA256``.
       
   109 
    96 
   110 Source code
    97 Source code
   111 ===========
    98 ===========
   112 vmm's source code is available from the Mercurial_ repositories:
    99 vmm's source code is available from the Mercurial_ repositories:
   113 
   100 
   136 =======
   123 =======
   137 In short: "**New BSD License**" aka "3-clause license". For a few more
   124 In short: "**New BSD License**" aka "3-clause license". For a few more
   138 details see the `COPYING` file.
   125 details see the `COPYING` file.
   139 
   126 
   140 .. External references
   127 .. External references
       
   128 .. _IDN ccTLDs: \
       
   129  http://en.wikipedia.org/wiki/Internationalized_country_code_top-level_domain
   141 .. _dbox: http://wiki2.dovecot.org/MailboxFormat/dbox
   130 .. _dbox: http://wiki2.dovecot.org/MailboxFormat/dbox
   142 .. _Dovecot: http://dovecot.org/
   131 .. _Dovecot: http://dovecot.org/
   143 .. _IDN: http://en.wikipedia.org/wiki/Internationalized_domain_name
   132 .. _IDN: http://en.wikipedia.org/wiki/Internationalized_domain_name
   144 .. _Maildir: http://wiki2.dovecot.org/MailboxFormat/Maildir
   133 .. _Maildir: http://wiki2.dovecot.org/MailboxFormat/Maildir
   145 .. _Mercurial: http://mercurial.selenic.com/
   134 .. _Mercurial: http://mercurial.selenic.com/
   146 .. _mxDateTime: http://www.egenix.com/products/python/mxBase/mxDateTime/
       
   147 .. _mxTools: http://www.egenix.com/products/python/mxBase/mxTools/
       
   148 .. _Postfix: http://www.postfix.org/
   135 .. _Postfix: http://www.postfix.org/
   149 .. _PostgreSQL: http://www.postgresql.org/
   136 .. _PostgreSQL: http://www.postgresql.org/
   150 .. _Psycopg: http://initd.org/psycopg/
   137 .. _Psycopg: http://initd.org/psycopg/
   151 .. _PyCrypto: http://www.pycrypto.org/
       
   152 .. _pyPgSQL: http://pypgsql.sourceforge.net/
       
   153 .. _Python: http://www.python.org/
   138 .. _Python: http://www.python.org/
   154 .. _relocated: http://www.postfix.org/relocated.5.html
   139 .. _relocated: http://www.postfix.org/relocated.5.html
   155 .. _transport: http://www.postfix.org/transport.5.html
   140 .. _transport: http://www.postfix.org/transport.5.html