Requirements

Before installing modoboa-pro, make sure your environment satisfies the following.

Modoboa instance

• A working Modoboa >= 2.12.0 installation. The plugin extends an existing instance; it is not a standalone application.

• Access to the Modoboa instance's Python virtual environment (the same one modoboa itself is installed in) so the plugin lands on the same PYTHONPATH.

• The instance must run its RQ workers — the plugin offloads certificate issuance, Nginx configuration and the rights of shared mailboxes to background jobs. Three queues are used:

  Queue	Purpose
  modoboa	Certificate issuance / renewal (ACME calls).
  privileged	Nginx configuration and site enable/disable (filesystem writes).
  dovecot	Rights of the members of shared mailboxes (doveadm).

  The privileged queue must run as a user allowed to write the Nginx configuration directories (see Nginx integration).

• For shared mailboxes, folder sharing must be enabled in Dovecot (IMAP ACL, shared namespace, / as hierarchy separator). The Modoboa installer does it for new installations (enable_sharing option of the [dovecot] section); existing ones must follow the upgrade instructions first.

Python

• Python >= 3.10.

• The following Python dependencies are pulled in automatically with the package:

  Dependency	Version	Used for
  acme	>= 2.11	ACME / Let's Encrypt client.
  josepy	>= 1.14	JOSE primitives required by acme.
  cryptography	>= 42	X.509 certificate parsing and RSA key generation.

System (for certificates and Nginx)

These are only required if you enable the corresponding features.

• Nginx, if you want the plugin to generate per-virtual-host server blocks. The plugin writes configuration files and (optionally) manages symlinks in sites-enabled; it does not install or reload Nginx for you — see Nginx integration.
• Public DNS records for every virtual host hostname, pointing at the server. Let's Encrypt validates ownership over HTTP-01, so each hostname must be reachable on port 80 from the internet during issuance.
• Outbound HTTPS access to the ACME directory (Let's Encrypt) from the server.
• A writable storage directory for the ACME account key and issued certificates (default /var/lib/modoboa/acme).

TIP

If you only want to manage virtual hosts and link domains without automatic certificates or Nginx generation, you can leave both features disabled and provide the TLS termination / web configuration yourself.

Next step

Continue with the Installation guide.