Wazuh dashboard

The build-packages.sh script, located in the dev-tools/build-packages/ folder, orchestrates the package generation process. This script bundles plugins into a single application and supports tar, rpm, and deb distributions. It accepts the following parameters:

version
revision
distribution
wazuh-dashboard, wazuh-dashboard-plugins, and wazuh-security-dashboards-plugin package paths

Official packages are built through a GitHub Actions pipeline, however, the process is designed to be independent enough for maximum portability. The building process is self-contained in the application code.

Build manually

Requirements:

Docker: Refer to Docker installation guide.
NVM (Node Version Manager): Refer to NVM installation guide.
Yarn v1.22.22 (Node Package Manager): Refer to Yarn installation guide.
Utilities: Ensure the following are available:
- zip
- unzip
- gzip
- brotli
- curl

Generating zip packages

To use the script you first need to generate the packages from these repositories:

wazuh-dashboard
wazuh-security-dashboards-plugin
wazuh-dashboard-plugins

To build the packages, follow these steps:

Clone the Wazuh dashboard repository and build the application.

$ git clone -b <BRANCH_OR_TAG> https://github.com/wazuh/wazuh-dashboard.git
$ cd wazuh-dashboard/
$ nvm install $(cat .nvmrc)
$ nvm use $(cat .nvmrc)
$ yarn osd bootstrap
$ yarn build-platform <--linux | --linux-arm> --skip-os-packages --release

Example:

$ git clone -b v4.12.0 https://github.com/wazuh/wazuh-dashboard.git
$ cd wazuh-dashboard/
$ nvm install $(cat .nvmrc)
$ nvm use $(cat .nvmrc)
$ yarn osd bootstrap
$ yarn build-platform --linux --skip-os-packages --release

Note

To build a package for ARM architecture, use the --linux-arm flag with the yarn build command instead of --linux.

Clone the Wazuh Security Dashboards Plugin repository in the plugins folder and build the plugin.

$ cd plugins/
$ git clone -b <BRANCH_OR_TAG> https://github.com/wazuh/wazuh-security-dashboards-plugin.git
$ cd wazuh-security-dashboards-plugin/
$ yarn
$ yarn build

Example:

$ cd plugins/
$ git clone -b v4.12.0 https://github.com/wazuh/wazuh-security-dashboards-plugin.git
$ cd wazuh-security-dashboards-plugin/
$ yarn
$ yarn build

Clone the Wazuh dashboard plugins repository in the plugins folder, move the contents of the plugins folder to the folder where the repository was cloned and build the plugins.

Note

The yarn build command requires an entry specifying the OpenSearch Dashboard version. This version can be obtained from the package.json file.

