mirror of
https://github.com/zabbix/zabbix-docker.git
synced 2024-11-15 20:34:48 +01:00
167 lines
8.8 KiB
Markdown
167 lines
8.8 KiB
Markdown
|
|
|
|
# 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 Docker images. They are based on latest Alpine and trusty Ubuntu images. The available versions of Zabbix web interface are:
|
|
|
|
Zabbix web interface 3.0 (tags: alpine-3.0-latest, ubuntu-3.0-latest, alpine-latest, ubuntu-latest, latest)
|
|
Zabbix web interface 3.0.* (tags: alpine-3.0.*, ubuntu-3.0.*)
|
|
Zabbix web interface 3.1 (tags: alpine-trunk, ubuntu-trunk)
|
|
|
|
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
|
|
|
Zabbix web interface available in three editions:
|
|
- Zabbix web-interface based on Apache web server with MySQL 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
|
|
|
|
# How to use this image
|
|
|
|
## Start `zabbix-web-apache-mysql`
|
|
|
|
Start a Zabbix web-interface container as follows:
|
|
|
|
docker run --name some-zabbix-web-apache-mysql -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e TZ="some-timezone" -d zabbix/zabbix-web-apache-mysql:tag
|
|
|
|
Where `some-zabbix-web-apache-mysql` is the name you want to assign to your container, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL 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. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-web-apache-mysql/tags/).
|
|
|
|
## Linking the container to Zabbix server
|
|
|
|
docker run --name some-zabbix-web-apache-mysql --link some-zabbix-server:zabbix-server -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e TZ="some-timezone" -d zabbix/zabbix-web-apache-mysql:tag
|
|
|
|
## Linking the container to MySQL database
|
|
|
|
docker run --name some-zabbix-web-apache-mysql --link some-mysql-server:mysql -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_SERVER_HOST="some-zabbix-server" -e TZ="some-timezone" -d zabbix/zabbix-web-apache-mysql:tag
|
|
|
|
## Container shell access and viewing Zabbix web interface logs
|
|
|
|
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-web-apache-mysql` container:
|
|
|
|
```console
|
|
$ docker exec -ti some-zabbix-web-apache-mysql /bin/bash/
|
|
```
|
|
|
|
The Zabbix web interface log is available through Docker's container log:
|
|
|
|
```console
|
|
$ docker logs some-zabbix-web-apache-mysql
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
When you start the `zabbix-web-apache-mysql` image, you can adjust the configuration of the Zabbix web interface by passing one or more environment variables on the `docker 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 MySQL server. By default, value is 'mysql-server'
|
|
|
|
### ``DB_SERVER_PORT``
|
|
|
|
This variable is port of MySQL server. By default, value is '3306'.
|
|
|
|
### `MYSQL_USER`, `MYSQL_PASSWORD`
|
|
|
|
These variables are used by Zabbix web interface to connect to Zabbix database. By default, values are `zabbix`, `zabbix`.
|
|
|
|
### `MYSQL_DATABASE`
|
|
|
|
The variable is Zabbix database name. By default, value is `zabbix`.
|
|
|
|
### `TZ`
|
|
|
|
The variable is timezone in PHP format. Full list of supported timezones are available on [`php.net`](http://php.net/manual/en/timezones.php). By default, value is 'Europe/Riga'.
|
|
|
|
### `ZBX_SERVER_NAME`
|
|
|
|
The variable is visible Zabbix installation name in right top corner of the web interface.
|
|
|
|
### `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`.
|
|
|
|
## Allowed volumes for the Zabbix web interface container
|
|
|
|
### ``/etc/ssl/apache2``
|
|
|
|
The volume allows to enable HTTPS for the Zabbix web interface. The volume must contains two files ``ssl.crt`` and ``ssl.key`` prepared for Apache2 SSL connections.
|
|
|
|
Please follow official Apache2 [documentation](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html) to get more details about how to create certificate files.
|
|
|
|
# The image variants
|
|
|
|
The `zabbix-web-apache-mysql` images come in many flavors, each designed for a specific use case.
|
|
|
|
## `zabbix-web-apache-mysql:ubuntu-<version>`
|
|
|
|
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
|
|
|
## `zabbix-web-apache-mysql:alpine-<version>`
|
|
|
|
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
|
|
|
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
|
|
|
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
|
|
|
# Supported Docker versions
|
|
|
|
This image is officially supported on Docker version 1.12.0.
|
|
|
|
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
|
|
|
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
|
|
|
# User Feedback
|
|
|
|
## Documentation
|
|
|
|
Documentation for this image is stored in the [`web-apache-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/web-apache-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
|
|
|
## Issues
|
|
|
|
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
|
|
|
### 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](https://github.com/zabbix/zabbix-docker/issues), 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.
|