HQbird Installation

In this article, you can find instructions and videos how to install HQbird on Linux and Windows.

How to install HQbird ServerSide for Linux

First of all, download HQbird ServerSide for Linux with integrated Firebird from this location.

This archive contains 2 files: install_fb25_hqbird_server_2017R2.sh and install_fb30_hqbird_server_2017R2.sh.
You must be root or sudoer to install HQbird on Linux!
General prerequisites: install java version 1.8 before installing HQbird.

Installation of HQbird with Firebird 2.5 on Linux

  1. Uninstall all previously installed Firebird versions before running this installer
  2. Apply execution rights to the installation package:
    chmod +x install_fb25_hqbird_server_2018.sh
  3. Run installation script install_fb25_hqbird_server_2018.sh. It will install Firebird into /opt/firebird and HQbird into /opt/hqbird
  4. By default, Firebird 2.5 is installed as Classic. We recommend to install it as SuperClassic - for this run script /opt/firebird/bin/ChangeMultiConnectMode.sh and choose thread
Next steps:
  1. Please note that Firebird 2.5 will be installed with SYSDBA/masterkey
  2. You can stop/start Firebird 2.5 with command service firebird stop/start. Check is it running with command ps aux | grep fire
  3. You can stop/start HQbird with command service hqbird stop/start. Check is it running with command ps aux | grep dataguard
  4. Run browser, and log in to HQbird FBDataGuard http://serverurl:8082, with user/password = admin/strong password 
  5. Choose "I have HQbird Enterprise" and register HQbird with the email and password you have received from IBSurgeon Deploy Center.
  6. Follow steps to setup HQbird with replication.

Installation of HQbird with Firebird 3.0 on Linux

Prerequisites: make sure you have libtommath and ICU installed (there will be appropriated error message if they are not installed).
  1. Uninstall all previously installed Firebird versions before running this installer
  2. Apply execution rights to the installation package:
    chmod +x install_fb30_hqbird_server_2018.sh
  3. Run installation script install_fb30_hqbird_server_2018.sh. It will install Firebird into /opt/firebird and HQbird into /opt/hqbird
  4. By default, Firebird 3.0 is installed as SuperServer. Keep it.
  5. Firebird 3.0 will be installed with SYSDBA/masterkey
Next steps:
  1. You can stop/start Firebird 3.0 with command service firebird-superserver stop/start. Check is it running with command ps aux | grep firebird
  2. You can stop/start HQbird with command service hqbird stop/start. Check is it running with command ps aux | grep dataguard
  3. Run browser, and log in to HQbird FBDataGuard http://serverurl:8082, with user/password = admin/strong password 
  4. Choose "I have HQbird Enterprise" and register HQbird with the email and password you have received from IBSurgeon Deploy Center.
  5. Follow steps to setup HQbird with replication.

Installation of HQbird Standard - without bundled Firebird

To install HQbird Standard, to be used with already installed Firebird, use installer option --nofirebird

install_fb25_hqbird_server_2018.sh --nofirebird

After the installation, specify the location of installed Firebird in the Server registration dialog.
We recommend to install community Firebird from tar.gz file, not from repositories, so it will be installed into /opt/firebird.

Firewall settings

Firebird is installed on port 3050, HQbird web interface is listening on port 8082, and licensing interface is listening on 8765. These ports can be changed in /opt/firebird/firebird.conf (RemoteServicePort), /opt/hqbird/conf/network.properties (server.port) and /opt/hqbird/conf/license.properties (serverlicense.port).
Make sure to allow these ports in your firewall.

How to uninstall HQbird on Linux

There is the script /opt/hqbird/uninstall.sh, which uninstalls both HQbird and Firebird. Please note, that this script does not keep the existing configuration of HQbird, and it uninstalls Firebird binaries, configuration, and "firebird" user on Linux.

How to install HQbird ServerSide for Windows

