# What is Zabbix?

Zabbix is an enterprise-class open source distributed monitoring solution.

Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.

For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com

# What is Zabbix web interface?

Zabbix web interface is a part of Zabbix software. It is used to manage resources under monitoring and view monitoring statistics.

# Zabbix web interface images

These are the only official Zabbix web interface Podman images. Images are updated when new releases are published.

Zabbix web interface available in four editions:

- Zabbix web-interface based on Apache2 web server with MySQL database support
- Zabbix web-interface based on Apache2 web server with PostgreSQL database support
- Zabbix web-interface based on Nginx web server with MySQL database support
- Zabbix web-interface based on Nginx web server with PostgreSQL database support

The image based on Nginx web server with PostgreSQL database support.

# How to use this image

## Start `zabbix-web-nginx-pgsql`

Start a Zabbix web-interface container as follows:

    podman run --name some-zabbix-web-nginx-pgsql -e DB_SERVER_HOST="some-postgres-server" -e POSTGRES_USER="some-user" -e POSTGRES_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e PHP_TZ="some-timezone" -d zabbix/zabbix-web-nginx-pgsql:tag

Where `some-zabbix-web-nginx-pgsql` is the name you want to assign to your container, `some-postgres-server` is IP or DNS name of PostgreSQL server, `some-user` is user to connect to Zabbix database on PostgreSQL server, `some-password` is the password to connect to PostgreSQL server, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy, `some-timezone` is PHP like timezone name and `tag` is the tag specifying the version you want.

## Linking the container to Zabbix server

    podman run --name some-zabbix-web-nginx-pgsql --link some-zabbix-server:zabbix-server -e DB_SERVER_HOST="some-postgres-server" -e POSTGRES_USER="some-user" -e POSTGRES_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e PHP_TZ="some-timezone" -d zabbix/zabbix-web-nginx-pgsql:tag

## Linking the container to PostgreSQL database

    podman run --name some-zabbix-web-nginx-pgsql --link some-postgres-server:postgres -e DB_SERVER_HOST="some-postgres-server" -e POSTGRES_USER="some-user" -e POSTGRES_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e PHP_TZ="some-timezone" -d zabbix/zabbix-web-nginx-pgsql:tag

## Container shell access and viewing Zabbix web interface logs

The `podman exec` command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your `zabbix-web-nginx-pgsql` container:

    $ podman exec -ti some-zabbix-web-nginx-pgsql /bin/bash

The Zabbix web interface log is available through Podman's container log:

    $ podman logs  some-zabbix-web-nginx-pgsql

## Environment Variables

When you start the `zabbix-web-nginx-pgsql` image, you can adjust the configuration of the Zabbix web interface by passing one or more environment variables on the `podman run` command line.

### `ZBX_SERVER_HOST`

This variable is IP or DNS name of Zabbix server. By default, value is `zabbix-server`.

### `ZBX_SERVER_PORT`

This variable is port Zabbix server listening on. By default, value is `10051`.

### `DB_SERVER_HOST`

This variable is IP or DNS name of PostgreSQL server. By default, value is 'postgres-server'

### `DB_SERVER_PORT`

This variable is port of PostgreSQL server. By default, value is '5432'.

### `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_USER_FILE`, `POSTGRES_PASSWORD_FILE`

These variables are used by Zabbix web interface to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `POSTGRES_USER` or `POSTGRES_USER_FILE`!

    podman run --name some-zabbix-web-nginx-pgsql -e DB_SERVER_HOST="some-postgres-server" -v ./.POSTGRES_USER:/run/secrets/POSTGRES_USER -e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER -v ./.POSTGRES_PASSWORD:/run/secrets/POSTGRES_PASSWORD -e POSTGRES_PASSWORD_FILE=/var/run/secrets/POSTGRES_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e PHP_TZ="some-timezone" -d zabbix/zabbix-web-nginx-pgsql:tag

With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!

    printf "zabbix" | podman secret create POSTGRES_USER -
    printf "zabbix" | podman secret create POSTGRES_PASSWORD -
    podman run --name some-zabbix-web-nginx-pgsql -e DB_SERVER_HOST="some-postgres-server" -e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER -e POSTGRES_PASSWORD_FILE=/run/secrets/POSTGRES_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e PHP_TZ="some-timezone" -d zabbix/zabbix-web-nginx-pgsql:tag

By default, values for `POSTGRES_USER` and `POSTGRES_PASSWORD` are `zabbix`, `zabbix`.

### `POSTGRES_DB`

The variable is Zabbix database name. By default, value is `zabbix`.

### `POSTGRES_USE_IMPLICIT_SEARCH_PATH`

In some setups, for example including PgBouncer, setting the `search_path` via connection parameters fails. If this variable is set to `"true"`, the image skips setting the `search_path` and trusts that the `search_path` of the Zabbix user is setup correctly in PostgreSQL database.

### `ZBX_HISTORYSTORAGEURL`

History storage HTTP[S] URL. This parameter is used for Elasticsearch setup. Available since 3.4.5.

