Debian installation
Before installing the solution it is necessary to configure the timezone of your instance:
sudo timedatectl set-timezone Europe/Paris
Install Docker Runtime
To install the docker please refer to dockers official documentation:
Log out and log back in, to make sure your user gets the permissions to run docker commands
Creating Users are Required Directories
It is recommended to create a set of system users and groups to install the Identity Analytics CLI.
sudo addgroup --system brainwave
sudo adduser --system --ingroup brainwave --no-create-home --disabled-password brainwave
Create the following directories:
sudo mkdir -p /var/log/brainwave
sudo mkdir -p /var/lib/brainwave
sudo mkdir -p /etc/brainwave
sudo mkdir -p /usr/local/brainwave
Set the owner of the new directories:
sudo chown -R brainwave:brainwave /var/log/brainwave
sudo chown -R brainwave:brainwave /var/lib/brainwave
sudo chown -R brainwave:brainwave /etc/brainwave
sudo chown -R brainwave:brainwave /usr/local/brainwave
Set the permissions
sudo chmod ug+rwx -R /var/log/brainwave
sudo chmod ug+rwx -R /var/lib/brainwave
sudo chmod ug+rwx -R /etc/brainwave
sudo chmod ug+rwx -R /usr/local/brainwave
Download and Install Brainwave CLI
Download the Identity Analytics tools binary and its corresponding sha256 file to verify the download, 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_linux_amd64/1.2
Verify the download
echo "$(cat brainwave.sha256) brainwave" | sha256sum --check
Installation
sudo mkdir -p /usr/local/bin
sudo cp brainwave /usr/local/bin/brainwave
sudo chown brainwave:brainwave /usr/local/bin/brainwave
sudo chmod ug+rx /usr/local/bin/brainwave
Add the current user to the brainwave group
sudo gpasswd -a $(whoami) brainwave
Log out and log back in, to make sure your user gets the permissions to run Identity Analytics commands brainwave XXXX
Brainwave Registry
It is necessary to log into the docker registry for Identity Analytics to be able to pull the desired images:
docker login repository.brainwavegrc.com
Installation
To install the solution in server mode please use the following command:
brainwave install --project-name brainwave --server
brainwave pull
Initial configuration
The hostname brainwave.local used below is provided as an example for the command line. The parameter should be updated to your context, the hostname of the machine hosting the docker service.
The hostname value must be lowercase
Before starting the services, set up the hostname
brainwave config --hostname brainwave.local
TLS configuration (Optional)
To activate tls
brainwave config --tls
Before starting the service it is necessary to copy the certificate and the private key into the certificates folder
cp brainwave.local.key /etc/brainwave/certificates/brainwave.local.key
cp brainwave.local.crt /etc/brainwave/certificates/brainwave.local.crt
Note that the filename musth match the domain name. More generally the files have to be named <hostname>.crt and <hostname>.key
Please refer to the following page for more information:
Starting the Services
brainwave start
Once installed navigate to the /config webpage to finalize the configuration. Please see here for more information.
Auto completion
An auto completion bash exists for linux environments. Add the following command line to your users bash profile:
source <(brainwave completion bash)