Please read the full version of the installation process in HQbird User Guide.
HQbird ServerSide 2017 includes Firebird 2.5 and 3.0 as part of its installer, so Firebird will be installed as part of HQbird. It is mandatory to install Firebird bundled with HQbird ServerSide installer if you plan to use replication (it also requires HQbird Enterprise license, full or trial).

Optionally you can choose not to install Firebird with HQbird and use previously installed Firebird – in this case, make sure that installed version is compatible (1.5, 2.0, 2.1, 2.5.2, 2.5.5, 2.5.6, 2.5.7, 2.5.8, 2.5.9, 3.0.1, 3.0.2, 3.0.3, 3.0.4).

Please note, that only Firebird 2.5 and 3.0 are fully supported in HQbird, the old Firebird versions are supported partially. We offer the affordable Firebird migration service with a guaranteed and fast result to migrate Firebird to the latest version.

Installing HQbird Server

Download HQbird Server from http://ib-aid.com/en/hqbird/. The distribution package of HQbird is the same for the 32-bit and 64-bit versions of the Firebird engine.

The fastest way to install HQbird is to use silent installation command:

In the example below we will install HQbird Enterprise with Firebird 3.0 into c:\HQbird, configuration will be c:\HQbirdData\config, output in c:\HQbirdData\output.

HQBirdServer2018R4.exe /VERYSILENT /SP- /TYPE="hqbird30x64" /DIR="C:\HQbird" /CONFIGDIR=C:\HQBirdData\config /OUTPUTDIR=C:\HQBirdData\output
In the command prompt specify: 
/VERYSLIENT /SP-   options to perform the silent installation
/TYPE - what HQbird version should be installed. If you are doing silent upgrade, make sure the version is the same as it was installed previously.
  • "HQBird25x86" - "HQbird Enterprise (with Firebird 2.5 x32)"
  • "HQBird25x64" -"HQbird Enterprise (with Firebird 2.5 x64)";
  • "HQBird30x86" - "HQbird Enterprise (with Firebird 3.0 x32)"
  • "HQBird30x64" -  "HQbird Enterprise (with Firebird 3.0 x64)"
  • "StdHQBird" - "HQbird Standard (no Firebird engine)"
/DIR  - where to install HQBird. If you are doing silent upgrade, make sure the version is the same as it was installed previously.
/CONFIGDIR - where to store configuration data for HQbird
/OUTPUTDIR - where to store output data
Optional parameters:
/fbport=3050   - port for Firebird to be installed with HQbird Enterprise
/LOG=C:\temp\log.txt   - where to store installation log

For the normal installation with GUI follow the instruction below:

Check that HQbird Server installer is signed with the iBase.ru certificate and run it:
Figure 1. HQbird Server-Side Tools should have the signature
The HQbird Server installation wizard will be launched after that and it will take you through several steps, such as agreeing to the license agreement and selecting the installation folder.
After that you will see the installation step where you can select components to be installed:

Figure 2. Select components from HQbird Server to be installed

If you select to install Firebird with HQbird (recommended), it will install Firebird in the subfolder of HQbird installation, by default C:\HQBird\Firebird25 (C:\HQBird\Firebird30).  The installation wizard will ask to specify the port for Firebird engine installed with HQbird. By default, the port is 3050. If the port will be occupied by another running Firebird, the installation wizard will warn you and make to choose another port. Or, you can stop and uninstall another Firebird service.
If you don't opt to install Firebird with HQbird, the installation wizard will ask you to specify the folder where Firebird is installed:

Figure 3. Confirm the location of the current Firebird instance
Attention! In this step, the installation wizard checks the availability and compatibility of the installed Firebird version with HQbird. If the specified folder does not contain a correctly installed Firebird version, you will see the following warning:

Figure 4. This warning from the installation wizard prompts you to select the correct Firebird folder
If the specified folder contains a version of Firebird incompatible with HQbird, you will see the following warning:

