wazuh-kibana-app/README.md

75 lines
3.4 KiB
Markdown
Raw Normal View History

2016-12-22 03:34:03 +00:00
# Wazuh - Kibana App
## Requisites
2017-01-18 13:06:11 +00:00
- Wazuh HIDS 2.0 or superior
- Wazuh RESTful API 2.0 or superior
2017-03-03 17:06:14 +00:00
- Kibana 5.2.2 or superior
2016-12-22 03:34:03 +00:00
- Elasticsearch 5 or superior
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
2017-03-03 17:06:14 +00:00
| Kibana version | Installation |
| :---: | :--- |
| 5.2.2 | /usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp-2.0_5.2.2.zip |
2017-01-18 13:06:11 +00:00
```/usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp.zip ```
2016-09-30 11:58:46 +00:00
2016-12-22 03:34:03 +00:00
## Upgrading
2016-09-30 11:58:46 +00:00
2017-03-03 17:06:14 +00:00
Remove the App using kibana-plugin tool
2016-09-30 11:58:46 +00:00
```/usr/share/kibana/bin/kibana-plugin remove wazuh ```
2016-09-30 11:57:57 +00:00
2017-03-03 17:06:14 +00:00
Install the App
```/usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp-2.0_5.x.x.zip ```
2016-12-22 03:34:03 +00:00
## Wazuh Open Source modules and contributions
* [OSSEC Wazuh Ruleset](http://documentation.wazuh.com/en/latest/ossec_ruleset.html): Includes compliance mapping with PCI DSS v3.1, CIS and additional decoders and rules. Users can contribute to this rule set by submitting pull requests to our [Github repository](https://github.com/wazuh/wazuh-ruleset). Our team will continue to maintain and update it periodically.
* [Wazuh fork](http://documentation.wazuh.com/en/latest/ossec_wazuh.html) with extended JSON logging capabilities, for easy [integration with ELK Stack](http://documentation.wazuh.com/en/latest/ossec_elk.html) and third party log management tools. The manager also include modifications in OSSEC binaries needed by the [OSSEC Wazuh RESTful API](http://documentation.wazuh.com/en/latest/ossec_api.html).
* [Wazuh RESTful API](http://documentation.wazuh.com/en/latest/ossec_api.html): Used to monitor and control your OSSEC installation, providing an interface to interact with the manager from anything that can send an HTTP request.
* [Pre-compiled installation packages](http://documentation.wazuh.com/en/latest/ossec_installation.html), both for OSSEC agent and manager: Include repositories for RedHat, CentOS, Fedora, Debian, Ubuntu and Windows.
* [Puppet scripts](http://documentation.wazuh.com/en/latest/ossec_puppet.html) for automatic OSSEC deployment and configuration.
* [Docker containers](http://documentation.wazuh.com/en/latest/ossec_docker.html) to virtualize and run your OSSEC manager and an all-in-one integration with ELK Stack.
## Documentation
* [Full documentation](http://documentation.wazuh.com)
* [Wazuh installation guide](http://documentation.wazuh.com/en/latest/wazuh_installation.html)
## Branches
* `stable` branch on correspond to the last stable version.
* `master` branch contains the latest code, be aware of possible bugs on this branch.
* `development` branch includes all the new features we're adding and testing.
## 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 [wazuh+subscribe@googlegroups.com](mailto:wazuh+subscribe@googlegroups.com), to ask questions and participate in discussions.
## Software and libraries used
* API from Elastic and Kibana (elastic.co).
* Angular Material (material.angularjs.org).
2016-12-22 03:34:30 +00:00
* Bootstrap (getbootstrap.com).
* AngularJS.
2016-12-22 03:34:03 +00:00
* Node.js (Ryan Dahl).
* NPM packages Angular animate, aria, cookies, md5, needle and cron.
## License and copyright
Wazuh App Copyright (C) 2016 Wazuh Inc. (License GPLv2)
## References
2017-01-11 11:02:25 +00:00
* [Wazuh website](https://wazuh.com)
2016-12-22 03:34:03 +00:00
* [Wazuh documentation](http://documentation.wazuh.com)
2017-01-11 11:02:25 +00:00
* [Elastic stack](https://elastic.co)