doc/web/source/installation/prerequisites.rst
author Pascal Volk <user@localhost.localdomain.org>
Sun, 21 Nov 2021 21:27:53 +0000
branchv0.7.x
changeset 759 2a23083e2ea3
parent 712 6be7e9085e94
permissions -rw-r--r--
closed branch v0.7.x
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     1
==========================
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     2
Installation Prerequisites
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     3
==========================
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
     4
You already should have installed and configured Postfix and Dovecot
712
6be7e9085e94 README: Updated/cleaned up dependences.
Pascal Volk <user@localhost.localdomain.org>
parents: 695
diff changeset
     5
≥ 2.0.0 with PostgreSQL support. You also need access to a local or remote
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
     6
PostgreSQL server.
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
Check for pgsql support in Dovecot and Postfix
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
----------------------------------------------
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
To verify that your Dovecot and Postfix installation has support for
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    11
PostgreSQL use the :command:`postconf` and :command:`dovecot` commands as
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
shown below:
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    13
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
.. code-block:: console
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    15
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    16
  root@host:~# postconf -m | grep pgsql
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    17
  pgsql
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    18
  root@host:~# postconf -a | grep dovecot
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    19
  dovecot
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    20
  root@host:~# dovecot --build-options | grep postgresql
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
  SQL drivers: mysql postgresql sqlite
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    23
vmm depends on Python (≥ 3.2) and Psycopg_ (≥ 2.0).
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
If your Dovecot and/or Postfix installation shouldn't support PostgreSQL you
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
could possibly fix this by installing the missing package (see below) or by
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
recompiling the corresponding part.
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    29
Package names by OS/Distribution
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
--------------------------------
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    31
Debian GNU/Linux (Wheezy)
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    32
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
`postfix <http://packages.debian.org/postfix>`_ and
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
   `postfix-pgsql <http://packages.debian.org/postfix-pgsql>`_
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    35
`dovecot-core <http://packages.debian.org/dovecot-core>`_ and
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    36
   `dovecot-lmtpd <http://packages.debian.org/dovecot-lmtpd>`_
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
`dovecot-imapd <http://packages.debian.org/dovecot-imapd>`_ and/or
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
   `dovecot-pop3d <http://packages.debian.org/dovecot-pop3d>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
`postgresql-client <http://packages.debian.org/postgresql-client>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
   (or `postgresql <http://packages.debian.org/postgresql>`_ , if you do not
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
   have a dedicated PostgreSQL server.)
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    42
`python3 <http://packages.debian.org/python3>`_ and
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    43
   `python3-psycopg2 <http://packages.debian.org/python3-psycopg2>`_
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    44
`gettext <http://packages.debian.org/gettext>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    45
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
FreeBSD
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    47
^^^^^^^
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
Packages or build from ports:
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
 ‣ dovecot
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
 ‣ postfix
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
 ‣ postgresql-client (and postgresql-server, if you do not have a dedicated
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    52
   PostgreSQL server.)
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
 ‣ python25, py25-mx-base and py25-pyPgSQL optionally py25-pycrypto
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    54
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    55
Gentoo Linux
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
^^^^^^^^^^^^
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
`dev-python/pypgsql <http://gentoo-portage.com/dev-python/pypgsql>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    58
`mail-mta/postfix <http://gentoo-portage.com/mail-mta/postfix>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
`net-mail/dovecot <http://gentoo-portage.com/net-mail/dovecot>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
`dev-db/postgresql-base <http://gentoo-portage.com/dev-db/postgresql-base>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    61
 ‣ `dev-db/postgresql-server \
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    62
   <http://gentoo-portage.com/dev-db/postgresql-server>`_
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
Applied use-Flags (/etc/portage/package.use)::
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    65
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    66
 mail-mta/postfix dovecot-sasl postgres -pam sasl
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
 net-mail/dovecot postgres -pam pop3d sieve
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
 dev-db/postgresql-server -perl
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    70
OpenBSD (5.2)
635
54172669bbae doc/web: Updated OpenBSD's package names.
Pascal Volk <user@localhost.localdomain.org>
parents: 579
diff changeset
    71
^^^^^^^^^^^^^
54172669bbae doc/web: Updated OpenBSD's package names.
Pascal Volk <user@localhost.localdomain.org>
parents: 579
diff changeset
    72
Packages
54172669bbae doc/web: Updated OpenBSD's package names.
Pascal Volk <user@localhost.localdomain.org>
parents: 579
diff changeset
    73
 ‣ postfix-2.x.y-pgsql
54172669bbae doc/web: Updated OpenBSD's package names.
Pascal Volk <user@localhost.localdomain.org>
parents: 579
diff changeset
    74
 ‣ dovecot-2.x.y and dovecot-postgresql-2.x.y
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
 ‣ postgresql-client
695
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    76
 ‣ python-3.2.x
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    77
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    78
Build from source
42addf4f2434 {INSTALL,doc}: Updated documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 635
diff changeset
    79
 ‣ Psycopg_
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    80
635
54172669bbae doc/web: Updated OpenBSD's package names.
Pascal Volk <user@localhost.localdomain.org>
parents: 579
diff changeset
    81
Or build the above mentioned software from ports.
579
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    82
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
openSUSE Linux
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
^^^^^^^^^^^^^^
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
 ‣ postfix and postfix-postgresql
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
 ‣ postgresql-server and postgresql
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    87
 ‣ dovecot
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
 ‣ python and pyPgSQL optionally python-crypto
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    89
be0906181a10 doc: Added source of http://vmm.localdomain.org/.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    90
.. include:: ../ext_references.rst