Figure 5. This warning informs you that you need to update Firebird
You should update Firebird to version 2.5.5 or higher for HQbird Standard to be installed.
After that you should select folders for storing configuration files, backup copies, statistics, and HQbird log files:

Figure 6. Select folders for HQbird configuration and log files
By default, the installation wizard offers to create folders for configuration and log files in C:\HQbirdData.
Usually, we recommend that you select another location for these purposes on a disk with a larger amount of free space.
If configuration files already exist in the selected location, the installation wizard will display the corresponding warning:

Figure 7. Warning about existing configuration files
If you decide to rename the existing configuration folder, the installation wizard will display one more warning:

Figure 8. Renaming confirmation
After you confirm it, the folder with the existing configuration files will be renamed and the installation will continue.
You may have to restart the computer after the installation:

After that, you have to activate HQbird (see How to Activate HQbird) and proceed to configure the HQbird components.

Installing HQbird Admin (Windows)

To install HQBird Admin, download the distribution package from http://hqbird.com/en/hqbird/.

Run the installation wizard and follow the standard installation steps: select the installation folder:

Figure 9. Select where to install HQbird Administrator
Select the tools to install after that. We recommend that you install all tools.

Figure 10. Select tools to install
Follow the instructions after that. After the installation is over, you will be offered to launch the activation wizard.

How to Activate HQbird

To activate HQbird, you can either use a separate utility included in the server and administrator packages for Windows, or use the registration mechanism embedded into the HQBird Firebird DataGuard web interface (for Windows and Linux), or run any tool from the administrator software and use the built-in activation wizard.
The activation wizard looks and works the same both in the tools and in the separate utility. It is enough to perform activation once on any computer that can connect to the server where HQbird Server-Side Tools is installed.
You can launch the registration utility from the Start menu (IBSurgeon\HQbird Admin\Register HQbird). It looks something like this:

Figure 11. HQbird Registration Utility
If you click the Register button (or Re-Register for repeated registration), you will see the activation wizard:

Figure 12. HQbird Activation Wizard
To activate HQbird, specify the IP address or the name of the server HQbird is installed on in the upper input field and click Connect to HQbird Server.
Then enter your registration data. If you have a license, enter your e-mail address and password that you used to register with the IBSurgeon Deploy Center and click Activation.
If you have no license, specify your e-mail address and click Activation. You will be automatically registered and the password will be sent to your e-mail address.
Right after you click Activation, the registration wizard will try to connect to the IBSurgeon Deploy Center (http://deploy.ib-aid.com) and obtain a license. If it succeeds, you will see the corresponding message. If there are any problems, you will see the error message.
If you forget the password, click the I forgot password... button and it will open the browser with the password recovery form.
If you need to purchase a new or additional license or renew your subscription, click Order now!
Click Close this window after the registration is over.

Internet Activation via a Client Computer

If the server with HQbird Server-Side Tools installed on it does not have access to the Internet, you can still activate it via the Internet: you can install HQbird Administrator on any client computer that has both access to the Internet and access to the HQbird Server-Side Tools server and perform activation.

Run HQbird Register tool and enter there: IP address of your server (or server name), email and license, and click Activate:


Offline Activation

If the server and all client computers have no access to the Internet, you should use offline activation. To do it, contact us at [email protected] specifying the number of your order.

How to install Firebird for Windows

To install Firebird, download the HQbird Server (Firebird Engine) module from http://hqbird.com/en/hqbird/download-hqbird (select the 32-bit or 64-bit version depending on the operating system and other requirements).
This module is actually an archive file with Firebird 2.5.5. Unpack the archive file to a suitable location (for instance, C:\Firebird255), go to the Bin folder and then use the Run As Administrator option to run the batch file with the architecture you need.
We recommend that you run the file install-superclassic.bat that will install Firebird with the SuperClassic architecture. Provided that you use the optimized configuration file firebird.conf (see Optimized Configurations below), this architecture is the best default choice for Firebird 2.5 running on systems with medium loads.
Of course, you can choose the SuperServer or Classic architecture if you know what you need.
As a result of running the command file, Firebird of the selected architecture will be installed and run as a service. You can make sure the Firebird service is installed and running in the Services snap-in (services.msc):

Figure 13. Firebird Service
In this example, Firebird is installed in the folder H:\Firebird\Firebird- and running as a service with the SuperClassic architecture.

How to Update Firebird on Windows

If you get the message that you need to update Firebird to version 2.5.5 during the installation of HQbird Server-Side Tools, do the following:
1)      Download the HQbird Server (Firebird Engine) archive file corresponding to the version of Firebird installed on your computer. For instance, if you have 64-bit Firebird 2.5.3 installed, you should download HQbird 64-bit.
2)      Back up all Firebird databases with the help of the gbak utility (or make sure that you have an up-to-date backup copy created with gbak).
3)      Close all user and system applications using Firebird.
4)      Stop the Firebird service. Note that if you use the Classic architecture, you will have to not only stop the service but also manually stop (e.g. in Task Manager) all fb_inet_server.exe processes.
5)      Rename the bin folder in the Firebird folder into binOrig.
6)      Copy the bin folder from HQbird Server (Firebird Engine) to the Firebird folder.
7)      Start the Firebird service and make sure your applications are running correctly.
8)      If you update Firebird from version 2.5.1 or earlier, schedule to run the backup/restore cycle for your databases as soon as possible in order to make the on-disk structure (ODS) of your database compliant with the Firebird version being used or otherwise some important features will be unavailable. If you update from version 2.5.2 or higher, the backup/restore cycle is not required.
9)      Continue installing HQbird Server-Side Tools.

