Versions Compared

Key

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



Introduction

...

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 update.
Open the core-installer.


Welcome to the BVQ installer, the update is about to begin shortly.
As you can see the installer has identified your current BVQ installation and is about to update the running BVQ.

-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 updates it is necessary to choose all of the BVQ components.


-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

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

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 are your BVQ database -credentials,
which BVQ uses to connect to the database.

-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

Your current port number will be displayed.
Keep in mind that the port number 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. 


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...
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.


The "Domain name" field has to be the set to the FQDN like bvqtest.labwi.sva.de

Also, the Windows user must have read access rights for the certificates.

-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,
and 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 this specific step.

-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 update, please be aware,
that the complete log 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 update 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...




...

Section
Column
width100%
Panel
borderColor#2415A1
bgColor#DADBE7
titleColorwhite
borderWidth3
titleBGColor#2415A1
borderStylesolid
titleGrafana Datasource
Excerpt
Section

Anchor
Grafana
Grafana

Column
width100%
Panel
borderColor#2415A1
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#2415A1
borderStylesolid
titleGrafana

For each update where you have created a new HTTPS certificate, you must adjust the BVQ datasource within the Grafana.

Additionally for each update where you have changed the port number for the BVQ server, you have also to adjust the BVQ datasource within the Grafana.


Open your Grafana with the Grafana button, a new tab will open up and login to Grafana using the default BVQ-Credentials, here

Expand
titleexpand...

     

Section
Column
width100%
Panel
borderColor#2415A1
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#2415A1
borderStylesolid
titleMove to your Grafana Datasource

Open the Configuration menu and click on Data source,
the installed Data source plugins are listed,
click on BVQ Server to move to the specific Data source.

Expand
titleexpand...



Section
Column
width100%
Panel
borderColor#2415A1
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#2415A1
borderStylesolid
titleChange the URL

The BVQ Data Source is shown and can be adjusted.

If you changed the protocol from HTTP to HTTPS during the BVQ update, you need to adjust the address accordingly.
https://FQDN


You have to edit the HTTP/URL field as well as the BVQ Settings/BVQ Server URL field on the bottom of the page.

Expand
titleexpand...

Section
Column
width100%
Panel
borderColor#2415A1
bgColorwhite
titleColorwhite
borderWidth3
titleBGColor#2415A1
borderStylesolid
titleAdd a Certificate

For adding the certificate,
you only need to activate "With CA Cert"
and paste the certificate text to "CA Cert", shown here
(You can also find the self-signed certificate by default here: C:\Program Files\SVA\BVQ\bvq-core\cert\)


Click on "Safe & Test" to adjust the data source.

Expand
titleexpand...






...