README
author Pascal Volk <neverseen@users.sourceforge.net>
Thu, 03 Nov 2011 05:32:47 +0000
branchv0.6.x
changeset 446 18b75e6a39d5
parent 435 ee6f8ac06197
child 484 35395b49bc44
permissions -rw-r--r--
VMM/cli/subcommands: Small indent fix.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
435
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     1
============================
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     2
vmm - a virtual mail manager
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
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     5
Welcome to vmm!
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
vmm is the easy to use command line tool for administrators and postmasters,
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     8
to manage domains, alias-domains, accounts and relocated mail users. It allows
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
     9
the fast and easy management of mail servers.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    10
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    11
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
    12
Postfix_ with a PostgreSQL_ backend.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    13
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    14
Features
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
 General 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
   Unicode/UTF-8 capable (input/storage/output)
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    19
   supports IDN_
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    20
   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
    21
    mailbox formats single- and multi-\ dbox_
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    22
   configurable basic mailbox structure, including sub-mailboxes
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    23
   multilingual (currently: Dutch, English, French and German)
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    24
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    25
 Domain features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    26
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    27
   configurable transport setting per domain
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    28
   unique group identifier (GID) per domain
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    29
   each domain may have one or more alias domain names
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    30
   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
    31
    domain's accounts
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    32
   supports relocated users
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    33
   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
    34
    created
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    35
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    36
 Alias domain features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    37
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    38
   alias domain names can be switched between domains
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    39
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    40
 Account features
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    41
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    42
   configurable transport per account
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    43
   activate or deactivate one/more/all services (SMTP, POP, IMAP and
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    44
    ManageSieve) per account
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    45
   configurable quota limit (size and/or number of messages) per user
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    46
   unique user identifier (UID) per user
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 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
   supports multiple destinations per e-mail alias
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    51
   destinations  can be deleted separately
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    52
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    53
Source code
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    54
===========
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    55
vmm's source code is available from the Mercurial_ repositories:
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    56
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    57
 main repository
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    58
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    59
   ``http://hg.localdomain.org/vmm``
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    60
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    61
 mirror repositories
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    62
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    63
   ``https://bitbucket.org/pvo/vmm``
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    64
   ``http://vmm.hg.sourceforge.net/hgweb/vmm/vmm``
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    65
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    66
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
    67
https://sourceforge.net/projects/vmm/files/vmm/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    68
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    69
Installation/Upgrade
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    70
====================
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    71
For installation or upgrading instructions read the `INSTALL` or `UPGRADE`
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    72
file.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    73
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    74
License
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    75
=======
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    76
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
    77
details see the `COPYING` file.
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    78
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    79
.. External references
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    80
.. _dbox: http://wiki2.dovecot.org/MailboxFormat/dbox
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    81
.. _Dovecot: http://dovecot.org/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    82
.. _IDN: http://en.wikipedia.org/wiki/Internationalized_domain_name
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    83
.. _Maildir: http://wiki2.dovecot.org/MailboxFormat/Maildir
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    84
.. _Mercurial: http://mercurial.selenic.com/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    85
.. _Postfix: http://www.postfix.org/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    86
.. _PostgreSQL: http://www.postgresql.org/
ee6f8ac06197 README: Added contet.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 0
diff changeset
    87
.. _Python: http://www.python.org/