/
Installation / Update

Installation / Update

Introduction

Updates and first-time installations follow the same workflow.
The all-new core-installer is a .exe file which should be placed on either the host which is currently running BVQ° or on the host which is supposed to run BVQ°.
Information about the requirements is provided here. We recommend creating users on the systems you will be scanning beforehand.

 

Please note that changes to your existing BVQ° configuration can only be made, using an update installation.
This works even with the same installation file used in your current BVQ° installation.

During the update process within the wizard, the fields will display the current configuration values.


 


Installation / Update

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

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

    -Click 'Next' to advance to the next page

2024-05-14 15_33_10-Ninox Database.png

 

 

  1. Information (install only)
    Our BVQ° readme

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

 

 

  1. Select Components
    For installations and updates, it's necessary to select all of the BVQ° components.
    Only if you wish to run multiple BVQ° installations or want to run each component on a different host, should you deselect any components.

    Please note: Deselecting components in an existing installation will remove the deselected components during the installation process.
    This can potentially result in loss of data or functionality, which may have serious consequences.
    Ensure that you have backed up all necessary data before proceeding.

    -Click 'Next' to advance to the next page

2024-05-14 15_33_45-Ninox Database.png

 

 

  1. Select Destination Directory (install only)
    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

2024-05-14 18_09_37-Bearbeiten - Installation - BVQ - BVQWIKI.png

 

 

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

2024-05-14 15_35_11-Ninox Database.png

 

 

  1. Web 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.
    Also please be aware that for every BVQ° port change, you have to adjust the Grafana datasource. 

     

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

2024-05-14 15_35_40-Ninox Database.png

 

 

  1. Server Security
    When enabling HTTPS, you will be presented with two options: either let BVQ° create a self-signed certificate for you or use your own SSL certificate.

    To utilize LDAP authentication, you can browse for and select your LDAP certificate.

    -You can also skip either or both security options and proceed by clicking the "Next" button.

2024-05-14 15_36_03-Ninox Database.png

 

 

  1. Use self-signed certificate
    By enabling HTTPS and opting for a self-signed certificate, BVQ° will create a certificate for you.
    All of the presented fields must be filled out to continue.

The "Domain name" field has to be the set to the FQDN like bvqtest.wi.sva.de or the IP → if there is no DNS Entry.
Also, the Windows user must have read access rights for the certificates.

-Click 'Next' to advance to the next page

2024-05-14 15_39_23-Ninox Database.png


 

  1. Use own-certificate
    To enable HTTPS using your own SSL certificate, select the location of your private key (.key) and public certificate (.crt).
    If the private key is encrypted, enter the specific password when prompted.

-Click 'Next' to advance to the next page

 

SSL Certificate:

Certificate Format:

  • The certificate must be in PEM format with a separate .key (private key) and .crt (certificate) file.

  • PKCS#12 (.pfx or .p12) is NOT supported natively.

Certificate File:

  • The SSL certificate should be provided in .crt format (PEM encoded, Base64 text).

  • Ensure that it includes the correct Subject Alternative Names (SAN) with all required DNS names and/or IP addresses.

Apache Web Server Compatibility:

  • Inform your security team that the certificate and private key are intended for Apache with HTTPS support.

  • If your CA provides an intermediate certificate, you must create a full certificate chain before use

2024-05-14 17_01_59-Ninox Database.png

 

 

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

2024-05-14 17_03_31-Ninox Database.png

 

 

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

2024-05-14 17_54_32-Workshop3 - 10.10.120.50 - Remotedesktopverbindung.png

 

 

  1. For research purposes only
    When the installation of BVQ° is completed, you can find the installation log here:

C:\Program Files\SVA\BVQ\bvq-core\.install4j\installation.log
or

C:\Programme\SVA\BVQ\bvq-core\.install4j\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

 

  1. Completing the BVQ° Setup Wizard

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"

2024-05-14 18_05_31-Workshop3 - 10.10.120.50 - Remotedesktopverbindung.png

 

 

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

 


Maintenance

1. Login to your BVQ° maintenance
Open a supported browser and use the following (HTTP or HTTPS):

http://localhost/#/ui/login for the BVQ° Maintenance Mode
or
http://localhost/ui/login for the BVQ° Web Server
On any other client in the network, you can use a browser and type: http://<BVQ-ServernameOrIP>

 

To Access the BVQ°-Maintenance-Page please use the credentials, created during the installation.

We do also provide a selection of the supported browsers as well as the specific links.

 

The BVQ°maintenance page that you will be redirected to after each update and installation, is the last step for BVQ° to check and confirm specific configurations.
Only checks that require values or actions will be displayed.

When you have completed the last step, of your maintenance, you will be shown a "Maintenance completed successfully" window, the services of BVQ° will be restarted and your are directed to the BVQ° webpage.

 

  1. Usage Statistics
    Our aim is to give our customers the best possible BVQ° experience, we want to understand how we can serve you better.
    We would recommend you to help us, by sending the statistics.

 

2025-01-07 10_47_27-BVQ.png

 

 

 

  1. Database schema
    The database server used by BVQ° is a MongoDB, this check confirms that the used version is corresponding.

 

