QADOCS tool installation guide - wazuh/wazuh-qa GitHub Wiki

Supported OS

This tool has support for Linux and Windows systems.

Linux dependencies

System dependencies

• Build-Essentials: How to install
• Python (>=3.6.0): How to install
• Python-pip (>=21.2.3): How to install
• Python3-devtools: How to install
• ElasticSearch: How to install
• npm (>=6.14.4): How to install
• Docker: How to install
• wget: How to install
• unzip: How to install

Windows dependencies

System dependencies

• Microsoft Visual C++ 14 (or higher versions) : How to install
• Git (>=2.33) How to install
• Python (>=3.6.0): How to install
• Python-pip (>=21.2.3): How to install
• WSL2 : How to install
• Docker Desktop: How to install
• ElasticSearch: How to install
• npm (>=6.14.4): How to install

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, the wazuh-qa framework, wget and unzip.

• 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 && \
  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
  cd deps\wazuh_testing
  python setup.py install
  

3. Check qa-docs command tool use guide or run the following line:

$ qa-docs -h