Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 4.28 KB

README.md

File metadata and controls

67 lines (50 loc) · 4.28 KB
Raw

Releases Build status License

All-in-one (nginx + uwsgi + cron) Docker image for iRedAdmin

iRedAdmin (Open Source Edition) is the admin panel of the iRedMail project. You will need a working iRedMail setup to be able to use this image.

Basic usage

$ docker run -d -p 8080:80 --env-file .env -v /var/vmail/vmail1:/var/vmail/vmail1 ghcr.io/colibris-xyz/iredadmin:latest

All the basic configuration is done by environment variables, see the list below.

Environment variables configuration

iRedAdmin database configuration

  • IREDADMIN_DB_HOST (not set by default) - Hostname of the iRedAdmin database server.
  • IREDADMIN_DB_NAME (default: iredadmin) - Name of the iRedAdmin database.
  • IREDADMIN_DB_USER (default: iredadmin) - Username for the iRedAdmin database.
  • IREDADMIN_DB_PASSWORD (not set by default) - Password for the iRedAdmin database.
  • IREDADMIN_DB_PORT (default: 3306) - Port of the iRedAdmin database.

Mail accounts backend configuration

  • DATABASE_BACKEND (default: ldap) - The database backend to store mail accounts. Currently supported: ldap, mysql, pgsql.

OpenLDAP backend:

  • LDAP_URI (not set by default) - LDAP server URI, prefix with ldap:// for normal connection or ldaps:// for STARTTLS.
  • LDAP_BASE_DN (not set by default) - LDAP base DN. For example: o=domains,dc=iredmail,dc=org.
  • LDAP_DOMAINADMIN_DN (not set by default) - LDAP base DN for domain admins. For example: o=domainAdmins,dc=iredmail,dc=org.
  • LDAP_BIND_DN (not set by default) - LDAP bind DN user. For example: cn=vmailadmin,dc=iredmail,dc=org.
  • LDAP_BIND_PASSWORD (not set by default) - LDAP bind DN password.

SQL backends:

  • VMAIL_DB_HOST (not set by default) - Hostname of the vmail database server.
  • VMAIL_DB_NAME (default: vmail) - Name of the vmail database.
  • VMAIL_DB_USER (default: vmailadmin) - Username for the vmail database.
  • VMAIL_DB_PASSWORD (not set by default) - Password for the vmail database.
  • VMAIL_DB_PORT (default: 3306) - Port of the vmail database.

Serving iRedAdmin from a subpath

If you want to serve iRedAdmin from a subpath, such as https://example.com/iredadmin, you must set the following variable:

  • REAL_SCRIPT_NAME (not set by default) - The subpath serving iRedAdmin. Example: /iredadmin.

UI configuration

  • WEBMASTER_MAIL_ADDRESS (not set by default) - Site webmaster's mail address.
  • LOCAL_TIMEZONE (default: GMT) - The default local timezone.
  • DEFAULT_LANGUAGE (default: en_US) - The default language, see https://github.com/iredmail/iRedAdmin/tree/master/i18n for the possible values.

amavisd-new cleanup tool configuration

iRedAdmin comes with a tool to clean up the amavisd-new database, you need to set the following variables to enable it:

  • AMAVISD_DB_HOST (not set by default) - Hostname of the amavisd-new database server.
  • AMAVISD_DB_NAME (default: amavisd) - Name of the amavisd-new database.
  • AMAVISD_DB_USER (default: amavisd) - Username for the amavisd-new database.
  • AMAVISD_DB_PASSWORD (not set by default) - Password for the amavisd-new database.
  • AMAVISD_DB_PORT (default: 3306) - Port of the amavisd-new database.

Misc configuration

  • DEFAULT_MTA_TRANSPORT (default: dovecot) - The default MTA transfort, see iRedMail documentation for the other possible values.
  • VMAIL_UID (default: 2000) - Must match the host vmail user id.

Database initialization

Currently, there is no automatic database initialization / change management. If your database is not already initialized, you can retrieve the SQL files with the following command: docker cp <iredadmin_container_id>:/var/www/app/SQL /tmp, then use your favorite tool to initialize the database.