Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tms0 authored Apr 16, 2021
1 parent a0c26fa commit ad5b849
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ All the basic configuration is done by environment variables, see the list below

## Environment variables configuration

#### iRedAdmin database 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
### Mail accounts backend configuration
- `DATABASE_BACKEND` (default: `ldap`) - The database backend to store mail accounts. Currently supported: `ldap`, `mysql`, `pgsql`.

__OpenLDAP backend__:
Expand All @@ -39,16 +39,16 @@ __SQL backends__:
- `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
### 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
### 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
### 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.
Expand All @@ -57,7 +57,7 @@ iRedAdmin comes with a tool to clean up the amavisd-new database, you need to se
- `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
### 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.

Expand Down

0 comments on commit ad5b849

Please sign in to comment.