Skip to content

QADOCS tool installation guide

Jump to bottom
Luis González edited this page Oct 25, 2021 · 11 revisions

Supported OS

This tool has support for Linux and Windows(only parsing behavior tested) systems.

Linux dependencies

System dependencies

curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | apt-key add - && \
echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | tee -a /etc/apt/sources.list.d/elastic-7.x.list && \
apt update && \
apt install -y elasticsearch

Also, you need to specify the RAM limit:

echo "-Xms1g" >> /etc/elasticsearch/jvm.options
echo "-Xmx1g" >> /etc/elasticsearch/jvm.options
  • npm (>=6.14.4):

To install npm on Ubuntu, Debian, and Linux Mint:

$ sudo apt install npm

To install npm on CentOS 8 (and newer), Fedora, and Red Hat:

$ sudo dnf install npm	# also installs nodejs

To install npm on Arch Linux and Manjaro:

$ sudo pacman -S npm # also installs nodejs

Windows dependencies

System dependencies

For the RAM limit, add the following lines to config/jvm.options:

-Xms1g
-Xmx1g

How to install qa-docs

  1. Install and check the necessary dependencies for your current OS (mentioned above).

  2. Download the wazuh-qa repository, install python dependencies and the wazuh-qa framework

  • For Linux

    In Linux Terminal, run the next commands:

    wget https://github.com/wazuh/wazuh-qa/archive/refs/heads/master.zip && \
unzip master.zip && \
rm master.zip && \
cd wazuh-qa* && \
python3 -m pip install --upgrade pip && \
python3 -m pip install -r requirements.txt --no-cache-dir --upgrade --only-binary=:cryptography,grpcio: --ignore-installed && \
python3 -m pip install -r deps/wazuh_testing/wazuh_testing/qa_docs/requirements.txt && \
cd deps/wazuh_testing && \
python3 setup.py install

  • For Windows

    Open Windows Powershell and run the next commands:

    git clone https://github.com/wazuh/wazuh-qa --depth 1 --branch=master
cd wazuh-qa*
python -m pip install --upgrade pip
python -m pip install -r requirements.txt --no-cache-dir --upgrade --only-binary=:cryptography,grpcio: --ignore-installed
python -m pip install -r deps/wazuh_testing/wazuh_testing/qa_docs/requirements.txt
cd deps\wazuh_testing
python setup.py install
  1. Check qa-docs command tool use guide or run the following line:
$ qa-docs -h
Clone this wiki locally