Added more information about compose and Makefile usage
This commit is contained in:
parent
3d27b2a5fb
commit
718dcbca93
12
README.md
12
README.md
|
|
@ -53,13 +53,15 @@ Please also follow usage instructions of each Zabbix component image:
|
|||
> [!NOTE]
|
||||
> The following requires `make` and `docker compose` version 2.24.0 or greater.
|
||||
|
||||
A Makefile is provided that will configure and run the necessary Docker Compose files supporting a variety of base Operating System and Database engine configurations.
|
||||
You can use the Docker Compose files for MySQL and PostgreSQL (**compose.yaml** and **compose_pgsql.yaml**, respectively) directly with the ``docker compose`` command. The required images and the Compose file behavior can be configured through environment variables and the .env file. By default, Alpine-based images and the latest version from the current branch are used.
|
||||
|
||||
To get started clone this repository and then from the root directory of the repository run
|
||||
In addition, a Makefile is provided to configure and run the required Docker Compose files, supporting a variety of base operating system and database engine combinations, as well as to build Zabbix components locally.
|
||||
|
||||
To get started clone this repository and then from the root directory of the repository run:
|
||||
```
|
||||
make help
|
||||
```
|
||||
To start with the default configuration run
|
||||
To start with the default configuration run:
|
||||
```
|
||||
make up
|
||||
```
|
||||
|
|
@ -67,11 +69,13 @@ Use variables to customize the configuration to suit your needs. For example, t
|
|||
```
|
||||
make up DB=pgsql OS=alpine ZABBIX_WEB_NGINX_HTTP_PORT=8282 ZABBIX_WEB_NGINX_HTTPS_PORT=8443
|
||||
```
|
||||
Then to clean up run
|
||||
Then to clean up run:
|
||||
```
|
||||
make down DB=pgsql
|
||||
```
|
||||
|
||||
Provided compose files support several [Compose profiles](https://docs.docker.com/compose/profiles/). Minimal set of services is brought up by default, to start additional components e.g. Zabbix Agent use profile 'full' or 'all'. Additionally, it is possible to start only required components.
|
||||
|
||||
## Issues and Wiki
|
||||
|
||||
Be sure to check [the Wiki-page](https://github.com/zabbix/zabbix-docker/wiki) on common problems and questions. If you still have problems with or questions about the images, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
|
|
|||
Loading…
Reference in a new issue