$ cd ../
$ git clone -b <BRANCH_OR_TAG> https://github.com/wazuh/wazuh-dashboard-plugins.git
$ cd wazuh-dashboard-plugins/
$ nvm install $(cat .nvmrc)
$ nvm use $(cat .nvmrc)
$ cp -r plugins/* ../
$ cd ../main
$ yarn
$ yarn build
$ cd ../wazuh-core/
$ yarn
$ yarn build
$ cd ../wazuh-check-updates/
$ yarn
$ yarn build

Example:

$ cd ../
$ git clone -b v4.12.0 https://github.com/wazuh/wazuh-dashboard-plugins.git
$ cd wazuh-dashboard-plugins/
$ nvm install $(cat .nvmrc)
$ nvm use $(cat .nvmrc)
$ cp -r plugins/* ../
$ cd ../main
$ yarn
$ yarn build
$ cd ../wazuh-core/
$ yarn
$ yarn build
$ cd ../wazuh-check-updates/
$ yarn
$ yarn build

Zip the packages and move them to the packages folder

$ cd ../../../
$ mkdir packages
$ cd packages
$ zip -r -j ./dashboard-package.zip ../wazuh-dashboard/target/opensearch-dashboards-<OPENSEARCH_VERSION>-linux-x64.tar.gz
$ zip -r -j ./security-package.zip ../wazuh-dashboard/plugins/wazuh-security-dashboards-plugin/build/security-dashboards-<OPENSEARCH_VERSION>.0.zip
$ zip -r -j ./wazuh-package.zip ../wazuh-dashboard/plugins/wazuh-check-updates/build/wazuhCheckUpdates-<OPENSEARCH_VERSION>.zip ../wazuh-dashboard/plugins/main/build/wazuh-<OPENSEARCH_VERSION>.zip ../wazuh-dashboard/plugins/wazuh-core/build/wazuhCore-<OPENSEARCH_VERSION>.zip

Example:

$ cd ../../../
$ mkdir packages
$ cd packages
$ zip -r -j ./dashboard-package.zip ../wazuh-dashboard/target/opensearch-dashboards-2.16.0-linux-x64.tar.gz
$ zip -r -j ./security-package.zip ../wazuh-dashboard/plugins/wazuh-security-dashboards-plugin/build/security-dashboards-2.16.0.0.zip
$ zip -r -j ./wazuh-package.zip ../wazuh-dashboard/plugins/wazuh-check-updates/build/wazuhCheckUpdates-2.16.0.zip ../wazuh-dashboard/plugins/main/build/wazuh-2.16.0.zip ../wazuh-dashboard/plugins/wazuh-core/build/wazuhCore-2.16.0.zip

At this point you must have three packages in the packages folder:

dashboard-package.zip
security-package.zip
wazuh-package.zip

Using the script

Run the build-packages.sh script in the dev-tools/build-packages/ folder of the repository. The script requires the following parameters:

-c, --commit-sha: Commit SHA identifier for the build (see Generating the commit SHA below).
-a, --app: Indicate the path to wazuh-package.zip.
-b, --base: Indicate the path to dashboard-package.zip.
-s, --security: Indicate the path to security-package.zip.
--all-platforms: Build the packages for all platforms.
--deb: Build a deb package.
--rpm: Build an rpm package.
--tar: Build a tar.gz archive.
-r, --revision: Optional – Set the revision for this build. Defaults to 1.
--production: Optional – Use package naming for production. Otherwise, it includes the hash of the current commit.
--arm: Optional – Build for arm64 architecture instead of x64.
--debug: Optional – Enable debug mode to display detailed information during execution.
--silent: Optional – Enable silent mode for minimal output. Note that --debug overrides this option.

$ cd ../wazuh-dashboard/dev-tools/build-packages/
$ ./build-packages.sh --commit-sha <COMMIT_SHA> -r <REVISION> --<DISTRIBUTION> -a file:///<PATH_TO_wazuh-package.zip> -s file:///<PATH_TO_security-package.zip> -b file:///<PATH_TO_dashboard-package.zip>

Where --<DISTRIBUTION> is either --deb, --rpm, --tar, or --all-platforms.

Note

In cases where a local path is available, use file://<ABSOLUTE_PATH> to specify its absolute path.

Note

To build ARM packages, run the script on an ARM machine. Use the -b option with an ARM build of the Wazuh dashboard base.

Example:

$ cd ../wazuh-dashboard/dev-tools/build-packages/
$ ./build-packages.sh --commit-sha c68286b87-b917f56ac-970c46953 -r 1 --deb -a file:///packages/wazuh-package.zip -s file:///packages/security-package.zip -b file:///packages/dashboard-package.zip

The script generates the package in the output folder of the same directory where it is located.

Generating the commit SHA

Run the following command in each relevant repository to obtain individual SHAs. Ensure you are on the correct branch in each repository.
```
$ git rev-parse --short HEAD
```
Repository

SHA Variable

wazuh-dashboard

<DASHBOARD_COMMIT_SHA>

wazuh-dashboard-plugins

<PLUGINS_COMMIT_SHA>

wazuh-security-dashboards-plugin

<SECURITY_COMMIT_SHA>
Concatenate individual SHAs in the following format. The resulting commit SHA is used for package versioning and build tracking.
```
<DASHBOARD_COMMIT_SHA>-<PLUGINS_COMMIT_SHA>-<SECURITY_COMMIT_SHA>
```
Example:
```
c68286b87-b917f56ac-970c46953
```

Repository	SHA Variable
wazuh-dashboard	`<DASHBOARD_COMMIT_SHA>`
wazuh-dashboard-plugins	`<PLUGINS_COMMIT_SHA>`
wazuh-security-dashboards-plugin	`<SECURITY_COMMIT_SHA>`

Build with Docker image

This option allows you to create packages that include all necessary plugins required to generate the Wazuh dashboard installer.

Requirements

Docker: Refer to Docker installation guide.
Docker Compose: Refer to Docker Compose installation guide.
Internet connection to download the Docker images for the first time.
Utilities: Ensure the following are available:
- zip
- jq
- curl

Building the packages

Clone the Wazuh dashboard repository and navigate to the dev-tools/build-packages/base-packages-to-base folder within it.

$ git clone -b <BRANCH_OR_TAG> https://github.com/wazuh/wazuh-dashboard.git
$ cd wazuh-dashboard/dev-tools/build-packages/base-packages-to-base

Example:

$ git clone -b v4.12.0 https://github.com/wazuh/wazuh-dashboard.git
$ cd wazuh-dashboard/dev-tools/build-packages/base-packages-to-base

Run the script run-docker-compose.sh with the following parameters:
- --node-version: Node.js version for the .nvmrc file.
- -b, --base: Branch of the Wazuh dashboard repository.
- -a, --app: Branch of the Wazuh dashboard plugins repository.
- -s, --security`: Branch of the Wazuh Security Dashboards Plugin repository.
- --arm: Optional – Build for arm6 architecture instead of x64.
```
$ bash run-docker-compose.sh \
--node-version <NODE_VERSION> \
--base <BRANCH_OF_wazuh-dashboard> \
--app <BRANCH_OF_wazuh-dashboard-plugins> \
--security <BRANCH_OF_wazuh-security-dashboards-plugin>
```
Example:
```
$ bash run-docker-compose.sh \
--node-version $(cat ../../../.nvmrc) \
--base v4.12.0 \
--app v4.12.0 \
--security v4.12.0
```
The script creates the packages in the packages directory within the base-packages-to-base folder.

Note

To build a custom package, replace the contents of the packages folder with your customized packages.

Zip the packages

$ cd ./packages
$ zip -r -j ./dashboard-package.zip ./wazuh-dashboard/*.tar.gz
$ zip -r -j ./security-package.zip ./wazuh-security-dashboards-plugin/*.zip
$ zip -r -j ./wazuh-package.zip ./wazuh-dashboard-plugins/*.zip

Build deb, rpm, or tar.gz packages

$ cd ../../
$ ./build-packages.sh -v <VERSION> -r <REVISION> [--arm] --<DISTRIBUTION> -a file:///<PATH_TO_wazuh-package.zip> -s file:///<PATH_TO_security-package.zip> -b file:///<PATH_TO_dashboard-package.zip>

Where --<DISTRIBUTION> is either --deb, --rpm, --tar, or --all-platforms.

Example:

$ cd ../../
$ ./build-packages.sh -v 4.12.0 -r 1 --deb -a file://$(pwd)/base-packages-to-base/packages/wazuh-package.zip -s file://$(pwd)/base-packages-to-base/packages/security-package.zip -b file://$(pwd)/base-packages-to-base/packages/dashboard-package.zip

The script creates the package in the output folder within the same directory as the script.