2025-01-07 10_48_18-BVQ.png

 

2025-01-07 10_49_01-BVQ.png

 

 

 

  1. Maintenance completed
    Due to the fact that every necessary action has been performed, you have completed the maintenance and are redirected to the BVQ° Webpage shortly.

 

2025-01-07 10_49_19-BVQ.png

 

 


Initial Configuration

1. Login to your BVQ°
Open a supported browser and use the following (HTTP or HTTPS):
http://localhost/ui/login for the BVQ° Web Server
On any other client in the network, you can use a browser and type: http://<BVQ-ServernameOrIP>

 

Access the BVQ° webpage using the credentials, created during the installation.

We do also provide a selection of the supported browsers as well as the specific links.
The BVQ° GUI is an application, which connects to your BVQ° database and gives you the freedom to browse through your collected data.
You can download the BVQ° GUI installer on every client, that can reach the BVQ° Web Server.
Please be aware that the BVQ° GUI installer is for Windows only.

 

The downloadable file is located in your target installation folder.

2024-05-27 09_37_15-BVQ.png

 

 

  1. Initial configuration
    With this wizard, you will be able to use your BVQ° as quickly and easily as possible.
    This wizard will guide you through the first steps which are necessary to make use of your BVQ°.
    You can also skip the wizard at any time and move directly to the BVQ° Web UI.

    -Click 'Next' to advance to the next page

 

2025-01-07 11_00_09-BVQ.png

 

 

  1. Set up notifications
    In this step, you will configure the SMTP server that BVQ° will use to send notifications about system issues, scanner statuses, or alerts. Properly setting up this email server ensures that you are promptly informed about important events.

    1. Email Server Configuration:

      • Name: Provide a unique name for the email server configuration. This can be any descriptive name for easy identification.

      • SMTP Server: Enter the address of your SMTP server.

      • Port: Specify the port for the SMTP server. The default port is often 25, but check your server's settings if different.

      • Username and Password: Enter the login credentials for the SMTP server. These credentials will allow BVQ° to connect and send emails securely.

    2. Notification Details:

      • Notification Name: Choose a name for the notification configuration. This name will help identify the purpose of the notifications (e.g., "System Alerts").

      • Sender Email Address: Specify the email address that will appear as the sender of the notifications.

      • Recipient Email Address(es): Enter the email address or addresses that should receive the notifications. You can include multiple recipients separated by commas.

    3. Test the Configuration:

      • Use the "Send test" button to ensure that your SMTP configuration works correctly. This will send a test email to verify the connection and settings.

    4. Notification Context:

      • (Optional) Click on the Notification context section to customize the scope and type of notifications you want to receive.

    Once all fields are filled in and tested, click Next to proceed with the setup wizard.

 

2025-01-07 11_02_02-BVQ.png

 

 

  1. Add scanners -Config
    Choose a system you would like to scan, from the Dropdown menu, using the "Add configuration" button.
    Once one of the systems is chosen, a new configuration menu becomes available.

     

    Connection
    You must create a name for the scanner, it is helpful to choose a name which is similar to the system name.
    Fill in the IP or the name of the system as well as the correct protocol.
    The username and password are for the read-user on your specific system, which BVQ° will use to collect data.
    Learn how to create a read-user beforehand on your system, here

 

2025-01-07 11_10_55-BVQ.png

 

2025-01-07 11_12_41-BVQ.png

 

2025-01-07 11_12_58-BVQ.png

 

 

 

  1. Add scanners -Options
    In this example we see a NetApp specific configuration window. 


    A topology scan interval of one hour is recommended.
    In this example you can also activate the NetApp quota scan which again is system specific.
    The performance scan interval default value is five minutes for the NetApp scanner, which means BVQ° is collecting every five minutes performance data for every single minute.
    The log level default for all scanners is Info, only for debug purposes the second option should be used.
    We also do not recommend changing the log size limit.

 

2025-01-07 11_17_05-BVQ.png

 

 

  1. Add scanners -Data expiration
    You can adjust the data expiration settings for each scanner individually.
    This allows you to define how long the collected data will be retained in the system.

 

2025-01-07 11_17_43-BVQ.png

 

 

  1. Notifications
    BVQ° can notify you about potential scanner issues.

    Note: These notification options are only available if Notifications have been enabled on the BVQ° Server during the setup process.

 

2025-01-07 11_17_59-BVQ.png

 

 

  1. Saving your scanner configuration
    After saving your scanner configuration:
    BVQ° will automatically test the connection to the scanner.
    If the connection is successfully established, the configuration will be saved. You can then proceed to configure the next scanner.

 

2025-01-07 11_26_57-BVQ.png

 

2025-01-07 11_27_13-BVQ.png

 

 

  1. Enable alerting
    You can directly activate the BVQ° alert rules and also the notifications for the specific alert rules.

 

2025-01-07 11_27_41-BVQ.png

 

2025-01-07 11_44_54-BVQ.png

 

 

 


Grafana Datasource

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

    Additionally for each installation and 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.

2024-05-27 09_39_14-BVQ.png
2022-12-21 19_02_43-Grafana.jpg

 

 

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

