wazuh-kibana-app/README.md

183 lines
10 KiB
Markdown
Raw Normal View History

2017-12-12 17:43:54 +00:00
# Wazuh Kibana App
2019-01-03 09:21:41 +00:00
[![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://wazuh.com/community/join-us-on-slack/)
2017-12-12 17:43:54 +00:00
[![Email](https://img.shields.io/badge/email-join-blue.svg)](https://groups.google.com/forum/#!forum/wazuh)
[![Documentation](https://img.shields.io/badge/docs-view-green.svg)](https://documentation.wazuh.com)
[![Documentation](https://img.shields.io/badge/web-view-green.svg)](https://wazuh.com)
Wazuh is a security detection, visibility, and compliance open source project. It was born as a fork of OSSEC HIDS, later was integrated with Elastic Stack and OpenSCAP evolving into a more comprehensive solution. You can read more in <https://wazuh.com/>
## Description
Visualize and analyze Wazuh alerts stored in Elasticsearch using our Kibana app plugin.
2018-07-27 11:28:11 +00:00
- Obtain statistics per agent, search alerts and filter by using the different visualizations.
- View the Wazuh manager configuration.
- File integrity monitoring.
## Documentation
2018-07-27 11:28:11 +00:00
- [Full documentation](https://documentation.wazuh.com)
- [Wazuh installation guide](https://documentation.wazuh.com/current/installation-guide/index.html)
- [Screenshots](https://documentation.wazuh.com/current/index.html#example-screenshots)
2018-07-30 09:21:12 +00:00
![Overview](/public/img/app.png)
2016-12-22 03:34:03 +00:00
## Requisites
2019-01-30 14:00:07 +00:00
- Wazuh HIDS 3.8.2
- Wazuh RESTful API 3.8.2
2018-12-20 08:52:57 +00:00
- Kibana 6.5.4
- Elasticsearch 6.5.4
2016-09-30 11:57:57 +00:00
2016-12-22 03:34:03 +00:00
## Installation
2016-09-30 11:57:57 +00:00
2018-07-27 11:28:11 +00:00
Install the app
```
2019-01-30 14:00:07 +00:00
sudo -u kibana NODE_OPTIONS="--max-old-space-size=3072" /usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp-3.8.2_6.5.4.zip
2018-07-27 11:28:11 +00:00
```
2018-07-27 11:29:35 +00:00
Restart Kibana
2018-07-30 09:15:04 +00:00
- Systemd:
2018-07-27 11:29:35 +00:00
```
systemctl restart kibana
2018-07-30 09:15:04 +00:00
```
- SysV Init:
2018-07-27 11:29:35 +00:00
2018-07-30 09:15:04 +00:00
```
2018-07-27 11:29:35 +00:00
service kibana restart
```
2018-07-27 11:28:11 +00:00
## Upgrade
Stop Kibana
2018-07-30 09:15:04 +00:00
- Systemd:
2018-07-27 11:28:11 +00:00
```
systemctl stop kibana
2018-07-30 09:15:04 +00:00
```
2018-07-27 11:28:11 +00:00
2018-07-30 09:15:04 +00:00
- SysV Init:
```
2018-07-27 11:28:11 +00:00
service kibana stop
```
Remove the app using kibana-plugin tool
```
/usr/share/kibana/bin/kibana-plugin remove wazuh
```
Remove generated bundles
```
rm -rf /usr/share/kibana/optimize/bundles
```
2018-10-17 09:59:18 +00:00
Update file permissions. This will avoid several errors prior to updating the app:
```
chown -R kibana:kibana /usr/share/kibana/optimize
chown -R kibana:kibana /usr/share/kibana/plugins
```
2018-07-27 11:28:11 +00:00
Install the app
```
2019-01-30 14:00:07 +00:00
sudo -u kibana NODE_OPTIONS="--max-old-space-size=3072" /usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp-3.8.2_6.5.4.zip
2018-07-27 11:28:11 +00:00
```
2018-07-27 11:29:35 +00:00
Restart Kibana
2018-07-30 09:15:04 +00:00
- Systemd:
2018-07-27 11:29:35 +00:00
```
systemctl restart kibana
2018-07-30 09:15:04 +00:00
```
- SysV Init:
2018-07-27 11:29:35 +00:00
2018-07-30 09:15:04 +00:00
```
2018-07-27 11:29:35 +00:00
service kibana restart
```
2018-07-27 11:28:11 +00:00
## Older packages
| Kibana version | Wazuh app version | Installation |
| :------------: | :---------------: | :--------------------------------------------------------------------------------------------------------- |
| 6.0.0 | 3.0.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.0.0_6.0.0.zip> |
| 6.0.1 | 3.0.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.0.0_6.0.1.zip> |
| 6.1.0 | 3.0.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.0.0_6.1.0.zip> |
| 6.1.0 | 3.1.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.1.0_6.1.0.zip> |
| 6.1.1 | 3.1.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.1.0_6.1.1.zip> |
| 6.1.2 | 3.1.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.1.0_6.1.2.zip> |
| 6.1.3 | 3.1.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.1.0_6.1.3.zip> |
| 6.1.0 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.1.0.zip> |
| 6.1.1 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.1.1.zip> |
| 6.1.2 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.1.2.zip> |
| 6.1.3 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.1.3.zip> |
| 6.2.0 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.2.0.zip> |
| 6.2.1 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.2.1.zip> |
| 6.2.2 | 3.2.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.0_6.2.2.zip> |
| 6.2.2 | 3.2.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.1_6.2.2.zip> |
| 6.2.3 | 3.2.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.1_6.2.3.zip> |
| 6.2.4 | 3.2.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.1_6.2.4.zip> |
2018-04-27 17:31:35 +00:00
| 6.2.4 | 3.2.2 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.2_6.2.4.zip> |
2018-05-28 16:30:40 +00:00
| 6.2.4 | 3.2.3 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.3_6.2.4.zip> |
2018-06-01 18:28:28 +00:00
| 6.2.4 | 3.2.4 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.2.4_6.2.4.zip> |
2018-06-11 13:48:12 +00:00
| 6.2.4 | 3.3.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.3.0_6.2.4.zip> |
2018-06-25 15:18:23 +00:00
| 6.2.4 | 3.3.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.3.1_6.2.4.zip> |
2018-06-26 17:31:52 +00:00
| 6.3.0 | 3.3.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.3.0_6.3.0.zip> |
2018-06-26 17:50:34 +00:00
| 6.3.0 | 3.3.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.3.1_6.3.0.zip> |
2018-07-24 20:51:33 +00:00
| 6.3.1 | 3.3.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.3.1_6.3.1.zip> |
| 6.3.1 | 3.4.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.4.0_6.3.1.zip> |
2018-07-27 11:28:11 +00:00
| 6.3.2 | 3.4.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.4.0_6.3.2.zip> |
2018-08-09 16:52:16 +00:00
| 6.3.2 | 3.5.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.5.0_6.3.2.zip> |
| 6.4.0 | 3.5.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.5.0_6.4.0.zip> |
2018-08-30 07:26:54 +00:00
| 6.3.2 | 3.6.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.0_6.3.2.zip> |
| 6.4.0 | 3.6.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.0_6.4.0.zip> |
| 6.3.2 | 3.6.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.1_6.3.2.zip> |
| 6.4.0 | 3.6.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.1_6.4.0.zip> |
2018-10-04 09:23:50 +00:00
| 6.4.1 | 3.6.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.1_6.4.1.zip> |
| 6.4.2 | 3.6.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.1_6.4.2.zip> |
2018-11-08 09:05:55 +00:00
| 6.4.3 | 3.6.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.6.1_6.4.3.zip> |
2018-11-10 10:52:34 +00:00
| 6.4.2 | 3.7.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.0_6.4.2.zip> |
2018-11-08 09:05:55 +00:00
| 6.4.3 | 3.7.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.0_6.4.3.zip> |
2018-11-13 16:30:47 +00:00
| 6.5.0 | 3.7.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.0_6.5.0.zip> |
2018-11-26 08:40:48 +00:00
| 6.5.1 | 3.7.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.0_6.5.1.zip> |
| 6.5.1 | 3.7.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.1_6.5.1.zip> |
2018-12-10 13:17:37 +00:00
| 6.5.2 | 3.7.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.1_6.5.2.zip> |
2018-12-13 08:43:52 +00:00
| 6.5.3 | 3.7.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.1_6.5.3.zip> |
2018-12-14 13:48:53 +00:00
| 6.5.3 | 3.7.2 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.2_6.5.3.zip> |
2018-12-20 08:52:57 +00:00
| 6.5.4 | 3.7.2 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.7.2_6.5.4.zip> |
2019-01-18 20:17:14 +00:00
| 6.5.4 | 3.8.0 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.8.0_6.5.4.zip> |
2019-01-24 17:01:03 +00:00
| 6.5.4 | 3.8.1 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.8.1_6.5.4.zip> |
2019-01-30 14:00:07 +00:00
| 6.5.4 | 3.8.2 | /usr/share/kibana/bin/kibana-plugin install <https://packages.wazuh.com/wazuhapp/wazuhapp-3.8.2_6.5.4.zip> |
2018-12-13 08:43:52 +00:00
2016-12-22 03:34:03 +00:00
## Contribute
If you want to contribute to our project please don't hesitate to send a pull request. You can also join our users [mailing list](https://groups.google.com/d/forum/wazuh), by sending an email to <mailto:wazuh+subscribe@googlegroups.com>, to ask questions and participate in discussions.
2016-12-22 03:34:03 +00:00
## Software and libraries used
2018-07-27 11:28:11 +00:00
- https://elastic.co
- https://material.angularjs.org
- https://angularjs.org
- https://nodejs.org
- https://npmjs.com
## Copyright & License
2019-01-18 22:57:57 +00:00
Copyright &copy; 2019 Wazuh, Inc.
2016-12-22 03:34:03 +00:00
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
2016-12-22 03:34:03 +00:00
Find more information about this on the [LICENSE](LICENSE) file.