Requirements¶
Userli host¶
- A webserver with PHP-FPM, for example Caddy, Nginx or Apache
- PHP 8.4 with the extensions
sodium(mailbox encryption)intlpdo_mysqlgd,zip,opcache(recommended)redis(optional, for the Redis cache)
- MariaDB or MySQL
- OpenSSL command line tool (
openssl) – used to create MailCrypt keys - GnuPG 2.1.14 or newer – used to validate uploaded OpenPGP keys
- A process supervisor such as systemd for the background services
- An SMTP server to send emails (welcome mails, notifications, reports)
- HTTPS with a valid certificate
Database support
Only MariaDB and MySQL are supported. The database migrations use MySQL-specific SQL, so PostgreSQL and SQLite can't be upgraded between releases.
Node.js and Composer are not needed: the release tarball contains all PHP dependencies and the built frontend assets.
Mail host¶
- Dovecot 2.4 with Lua support
(
dovecot-auth-lua) andlua-json– for authentication and MailCrypt - Postfix with socketmap support and the userli-postfix-adapter (requires Redis)
Userli, Dovecot and Postfix can run on the same host or on different hosts. The mail host needs HTTPS access to Userli.
Optional¶
- Roundcube with the Userli plugin
- Keycloak with the Userli user provider for single sign-on
- Prometheus node exporter for metrics