README
author Pascal Volk <user@localhost.localdomain.org>
Sun, 02 Dec 2012 14:54:24 +0000
branchv0.7.x
changeset 657 6515e3b88dec
parent 629 8009e87c7a20
child 701 110491a871a7
permissions -rw-r--r--
VMM/cli/subcommands: Fixed some encode/decode issues.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
     1
.. -*- restructuredtext -*-
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
     2
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     3
============================
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     4
vmm - a virtual mail manager
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     5
============================
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     6
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     7
Welcome to vmm!
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     8
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
     9
**vmm** is the easy to use and configurable command line tool for
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    10
administrators and postmasters, to manage domains, alias-domains, accounts and
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    11
relocated mail users. It allows the fast and easy management of mail servers.
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    12
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    13
vmm is written in Python_. It's designed for installations using Dovecot_ and
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    14
Postfix_ with a PostgreSQL_ backend.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    15
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    16
Features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    17
========
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    18
• General features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    19
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    20
  ‣ Unicode/UTF-8 capable (input/storage/output)
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    21
  ‣ supports IDN_
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    22
  ‣ supports the mailbox format Maildir_ and Dovecot's own high-performance
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    23
    mailbox formats single- and multi-\ dbox_
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    24
  ‣ configurable basic mailbox structure, including sub-mailboxes
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    25
  ‣ multilingual — currently:
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    26
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    27
     * Dutch
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    28
     * English
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    29
     * Finnish
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    30
     * French
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    31
     * German
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    32
     * Vietnamese
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    33
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    34
• Domain features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    35
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    36
  ‣ configurable transport_ setting per domain
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    37
  ‣ unique group identifier (GID) per domain
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    38
  ‣ each domain may have one or more alias domain names
576
0be27a75776a README: Substituted a few words.
Pascal Volk <user@localhost.localdomain.org>
parents: 575
diff changeset
    39
  ‣ activate or deactivate services (SMTP, POP3, IMAP and ManageSieve) for new
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    40
    or all accounts of a domain
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    41
  ‣ configurable quota limits (size and/or number of messages) for the
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    42
    domain's accounts
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    43
  ‣ supports relocated_ users
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    44
  ‣ the postmaster account can be created automatically when a new domain is
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    45
    created
517
88466a6ba3ae Add catch-all aliases to README/features
martin f. krafft <madduck@madduck.net>
parents: 484
diff changeset
    46
  ‣ supports per-domain catch-all aliases
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    47
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    48
• Alias domain features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    49
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    50
  ‣ alias domain names can be switched between domains
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    51
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    52
• Account features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    53
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    54
  ‣ configurable transport per account
576
0be27a75776a README: Substituted a few words.
Pascal Volk <user@localhost.localdomain.org>
parents: 575
diff changeset
    55
  ‣ activate or deactivate one/more/all services (SMTP, POP3, IMAP and
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    56
    ManageSieve) per account
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    57
  ‣ configurable quota limit (size and/or number of messages) per user
535
e956ddc868c0 Add inheritance as a feature to README
martin f. krafft <madduck@madduck.net>
parents: 519
diff changeset
    58
  ‣ per-account configuration overrides defaults defined by the domain,
e956ddc868c0 Add inheritance as a feature to README
martin f. krafft <madduck@madduck.net>
parents: 519
diff changeset
    59
    otherwise the setting is inherited
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    60
  ‣ unique user identifier (UID) per user
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    61
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    62
• Alias features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    63
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    64
  ‣ supports multiple destinations per e-mail alias
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    65
  ‣ destinations can be deleted separately
576
0be27a75776a README: Substituted a few words.
Pascal Volk <user@localhost.localdomain.org>
parents: 575
diff changeset
    66
  ‣ destinations can be interpolated using the original address' local-part
0be27a75776a README: Substituted a few words.
Pascal Volk <user@localhost.localdomain.org>
parents: 575
diff changeset
    67
    and domain, allowing aliases to have different meaning in alias domains,
519
b1fd6f08f369 README: reStructuredText fix: ERROR/3 and WARNING/2.
Pascal Volk <user@localhost.localdomain.org>
parents: 518
diff changeset
    68
    e.g. with the following defined in example.org::
b1fd6f08f369 README: reStructuredText fix: ERROR/3 and WARNING/2.
Pascal Volk <user@localhost.localdomain.org>
parents: 518
diff changeset
    69
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 517
diff changeset
    70
      postmaster@example.org  →  postmaster+%d@admin.example.org
519
b1fd6f08f369 README: reStructuredText fix: ERROR/3 and WARNING/2.
Pascal Volk <user@localhost.localdomain.org>
parents: 518
diff changeset
    71
576
0be27a75776a README: Substituted a few words.
Pascal Volk <user@localhost.localdomain.org>
parents: 575
diff changeset
    72
    If example.com is an alias domain of example.org, the alias will become::
