Browse Source

ADD: updated README.md

master
Dominik Meyer 2 years ago
parent
commit
8574790775
Signed by: byterazor
GPG Key ID: B4C312B600606B64
  1. 54
      README.md

54
README.md

@ -2,16 +2,60 @@ @@ -2,16 +2,60 @@
## Description
OSSEC Active Response script to send jabber messages through sendxmpp.
This is an active response script for OSSEC(https://www.ossec.net/), written in perl,
to send jabber(xmpp) messages of certain alerts.
## Author
Dominik Meyer <dmeyer@federationhq.de>
## Requirements
- Perl
- sendxmpp program
- OSSEC Perl Module
## INSTALL
coming soon
### Stable Version
The stable version can always be installed from CPAN using the *cpan*
tool of your linux distribution.
### Git install
For installing fresh from the git repository you need a perl installation including the Dist::Zilla package. The use of plenv(https://github.com/tokuhirom/plenv) is encouraged.
```{r, engine='bash', code_block_name}
git clone https://gitcloud.federationhq.de/byterazor/App-OSSEC-Jabber.git
cd App-OSSEC-Jabber
dzil build
cpanm App-OSSEC-Jaber<version>.tar.gz
```
### OSSEC specific
- Please link the script into your OSSEC active response bin directory
to be able to execute it.
- configure the command in your ossec.conf
- configure the active response for every alert leve/ rule you want the command to be triggert
- place a jabber.conf file in your ossec etc directory
#### Example jabber.conf
```{r, engine='xml'}
<config>
<options>-t</options>
<recipients>
<recipient>your@jabber.de</recipient>
</recipients>
</config>
```
### sendxmpp
Plase make sure sendxmpp is installed and you have a working configuration to send jabber messages to your recipients.
## Author
Dominik Meyer <dmeyer@federationhq.de>
### LICENSE
## LICENSE
GPLv3

Loading…
Cancel
Save