forked from wazuh/wazuh-docker
82 lines
3.6 KiB
Markdown
82 lines
3.6 KiB
Markdown
# Wazuh containers for Docker
|
||
|
||
[](https://wazuh.com/community/join-us-on-slack/)
|
||
[](https://groups.google.com/forum/#!forum/wazuh)
|
||
[](https://documentation.wazuh.com)
|
||
[](https://wazuh.com)
|
||
|
||
In this repository you will find the containers to run:
|
||
|
||
* wazuh: It runs the Wazuh manager, Wazuh API and Filebeat (for integration with Elastic Stack)
|
||
* wazuh-logstash: It is used to receive alerts generated by the manager and feed Elasticsearch using an alerts template
|
||
* wazuh-kibana: Provides a web user interface to browse through alerts data. It includes Wazuh plugin for Kibana, that allows you to visualize agents configuration and status.
|
||
* wazuh-nginx: Proxies the Kibana container, adding HTTPS (via self-signed SSL certificate) and [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#Basic_authentication_scheme).
|
||
* wazuh-elasticsearch: An Elasticsearch container (working as a single-node cluster) using Elastic Stack Docker images. **Be aware to increase the `vm.max_map_count` setting, as it's detailed in the [Wazuh documentation](https://documentation.wazuh.com/current/docker/wazuh-container.html#increase-max-map-count-on-your-host-linux).**
|
||
|
||
In addition, a docker-compose file is provided to launch the containers mentioned above.
|
||
|
||
## Documentation
|
||
|
||
* [Wazuh full documentation](http://documentation.wazuh.com)
|
||
* [Wazuh documentation for Docker](https://documentation.wazuh.com/current/docker/index.html)
|
||
* [Docker hub](https://hub.docker.com/u/wazuh)
|
||
|
||
## Directory structure
|
||
|
||
wazuh-docker
|
||
├── docker-compose.yml
|
||
├── kibana
|
||
│ ├── config
|
||
│ │ ├── entrypoint.sh
|
||
│ │ └── kibana.yml
|
||
│ └── Dockerfile
|
||
├── LICENSE
|
||
├── logstash
|
||
│ ├── config
|
||
│ │ ├── 01-wazuh.conf
|
||
│ │ └── run.sh
|
||
│ └── Dockerfile
|
||
├── nginx
|
||
│ ├── config
|
||
│ │ └── entrypoint.sh
|
||
│ └── Dockerfile
|
||
├── README.md
|
||
├── CHANGELOG.md
|
||
├── VERSION
|
||
├── test.txt
|
||
└── wazuh
|
||
├── config
|
||
│ ├── data_dirs.env
|
||
│ ├── entrypoint.sh
|
||
│ ├── filebeat.runit.service
|
||
│ ├── filebeat.yml
|
||
│ ├── init.bash
|
||
│ ├── postfix.runit.service
|
||
│ ├── wazuh-api.runit.service
|
||
│ └── wazuh.runit.service
|
||
└── Dockerfile
|
||
|
||
|
||
## Branches
|
||
|
||
* `stable` branch on correspond to the latest Wazuh-Docker stable version.
|
||
* `master` branch contains the latest code, be aware of possible bugs on this branch.
|
||
* `Wazuh.Version_ElasticStack.Version` (for example 3.8.2_6.7.0) branch. This branch contains the current release referenced in Docker Hub. The container images are installed under the current version of this branch.
|
||
|
||
## Credits and Thank you
|
||
|
||
These Docker containers are based on:
|
||
|
||
* "deviantony" dockerfiles which can be found at [https://github.com/deviantony/docker-elk](https://github.com/deviantony/docker-elk)
|
||
* "xetus-oss" dockerfiles, which can be found at [https://github.com/xetus-oss/docker-ossec-server](https://github.com/xetus-oss/docker-ossec-server)
|
||
|
||
We thank you them and everyone else who has contributed to this project.
|
||
|
||
## License and copyright
|
||
|
||
Wazuh App Copyright (C) 2019 Wazuh Inc. (License GPLv2)
|
||
|
||
## Web references
|
||
|
||
[Wazuh website](http://wazuh.com)
|