How to uniinstall HQbird on Windows

In Start menu, choose Control Panel – Uninstall a Program, then select HQbird Server Side or HQbird Admin, and uninstall HQbird. Uninstallation requires administrative rights.


What HQbird Modules Consist of

It is possible to single out components in the HQbird modules that are responsible for certain operations (such as backup, monitoring, database repair).
Figure 15. HQbird Modules
The table below shows how features are distributed among the HQbird modules:
Features Modules Description
(automated verified and incremental backup, cloud backup)
FBDataGuard FBDataGuard runs on the server side and performs all kinds of backup
Optimized Configurations
(balanced, read-intensive and write-intensive)
FBDataGuard, a collection of optimized configurations The optimized configuration file is finally customized on the basis of recommendations from FBDataGuard
Performance Test Suite Performance Test Suite The test measures the hardware performance
Monitoring SQL Queries
(MON$, TraceAPI, and FBScanner)
Performance Monitor, MON$Logger, FBScanner Three different monitoring methods are used in different scenarios
Health Monitoring
(online validation, database health check, log analysis)
FBDataGuard Everything is carried out on the server. FBDataGuard sends notifications by e-mail.
Transaction Tracking
(dynamic analysis of transaction markers)
FBDataGuard, Transaction Monitor, MON$Logger FBDataGuard tracks problems with transactions, Transaction Monitor and MON$Logger show the dynamics of changes and the current status of active transactions.
Database Structure Analysis
(table and index sizes, fragmentation, versioning, etc.)
Database Analyst Database Analyst analyzes the database structure in detail and shows warnings and recommendations.
SQL Development & Debugging
(a GUI tool for developing databases and queries)
SQL Studio SQL Studio is a powerful tool for developing and debugging database objects and SQL queries.
(database recovery, backup recovery, record undeletion)
FirstAID, FBDataGuard, IBBackupSurgeon, IBUndelete FirstAID repairs databases when they get corrupted, FBDataGuard stores important metadata thus increasing the chances of successful repairs, IBBackupSurgeon exports data from corrupted backup copies. IBUndelete and FirstAID undo record deletion.
High Availability
The HQbird Enterprise edition includes replication and high availability tools.