Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Create users on your systems, with which BVQ is able to collect data
  • Installation wizard which guides you through the setup
  • Maintenance page where BVQ is checking the environment and its own files
  • Initial Configuration helps you to create your first scanner and therefore enables BVQ to receive the first data
  • Quick Tour explains the features of the BVQ webpage
  • Grafana data sources must be adjusted after each port change or implementation of a new HTTPS certificate
  • BVQ GUI is an extensive tool, with which you are able to have direct access to your data




Setup- Prepare System Users

Image Modified
Image Modified
Image Modified
Image Modified
Image Modified



...



Section
Column
width100%
Panel
borderColor#A1154C
bgColor#DADBE7
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleInstall Wizard

Anchor
Install Wizard
Install Wizard


Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleStart the installation

After placing the core-installer on the specific host you are ready to start the installation.
Open the core-installer.


Welcome to the BVQ installer, the installation is about to begin shortly.

-Click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleInformation

Our BVQ readme

-Read all the information carefully and click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleSelect Components

For installations and updates it is necessary to choose all of the BVQ components.
Only if you want to run multiple BVQ installations or would like to run each component on a different host, the deselection of components is required.

-Click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleSelect Destination Directory

Select the directories in which you would like to install BVQ, the directories cannot be changed afterwards.
As the default values suggest, the data and log folders are not to be placed in the same directory.

You may choose to use a second drive to place the data and log folders, as the amount of data placed in these folders will increase in time.

-Click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%

Anchor
Credentials
Credentials

Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleDatabase

The "Database server access" values are used by BVQ for the internal communication between the database and the BVQ Server, hence these values are recommended. 

The Database name will be the name of the internal database, residing on the MongoDB-server.

For the User authentication fields, it is important to understand that these credentials will be your BVQ-credentials,
which you will use to access your BVQ, as well as the credentials, BVQ uses to connect to the database.
If you need to define different passwords for the internal database and your specific BVQ access, this task must be performed separately after installation,
please keep in mind that you are still able to create different BVQ users with different passwords, when the installation is completed.
If you choose to change these values, saving the credentials in a password safe will be self-evident.

However, the default values which are pictured below will be used to log in to your Grafana, here 

-Click 'Next' to advance to the next page

Expand
titleexpand...
Excerpt
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleWeb server

The port number under which BVQ will be accessible varies according to the selected transfer protocol option.
The default port for a server which will be accessible via HTTP is 80, the default port for the activated HTTPS option is 443.
For example, if you change the port number to 8080 and choose "enable HTTPS" afterwards, the port number will be changed to the default value 443.
Also please be aware that for every BVQ port change, you have to adjust the Grafana datasource. 

Anchor
Grafanaconfig
Grafanaconfig

Report TTL: The reports you run in the future are available as a default, for 30 days.

Grafana configuration is the Grafana port, which will be used by the BVQ installed Grafana.

The heap sizes are configured for both the BVQ Server which will run as a Webserver and the scanner service which will collect the data of the systems you will be scanning.
If the number of scanners will increase considerably in the future, the specific values can be adjusted accordingly.
BVQ Server max heap size = 4096 MB is recommended (depending on the environment).
BVQ Scanner max heap size = 1024MB is recommended (depending on the environment).


Select HTTPS to be enabled if you choose to.

Expand
titleexpand...


Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleUse self-signed certificate

By enabling HTTPS and the use of a self-signed certificate, BVQ will create a certificate for you.
The Keystore password has a default value, which can be adjusted,
any of the following values must be set to continue.

-Click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleUse own-certificate

By enabling HTTPS and the use of an own-certificate, you must "browse" the location of your private and public key.
If it is encrypted, enter the specific password for the key.

The Keystore password has a default value, which can be adjusted,

-Click 'Next' to advance to the next page

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleWindows service configuration

To create and start the BVQ services an authorized Windows user is required.
In case of possible vm reboots in the future, a local user is recommended to be used.
For the use of a local user, the domain field must be empty.

The given credentials will only be used, for the execution of Windows Services, as well as scheduled tasks in Windows..

-Click 'Install' to advance to installation

Expand
titleexpand...

Section
Column
width100%
Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleInstallation

The installation starts and the current processes are displayed from top to bottom

Expand
titleexpand...
Section
Column
width100%
Panel
borderColor#A1154C
bgColor#DADBE7
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleFor research purposes only

When the installation of BVQ is completed, you can find the installation log here:

Expand
titleexpand...

Insert excerpt
BVQ Installation Log
BVQ Installation Log




When you encounter issues during the installation, please be aware,
that the complete log of the installation is only visible, as long as the installation wizard is active
and the log can be found in the AppData directory, the name of the log file will be:
i4j_log_bvq-core_<hash-code>.log


And it will be placed here:
C:\Users\<windows_user>\AppData\Local\Temp

Section
Column
width100%

Anchor
cert
cert

Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleCompleting the BVQ Setup Wizard

The installation has been successful.

You can choose to start the BVQ WebUI after finishing the wizard, which is enabled by default.
Displayed is also the BVQ Web address as well as the Grafana address.

The next steps will be to access the BVQ WebUI to complete the maintenance which is active after every update or installation
and if you have chosen a HTTPS installation, the Grafana-Datasource has yet to be adjusted.

After using the 'Finish' -Button, the wizard will be closed and your default browser will open, directing you to the localhost webpage
Please keep in mind, that the start of the BVQ services could take a minute

Thank you for using a supported browser, such as:
"Firefox, Chrome, Safari, Edge"

Expand
titleexpand...

Section
Column
width100%

Anchor
cert
cert

Panel
borderColor#A1154C
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#A1154C
borderStylesolid
titleAccept the Certificate

The localhost webpage has opened up,
if you created your own certificate during the installation of BVQ, an exception is necessary, to continue to the BVQ webpage.

Expand
titleexpand...




...