volker.raschek/postfixadmin-docker
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

docs(README): adapt line length
All checks were successful
Lint Markdown files / markdown-lint (push) Successful in 11s
Details
Update Docker Hub Description / update-description-on-hub-docker-io (push) Successful in 15s
Details
Build / build-amd64 (push) Successful in 1m2s
Details
Build / build-arm64 (push) Successful in 4m37s
Details

Browse Source
This commit is contained in:
Markus Pesch 2025-05-13 19:13:33 +02:00
parent 4a9c482b17
commit fff4a90054
Signed by: volker.raschek
GPG Key ID: 852BCC170D81A982
1 changed files with 61 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
README.md
View File

@ -6,21 +6,17 @@
This is an alternative project to build a container image for This is an alternative project to build a container image for
[PostfixAdmin](https://github.com/postfixadmin/postfixadmin). [PostfixAdmin](https://github.com/postfixadmin/postfixadmin).
The main goal of this alternative image is to support a kubernetes deployment The main goal of this alternative image is to support a kubernetes deployment via helm. Furthermore, the container image
via helm. Furthermore, the container image support configuring via [environment support configuring via [environment variables](#supported-environment-variables).
variables](#supported-environment-variables).
To deploy PostfixAdmin via `helm` checkout the repository on To deploy PostfixAdmin via `helm` checkout the repository on
[artifacthub.io](https://artifacthub.io/packages/helm/volker-raschek/postfixadmin) [artifacthub.io](https://artifacthub.io/packages/helm/volker-raschek/postfixadmin) for more details.
for more details.
## Supported environment variables ## Supported environment variables
This list is an overview over some important environment variables. The This list is an overview over some important environment variables. The environment variables are composed on the key of
environment variables are composed on the key of the PHP configuration with the the PHP configuration with the prefix `POSTFIXADMIN_`. You can take an example
prefix `POSTFIXADMIN_`. You can take an example [configuration](https://github.com/postfixadmin/postfixadmin/blob/master/config.inc.php) from the upstream project.
[configuration](https://github.com/postfixadmin/postfixadmin/blob/master/config.inc.php)
from the upstream project.
| name | default | | name | default |
| ----------------------------------- | ------------------------------------------- | | ----------------------------------- | ------------------------------------------- |
@ -50,33 +46,27 @@ from the upstream project.
### POSTFIXADMIN_ADMIN_EMAIL ### POSTFIXADMIN_ADMIN_EMAIL
Define the email address of an admin via `POSTFIXADMIN_ADMIN_EMAIL` to send Define the email address of an admin via `POSTFIXADMIN_ADMIN_EMAIL` to send emails or broadcast messages in his name
emails or broadcast messages in his name instead of the email address of the instead of the email address of the logged in admin, which wants to send an email or broadcast message about the
logged in admin, which wants to send an email or broadcast message about the PostfixAdmin interface. By default is the environment variable not defined. The value of the environment will be
PostfixAdmin interface. By default is the environment variable not defined. The configured as the following config setting: `$CONF['admin_email']`.
value of the environment will be configured as the following config setting:
`$CONF['admin_email']`.
### POSTFIXADMIN_ADMIN_SMTP_PASSWORD ### POSTFIXADMIN_ADMIN_SMTP_PASSWORD
Define the smtp password via `POSTFIXADMIN_ADMIN_SMTP_PASSWORD` of the admin Define the smtp password via `POSTFIXADMIN_ADMIN_SMTP_PASSWORD` of the admin which should be used to send emails or
which should be used to send emails or broadcast messages about the PostfixAdmin broadcast messages about the PostfixAdmin interface. By default is the environment variable not defined. The value of
interface. By default is the environment variable not defined. The value of the the environment will be configured as the following config setting: `$CONF['admin_smtp_password']`.
environment will be configured as the following config setting:
`$CONF['admin_smtp_password']`.
### POSTFIXADMIN_ADMIN_NAME ### POSTFIXADMIN_ADMIN_NAME
Define the name of the admin via `POSTFIXADMIN_ADMIN_NAME` which should be used Define the name of the admin via `POSTFIXADMIN_ADMIN_NAME` which should be used to send emails or broadcast messages
to send emails or broadcast messages about the PostfixAdmin interface. By about the PostfixAdmin interface. By default is the environment variable not defined. The value of the environment will
default is the environment variable not defined. The value of the environment be configured as the following config setting: `$CONF['admin_name']`.
will be configured as the following config setting: `$CONF['admin_name']`.
### POSTFIXADMIN_DATABASE_TYPE ### POSTFIXADMIN_DATABASE_TYPE
PostfixAdmin support currently sqlite, postgres and mysql/mariadb. About the PostfixAdmin support currently sqlite, postgres and mysql/mariadb. About the envrionment variable
envrionment variable `POSTFIXADMIN_DATABASE_TYPE` can the backend type defined. `POSTFIXADMIN_DATABASE_TYPE` can the backend type defined. The default value is `sqlite`.
The default value is `sqlite`.
| database type | value | | database type | value |
| ------------- | --------- | | ------------- | --------- |
@ -86,27 +76,23 @@ The default value is `sqlite`.
### POSTFIXADMIN_DATABASE_USER ### POSTFIXADMIN_DATABASE_USER
The environment variable `POSTFIXADMIN_DATABASE_USER` is undefined and only The environment variable `POSTFIXADMIN_DATABASE_USER` is undefined and only required if the database backend is not
required if the database backend is not `sqlite`. The value of the environment `sqlite`. The value of the environment will be configured as the following config setting: `$CONF['database_user']`.
will be configured as the following config setting: `$CONF['database_user']`.
### POSTFIXADMIN_DATABASE_PASSWORD ### POSTFIXADMIN_DATABASE_PASSWORD
The environment variable `POSTFIXADMIN_DATABASE_PASSWORD` is undefined and only The environment variable `POSTFIXADMIN_DATABASE_PASSWORD` is undefined and only required if the database backend is not
required if the database backend is not `sqlite`. The value of the environment `sqlite`. The value of the environment will be configured as the following config setting: `$CONF['database_password']`.
will be configured as the following config setting: `$CONF['database_password']`.
### POSTFIXADMIN_DATABASE_HOST ### POSTFIXADMIN_DATABASE_HOST
The environment variable `POSTFIXADMIN_DATABASE_HOST` is undefined and only The environment variable `POSTFIXADMIN_DATABASE_HOST` is undefined and only required if the database backend is not
required if the database backend is not `sqlite`. The value of the environment `sqlite`. The value of the environment will be configured as the following config setting: `$CONF['database_host']`.
will be configured as the following config setting: `$CONF['database_host']`.
### POSTFIXADMIN_DATABASE_PORT ### POSTFIXADMIN_DATABASE_PORT
The environment variable `POSTFIXADMIN_DATABASE_PORT` will automatically defined The environment variable `POSTFIXADMIN_DATABASE_PORT` will automatically defined with default values when instead of
with default values when instead of `sqlite` an other database backend has been `sqlite` an other database backend has been selected. The value of the environment will be configured as the following
selected. The value of the environment will be configured as the following
config setting: `$CONF['database_port']`. config setting: `$CONF['database_port']`.
| database type | default port | | database type | default port |
@ -116,96 +102,81 @@ config setting: `$CONF['database_port']`.
### POSTFIXADMIN_DATABASE_NAME ### POSTFIXADMIN_DATABASE_NAME
The environment variable `POSTFIXADMIN_DATABASE_NAME` is defined by default with The environment variable `POSTFIXADMIN_DATABASE_NAME` is defined by default with the value `/var/tmp/postfixadmin.db`.
the value `/var/tmp/postfixadmin.db`. This is the path where the `sqlite` This is the path where the `sqlite` database is stored. If `pgsql` or `mysqli` is defined instead of `sqlite` as
database is stored. If `pgsql` or `mysqli` is defined instead of `sqlite` as database backend type, can the environment variable used to define the database name. The value of the environment will
database backend type, can the environment variable used to define the database be configured as the following config setting: `$CONF['database_name']`.
name. The value of the environment will be configured as the following config
setting: `$CONF['database_name']`.
### POSTFIXADMIN_DATABASE_USE_SSL ### POSTFIXADMIN_DATABASE_USE_SSL
Encrypt a database connection to an external database like postgres, mariadb or Encrypt a database connection to an external database like postgres, mariadb or mysqli via SSL when
mysqli via SSL when `POSTFIXADMIN_DATABASE_USE_SSL=true`. Additionally should be `POSTFIXADMIN_DATABASE_USE_SSL=true`. Additionally should be the other SSL environment variables defined to establish
the other SSL environment variables defined to establish successfully a SSL successfully a SSL encrypted connection. The value of the environment will be configured as the following config
encrypted connection. The value of the environment will be configured as the setting: `$CONF['database_use_ssl']`.
following config setting: `$CONF['database_use_ssl']`.
### POSTFIXADMIN_DATABASE_SSL_KEY ### POSTFIXADMIN_DATABASE_SSL_KEY
Via `POSTFIXADMIN_DATABASE_SSL_KEY` can be the path to the private key defined Via `POSTFIXADMIN_DATABASE_SSL_KEY` can be the path to the private key defined which should be used to encrypt the
which should be used to encrypt the database connection via SSL. By default is database connection via SSL. By default is this environment variable undefined. The value of the environment will be
this environment variable undefined. The value of the environment will be
configured as the following config setting: `$CONF['database_ssl_key']`. configured as the following config setting: `$CONF['database_ssl_key']`.
### POSTFIXADMIN_DATABASE_SSL_CERT ### POSTFIXADMIN_DATABASE_SSL_CERT
Via `POSTFIXADMIN_DATABASE_SSL_CERT` can be the path to the certificate defined Via `POSTFIXADMIN_DATABASE_SSL_CERT` can be the path to the certificate defined which should be used to encrypt the
which should be used to encrypt the database connection via SSL. By default is database connection via SSL. By default is this environment variable undefined. The value of the environment will be
this environment variable undefined. The value of the environment will be
configured as the following config setting: `$CONF['database_ssl_cert']`. configured as the following config setting: `$CONF['database_ssl_cert']`.
### POSTFIXADMIN_DATABASE_SSL_CA ### POSTFIXADMIN_DATABASE_SSL_CA
Via `POSTFIXADMIN_DATABASE_SSL_CA` can be the path to the root certificate of Via `POSTFIXADMIN_DATABASE_SSL_CA` can be the path to the root certificate of the certificate authority defined which
the certificate authority defined which should be trusted to encrypt the database should be trusted to encrypt the database connection via SSL. By default is this environment variable undefined. The
connection via SSL. By default is this environment variable undefined. The value value of the environment will be configured as the following config setting: `$CONF['database_ssl_ca']`.
of the environment will be configured as the following config setting:
`$CONF['database_ssl_ca']`.
### POSTFIXADMIN_DATABASE_PREFIX ### POSTFIXADMIN_DATABASE_PREFIX
It make much sense to use a prefix name for all PostfixAdmin related tables, It make much sense to use a prefix name for all PostfixAdmin related tables, when the tables, views and so on should be
when the tables, views and so on should be stored into a shared schema like stored into a shared schema like `public`. About the environment variable `POSTFIXADMIN_DATABASE_PREFIX` can such a
`public`. About the environment variable `POSTFIXADMIN_DATABASE_PREFIX` can such prefix defined. By default is this variable undefined, but when not it results in the config setting
a prefix defined. By default is this variable undefined, but when not it results `$CONF['database_prefix']`.
in the config setting `$CONF['database_prefix']`.
### POSTFIXADMIN_DEFAULT_LANGUAGE ### POSTFIXADMIN_DEFAULT_LANGUAGE
Default language of PostfixAdmin. Checkout the [official Default language of PostfixAdmin. Checkout the [official
repository](https://github.com/postfixadmin/postfixadmin/tree/master/languages) repository](https://github.com/postfixadmin/postfixadmin/tree/master/languages) under `./languages` to get a list of all
under `./languages` to get a list of all supported languages. supported languages.
### POSTFIXADMIN_ENCRYPT ### POSTFIXADMIN_ENCRYPT
Via `POSTFIXADMIN_ENCRYPT` can be the algorithm specified to encrypt passwords Via `POSTFIXADMIN_ENCRYPT` can be the algorithm specified to encrypt passwords of users. The algorithm `md5crypt` is
of users. The algorithm `md5crypt` is defined as default. Other possible values defined as default. Other possible values are documented
are documented
[here](https://github.com/postfixadmin/postfixadmin/blob/master/DOCUMENTS/HASHING.md). [here](https://github.com/postfixadmin/postfixadmin/blob/master/DOCUMENTS/HASHING.md).
### POSTFIXADMIN_SETUP_PASSWORD ### POSTFIXADMIN_SETUP_PASSWORD
To login into the `setup.php` page is the setup password required. This can be To login into the `setup.php` page is the setup password required. This can be defined via the variable
defined via the variable `POSTFIXADMIN_SETUP_PASSWORD`. The password will be `POSTFIXADMIN_SETUP_PASSWORD`. The password will be hashed via bcrypt and used as value for the setting
hashed via bcrypt and used as value for the setting `$CONF['setup_password']` in `$CONF['setup_password']` in the config file `config.local.php`.
the config file `config.local.php`.
### POSTFIXADMIN_SMTP_CLIENT ### POSTFIXADMIN_SMTP_CLIENT
Hostname (FQDN) of the server hosting PostfixAdmin used in the `HELO` when Hostname (FQDN) of the server hosting PostfixAdmin used in the `HELO` when sending emails from PostfixAdmin. The value
sending emails from PostfixAdmin. The value of the environment will be of the environment will be configured as the following config setting and is empty by default: `$CONF['smtp_client']`.
configured as the following config setting and is empty by default:
`$CONF['smtp_client']`.
### POSTFIXADMIN_SMTP_SERVER ### POSTFIXADMIN_SMTP_SERVER
Hostname (FQDN) of your mail server. The default value is `localhost`. The value Hostname (FQDN) of your mail server. The default value is `localhost`. The value of the environment will be configured
of the environment will be configured as the following config setting: as the following config setting: `$CONF['smtp_server']`.
`$CONF['smtp_server']`.
### POSTFIXADMIN_SMTP_PORT ### POSTFIXADMIN_SMTP_PORT
Port of your mail server. The default value is `25`. The value of the Port of your mail server. The default value is `25`. The value of the environment will be configured as the following
environment will be configured as the following config setting: config setting: `$CONF['smtp_port']`.
`$CONF['smtp_port']`.
### POSTFIXADMIN_SHOW_FOOTER_TEXT ### POSTFIXADMIN_SHOW_FOOTER_TEXT
Enable or disable via `YES` or `NO` the footer text displayed on all sites. Use Enable or disable via `YES` or `NO` the footer text displayed on all sites. Use `POSTFIXADMIN_FOOTER_TEXT` and
`POSTFIXADMIN_FOOTER_TEXT` and `POSTFIX_FOOTER_LINK` to customize the text. `POSTFIX_FOOTER_LINK` to customize the text.
### POSTFIXADMIN_FETCHMAIL ### POSTFIXADMIN_FETCHMAIL
Enable or disable via `YES` or `NO` the fetchmail tab. It has nothing todo with Enable or disable via `YES` or `NO` the fetchmail tab. It has nothing todo with the fetchmail cron job.
the fetchmail cron job.