Grafana101.jpg
Grafana102.jpg
Grafana103.jpg

 

 

  1. Change 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 or
    https://IP

     

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

2023-07-06 12_02_55-.jpg

 

 

  1. Add a Certificate
    For adding the certificate,
    you only need to activate "With CA Cert"
    and paste the certificate text to "CA Cert"
    (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.

2023-07-06 12_02_55-.jpg
2023-07-06 12_16_40-Bearbeiten - BVQ Installation Whitepaper - BVQ - Globale Seite.jpg
2023-07-06 12_17_34-Bearbeiten - BVQ Installation Whitepaper - BVQ - Globale Seite.jpg
2023-07-06 12_02_39-.jpg

 

 


BVQ° GUI

  1. Download your GUI
    The BVQ° GUI is an application, which connects to your BVQ° database and gives you the freedom to browse through your collected data.
    When you completed the installation, the BVQ° GUI installer is by default located in the following directory:
    C:\Program Files\SVA\BVQ\bvq-core\bvq-server\gui

    You can download the BVQ° GUI installer on every client, that can reach the BVQ° Web Server.
    Please be aware that the BVQ° GUI installer is for Windows only.

    The third option for downloading the install file is to move to “Expert GUI", which is located under the Admin tab.

2024-05-27 09_40_08-BVQ.png
2024-05-27 09_41_00-BVQ.png

 

 

  1. GUI Setup Wizard
    After opening the install file,  your GUI Setup Wizard will start.

    -Click 'Next' to advance to the next page

2022-12-30 11_32_34-Ninox Database.jpg

 

 

  1. GUI Information
    Our BVQ° readme

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

2022-12-30 11_32_42-Ninox Database.jpg

 

 

  1. Start Menu Folder
    You have the option to create shortcuts in a Start Menu folder, as well as to create them for all users.

    -Click 'Next' to advance to the next page

2022-12-30 11_32_51-Ninox Database.jpg

 

 

  1. Installation Parameters
    Choose the directory for the installation of your BVQ° GUI.
    You also have to select the heap size of the BVQ° GUI, which has a default value of 4096MiB.

    Memory usage limit (MiB)
    Is equal to the maximum heap size of the Java environment.

    Recommendation:
    The default value should suffice, if you notice that the program slows down over a period of time,
    increase this value to prevent poor performance and application failures.
    A memory utilization gauge is available on the BVQ° GUI main menu below "?".

     

    -Click 'Install' to advance to installation

2022-12-30 11_32_59-Ninox Database.jpg

 

 

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

2022-12-30 11_33_27-Ninox Database.jpg

 

 

  1. Completing the BVQ° GUI Setup
    The installation has been successful.
    You can choose to start the BVQ° GUI after finishing the wizard.

    -Click 'Finish' to close the installer and start the BVQ° GUI  if selected.

2022-12-30 11_33_46-Ninox Database.jpg

 

 

  1. BVQ° is Starting
    Your BVQ° GUI is starting now

2022-12-30 11_35_08-Ninox Database.jpg

 

 

  1. Database Connection
    Your BVQ° GUI immediately connects to your database,
    which is indicated by the connection bar below.
    When successfully connected, not only a green check mark appears below,
    the number of the systems is now visible.

    You can select specific systems by clicking on system categories (SAN, Storage, etc.) or choose All or None,
    It is prudent to choose only the systems you wish to check, to reduce the amount of data that will be transferred.

guiloading.jpg
2022-12-30 11_35_44-Ninox Database.jpg
2022-12-30 15_19_42-BVQ - Select managed systems.jpg

 

  1. Connection Profile
    If your connection is not established, you may need to modify the connection profile, which is used to connect to the database.
    You can edit your current profile with the correct values, you can also add a connection profile.
    There is also the easy option to open a already downloaded profile (BDPM File).

2022-12-30 11_36_46-Ninox Database.jpg
2022-12-30 11_36_05-Ninox Database.jpg
2022-12-30 15_03_49-Ninox Database.jpg

 

 

  1. Load Data
    With an established connection and selected systems, you are ready to to click "Start" to load data.
    Depending on your connection and the amount of loaded data, the BVQ° GUI will load for a few minutes.

2022-12-30 15_51_43-Ninox Database.jpg
2022-12-30 15_52_02-Ninox Database.jpg

 

 

  1. Ready to Analyze
    Your BVQ° GUI is ready for use and you can get started right away.

2022-12-30 16_00_29-Ninox Database.jpg

 

 

  1. Get Familiar
    Create your own view by arranging a Path.
    Followed by selecting specific objects, by using the Columns tab under the Tree table.

    Each Master Grouping Object you choose to add, to the Path will unlock new objects selectable in the Columns.
    Every object you select in the Columns will appear as a new column in your Main Window view.

2022122354234.jpg
2022-12-30 16_13_34-Ninox Database.jpg
2022-12-30 16_16_47-Ninox Database.jpg

 

 

  1. Use Favorites
    Make use of our Favorites and customize them to your liking,
    safe them in your User folder.

20221234343625657.jpg
20221232465116.jpg

 

 




Related content