docs auto build pipeline added

This commit is contained in:
Rudi klein 2024-05-05 14:47:28 +02:00
parent 4e6dfd6b76
commit 0f59092d2d
4 changed files with 85 additions and 5 deletions

41
.github/deploy.docs.yml vendored Normal file
View File

@ -0,0 +1,41 @@
name: build and deploy docs
on:
push:
branches: [ "master" ]
paths: ['Writerside/**']
pull_request:
branches: [ "master" ]
paths: ['Writerside/**']
jobs:
build:
runs-on: self-hosted
steps:
- uses: actions/checkout@v3
- name: Docker login
run: docker login docker.dariusklein.nl -u Darius -p ${{ secrets.DOCKER_PASSWORD }}
- name: Build the Docker image
run: docker build . --file Writerside/Dockerfile --tag docker.dariusklein.nl/wazuh-notifier-docs
- name: Docker push
run: docker push docker.dariusklein.nl/wazuh-notifier-docs
publish:
needs: build
runs-on: self-hosted
steps:
- name: Docker stop
run: docker stop WazuhNotifier || true
- name: Docker login
run: docker login docker.dariusklein.nl -u Darius -p ${{ secrets.DOCKER_PASSWORD }}
- name: Docker pull
run: docker pull docker.dariusklein.nl/wazuh-notifier-docs
- name: Docker run
run: docker run --rm -dit -p 9091:80 --name WazuhNotifier docker.dariusklein.nl/wazuh-notifier-docs

21
Writerside/Dockerfile Normal file
View File

@ -0,0 +1,21 @@
FROM registry.jetbrains.team/p/writerside/builder/writerside-builder:241.15989 as build
ARG INSTANCE=Writerside/notifier
RUN mkdir /opt/sources
WORKDIR /opt/sources
ADD . ./Writerside
RUN export DISPLAY=:99 && \
Xvfb :99 & \
/opt/builder/bin/idea.sh helpbuilderinspect -source-dir /opt/sources --product $INSTANCE --runner other --output-dir /opt/wrs-output/
WORKDIR /opt/wrs-output
RUN unzip webHelpNOTIFIER2-all.zip -d /opt/wrs-output/unzipped-artifact
FROM httpd:2.4 as http-server
COPY --from=build /opt/wrs-output/unzipped-artifact/ /usr/local/apache2/htdocs/

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

@ -24,7 +24,7 @@ Download the files from https://github.com/RudiKlein/wazuh-notifier to your serv
Copy the 4 Python files to the /var/ossec/active-response/bin/ folder
```
$ cp <folder contaning downloaded Wazuh notifier files>/wazuh-*.py /var/ossec/active-response/bin/
$ cp <downloaded notifier files>/wazuh-*.py /var/ossec/active-response/bin/
```
Set the correct ownership
@ -44,7 +44,7 @@ $ chmod uog+rx /var/ossec/active-response/bin/wazuh-*.py
Copy the YAML file to /var/ossec/etc/
```
$ cp <folder contaning downloaded Wazuh notifier files>/wazuh-notifier-config.yaml /var/ossec/etc/
$ cp <downloaded notifier files>/wazuh-notifier-config.yaml /var/ossec/etc/
```
Set the correct ownership
@ -61,7 +61,7 @@ $ chmod uog+r /var/ossec/etc/wazuh-notifier-config.yaml
### Step 4 ###
Modify the ossec.conf configuration file and add the following<br/>
Modify the /var/ossec/etc/ossec.conf configuration file and add the following<br/>
```
<command>
@ -80,7 +80,7 @@ Modify the ossec.conf configuration file and add the following<br/>
</active-response>
```
Add the rules you want to be informed about between the <rules_id></rules_id>, with the rules id's seperated by comma's.
Add the rules you want to be informed about between the <rules_id></rules_id>, with the rules id's separated by comma's.
Example: <rules_id>5402, 3461, 8777</rules_id><br/>
(Please refer to the Wazuh online documentation for more information [^Wazuh docs])
@ -123,4 +123,22 @@ ntfy_priority: "5"
ntfy_message: "Test message"
ntfy_tags: "information, testing, yaml"
ntfy_click: "https://google.com"
```
```
Default settings for the ntfy notifier. This overrules the hardcoded defaults.
```
discord_server: "not used. The webhook (server) is a secret stored in .env"
discord_sender: "Security message"
discord_destination: "WAZUH (IDS)"
discord_priority: "5"
discord_message: "Test message"
discord_tags: "informational, testing, yaml"
discord_click: "https://google.com"
# 1 to send the full event data with the message. 0 only sends the message with basic details
discord_full_message: "0"
```
![wazuh discord basic message](wazuh-discord-basic-message.png)