Version:

MarketplaceSupport

Windows desktop installation

Only Desktop mode is supported in Windows environments. Docker for Desktop is required. It is recommended to create a project folder with the desired project name where the binary file should be placed. For example: brainwave.


Requirements

Docker for Desktop

Install docker for Desktop and configure it using WSL 2.

WSL 2 Memory Management

In order to configure the maximum memory allocation for the Docker services, create a file called .wslconfig in your home folder (e.g. C:/Users/username/.wslconfig)

Is a simple text file with following content:

[wsl2]
memory=16GB

A system restart might be required. More information here


Download and install Identity Analytics CLI

Download the Identity Analytics tools binary from Identity Analytics's Gitea repository https://repository.brainwavegrc.com/. You can also use the following direct link:

https://repository.brainwavegrc.com/Brainwave/-/packages/generic/brainwavetools_windows_amd64/1.2

Docker registry

It is necessary to log into the docker registry for Identity Analytics:

docker login repository.brainwavegrc.com

Installation

To install the solution in desktop mode please use the following command:

brainwave brainwave install --project-name brainwave --desktop
brainwave pull

Initial configuration

Before starting the services, set up the hostname:

brainwave config --hostname brainwave.local

TLS configuration (Optional)

To activate tls

brainwave config --tls

The certificate (.crt) and the private key (.key) must be placed in the docker volume called: bwcertificates.
Find the path of the volume in your local deployment place the files inside the volume.

Please refer to the following page for more information:

SSL configuration page

Start the Services

brainwave start

Once installed navigate to the /config webpage to finalize the configuration. Please see here for more information.


Where are the logs ?

If you are using Docker Desktop with WSL2 (strongly recommended). You can reach the docker volumes in the following path:

\\wsl$\docker-desktop-data\data\docker\volumes

The logs of the instance will be found in the folder *_bwlogs.

IN THIS PAGE