### `ZBX_HISTORYSTORAGETYPES`

Array of value types to be sent to the history storage. An example: ['uint', 'dbl']. This parameter is used for Elasticsearch setup. Available since 3.4.5.

### `PHP_TZ`

The variable is timezone in PHP format. Full list of supported timezones are available on `php.net`. By default, value is 'Europe/Riga' and system timezone since Zabbix 5.2.0.

### `ZBX_SERVER_NAME`

The variable is visible Zabbix installation name in right or left top corner of the web interface.

### `DB_DOUBLE_IEEE754`

Use IEEE754 compatible value range for 64-bit Numeric (float) history values. Available since 5.0.0. Enabled by default.

### `ENABLE_WEB_ACCESS_LOG`

The variable sets the Access Log directive for Web server. By default, value corresponds to standard output.

### `HTTP_INDEX_FILE`

The variable controls default index page. By default, `index.php`.

### `EXPOSE_WEB_SERVER_INFO`

The variable allows to hide Web server and PHP versions. By default, `on`.

### `ZBX_MAXEXECUTIONTIME`

The varable is PHP `max_execution_time` option. By default, value is `300`.

### `ZBX_MEMORYLIMIT`

The varable is PHP `memory_limit` option. By default, value is `128M`.

### `ZBX_POSTMAXSIZE`

The varable is PHP `post_max_size` option. By default, value is `16M`.

### `ZBX_UPLOADMAXFILESIZE`

The varable is PHP `upload_max_filesize` option. By default, value is `2M`.

### `ZBX_MAXINPUTTIME`

The varable is PHP `max_input_time` option. By default, value is `300`.

### `ZBX_SESSION_NAME`

The variable is Zabbix frontend definition. String used as the name of the Zabbix frontend session cookie. By default, value is `zbx_sessionid`.

### `ZBX_DENY_GUI_ACCESS`

Enable (`true`) maintenance mode for Zabbix web-interface.

### `ZBX_GUI_ACCESS_IP_RANGE`

Array of IP addresses which are allowed for accessing to Zabbix web-interface during maintenance period.

### `ZBX_GUI_WARNING_MSG`

Information message about maintenance period for Zabbix web-interface.

### `ZBX_DB_ENCRYPTION`

The variable allows to activate encryption for connections to Zabbix database. Even if no other environment variables are specified, connections will be TLS-encrypted if `ZBX_DB_ENCRYPTION=true` specified. Available since 5.0.0. Disabled by default.

### `ZBX_DB_KEY_FILE`

The variable allows to specify the full path to a valid TLS key file. Available since 5.0.0.

### `ZBX_DB_CERT_FILE`

The variable allows to specify the full path to a valid TLS certificate file. Available since 5.0.0.

### `ZBX_DB_CA_FILE`

The variable allows to specify the full path to a valid TLS certificate authority file. Available since 5.0.0.

### `ZBX_DB_VERIFY_HOST`

The variable allows to activate host verification. Available since 5.0.0.

### `ZBX_SSO_SP_KEY`

The variable allows to specify a custom file path to the Serivce Provider (SP) private key file.

### `ZBX_SSO_SP_CERT`

The variable allows to specify a custom file path to the Serivce Provider (SP) cert file.

### `ZBX_SSO_IDP_CERT`

The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file.

## `ZBX_SSO_SETTINGS`

The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0.

Example of YAML Mapping to Sequences

###

    ....
      environment:
        ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}"
        ....
    ....
    ZBX_ALLOW_HTTP_AUTH
    The variable allows to disable user HTTP authentication.

### Other variables

Additionally the image allows to specify many other environment variables listed below:

    ZBX_VAULTDBPATH= # Available since 5.2.0
    ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
    VAULT_TOKEN= # Available since 5.2.0

    Allowed PHP-FPM configuration options:
    PHP_FPM_PM=dynamic
    PHP_FPM_PM_MAX_CHILDREN=50
    PHP_FPM_PM_START_SERVERS=5
    PHP_FPM_PM_MIN_SPARE_SERVERS=5
    PHP_FPM_PM_MAX_SPARE_SERVERS=35
    PHP_FPM_PM_MAX_REQUESTS=0

## Allowed volumes for the Zabbix web interface container

### `/etc/ssl/nginx`

The volume allows to enable HTTPS for the Zabbix web interface. The volume must contains three files `ssl.crt`, `ssl.key` and `dhparam.pem` prepared for Nginx SSL connections.

Please follow official Nginx documentation to get more details about how to create certificate files.

### `/etc/zabbix/web/certs`

The volume allows to use custom certificates for SAML authentification. The volume must contains three files `sp.key`, `sp.crt` and `idp.crt`. Available since 5.0.0.

# User Feedback

## Documentation

Documentation for this image is stored in the `web-nginx-pgsql/` directory of the `zabbix/zabbix-docker` GitHub repo. Be sure to familiarize yourself with the repository's `README.md` file before attempting a pull request.

## Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

### Known issues

## Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.