519
b1fd6f08f369 README: reStructuredText fix: ERROR/3 and WARNING/2.
Pascal Volk <user@localhost.localdomain.org>
parents: 518
diff changeset
    73
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 517
diff changeset
    74
      postmaster@example.org  →  postmaster+example.org@admin.example.org
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 517
diff changeset
    75
      postmaster@example.com  →  postmaster+example.com@admin.example.org
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    76
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    77
Installation Prerequisites
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    78
==========================
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    79
You already should have installed and configured Postfix and Dovecot with
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    80
PostgreSQL support. You also need access to a local or remote PostgreSQL
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    81
server.
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    82
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    83
To verify that your Dovecot and Postfix installation has support for
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    84
PostgreSQL use the ``postconf`` and ``dovecot`` commands as shown below::
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    85
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    86
        hostname ~ # postconf -m | grep pgsql
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    87
        pgsql
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    88
        hostname ~ # postconf -a | grep dovecot
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    89
        dovecot
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    90
        hostname ~ # dovecot --build-options | grep postgresql
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    91
        SQL drivers: mysql postgresql sqlite
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    92
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    93
vmm depends on Python (≥ 2.4.0) and Psycopg_ (≥ 2.0) or pyPgSQL_ (≥ 2.5.1).
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    94
Psycopg and pyPgSQL are depending on parts of the *eGenix.com mx Base
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    95
Distribution* (mxDateTime_ and mxTools_).
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    96
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    97
If you are using Python ≤ 2.5.0:
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    98
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
    99
  • if you want to store your users' passwords as ``PLAIN-MD4`` digest in the
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   100
    database, vmm will try to use ``Crypto.Hash.MD4`` from PyCrypto_
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   101
  • if you are using Dovecot ≥ v1.1.0 and you want to store your users'
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   102
    passwords as ``SHA256`` or ``SSHA256`` hashes, vmm will try to use
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   103
    ``Crypto.Hash.SHA256`` from PyCrypto. For ``SHA256``/``SSHA256`` you
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   104
    should have installed PyCrypto, at least in version 2.1.0alpha1.
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   105
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   106
  When the Crypto.Hash module couldn't be imported, vmm will use
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   107
  dovecotpw/doveadm, if  the *misc.password_scheme* setting in your *vmm.cfg*
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   108
  is set to ``PLAIN-MD4``, ``SHA256`` or ``SSHA256``.
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   109
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   110
Source code
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   111
===========
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   112
vmm's source code is available from the Mercurial_ repositories:
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   113
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   114
• main repository
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   115
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   116
``http://hg.localdomain.org/vmm``
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   117
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   118
• mirror repositories
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   119
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   120
``https://bitbucket.org/pvo/vmm``
575
f9e6e0a237f0 README: Updated URL of the hg repository@sf.net.
Pascal Volk <user@localhost.localdomain.org>
parents: 535
diff changeset
   121
``http://hg.code.sf.net/p/vmm/code``
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   122
629
8009e87c7a20 doc/web: Added links to the Debian package and the git repos.
Pascal Volk <user@localhost.localdomain.org>
parents: 576
diff changeset
   123
The Debian project is hosting the Git repository of vmm:
8009e87c7a20 doc/web: Added links to the Debian package and the git repos.
Pascal Volk <user@localhost.localdomain.org>
parents: 576
diff changeset
   124
8009e87c7a20 doc/web: Added links to the Debian package and the git repos.
Pascal Volk <user@localhost.localdomain.org>
parents: 576
diff changeset
   125
``git://anonscm.debian.org/collab-maint/vmm.git``
8009e87c7a20 doc/web: Added links to the Debian package and the git repos.
Pascal Volk <user@localhost.localdomain.org>
parents: 576
diff changeset
   126
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   127
Released versions are also available as gzip compressed tar archives at:
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   128
https://sourceforge.net/projects/vmm/files/vmm/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   129
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   130
Installation/Upgrade
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   131
====================
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   132
For installation or upgrading instructions read the `INSTALL` or `UPGRADE`
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   133
file.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   134
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   135
License
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   136
=======
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   137
In short: "**New BSD License**" aka "3-clause license". For a few more
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   138
details see the `COPYING` file.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   139
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   140
.. External references
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   141
.. _dbox: http://wiki2.dovecot.org/MailboxFormat/dbox
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   142
.. _Dovecot: http://dovecot.org/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   143
.. _IDN: http://en.wikipedia.org/wiki/Internationalized_domain_name
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   144
.. _Maildir: http://wiki2.dovecot.org/MailboxFormat/Maildir
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   145
.. _Mercurial: http://mercurial.selenic.com/
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   146
.. _mxDateTime: http://www.egenix.com/products/python/mxBase/mxDateTime/
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   147
.. _mxTools: http://www.egenix.com/products/python/mxBase/mxTools/
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   148
.. _Postfix: http://www.postfix.org/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   149
.. _PostgreSQL: http://www.postgresql.org/
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   150
.. _Psycopg: http://initd.org/psycopg/
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   151
.. _PyCrypto: http://www.pycrypto.org/
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   152
.. _pyPgSQL: http://pypgsql.sourceforge.net/
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
   153
.. _Python: http://www.python.org/
484
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   154
.. _relocated: http://www.postfix.org/relocated.5.html
35395b49bc44 README: Added section `Installation Prerequisites'. Reworked some parts.
Pascal Volk <user@localhost.localdomain.org>
parents: 435
diff changeset
   155
.. _transport: http://www.postfix.org/transport.5.html