Skip to content

Installation Windows

Add an agent

Adding agents to your dashboard is quick and easy.

Log in and view your dashboard.

Click the 'Add' button.

No agents yet?

If you have no agents set up, you will be prompted to add one:

It's lonely here....

Already up and running?

An add button will be available at the base of the agent list:

Dashboard with Add button

Agent settings

Choose a suitable name for your backup agent. For this demo we chose 'DB-01'.

Choose a time zone. When scheduling tasks for this agent all times will be shown in this time zone.

Choose where backups should be stored inline with your data policies.

Finally click 'Next'.

Name the agent

Make a note of the installation key

You will be prompted to download the installer and shown the installation key required to install the agent. Keep this window or code handy or on the clipboard.

Name the agent

Run the installer on remote system


The chosen machine must be able to communicate with:

  • Database server
  • Network location temporary backups are stored
  • DBeeKeeper services (see connection details below)
Windows Smart Screen - Windows protected your PC

If you have Microsoft Smart Screen (Wikipedia) you will receive a warning suggesting this application could harm your computer.

Smart Screen does not prevent bugs or malware in software - it verifies the publisher and the product has not been tampered with since signing.

Even if we paid for a Code Signing Certificate the number of installations per day (~100) is too few to build reputation (see criticisms of the system on Wikipedia).

Smart Screen Warning

You may run the installer by clicking 'More info' and then Run anyway.

Run anyway

Proceed through the installation on a suitable machine.

When prompted by the installer provide the installation key:

Provide installation key

Follow the instructions to complete the installation.

Online wizard

Return to the browser window. You should see your new agent is running.

Running Agent

Click Next to proceed to the wizard.

Wizard step 1 - Check agent communication

In order to work correctly, the agent needs to create an outgoing connection to DBeeKeeper services.

Connection details

You may need to add a firewall rules.

Protocol: TLS over TCP
Port: 5671

Wizard Step 1

Wizard step 2 - Check database connection


The user needs to be in the 'sysadmin' role.

Click the 'Set Connection String' button.

Wizard Step 2

You can enter a connection string with a username and password or specify the SSPI security model.

SSPI with AD

If you opt for SSPI, you should change the identity of the service to match the database user's identity.

Wizard Step 2

To set the service log on, right click the 'DBeeKeeper' service, choose 'Properties' and select the 'Log On' tab. Enter the user's credentials including any AD / domain information.

Wizard Step 2

SSPI without AD

If you can't use a domain account with SSPI and are running the DBeeKeeper agent and database server locally, you may use a local built in identity with SSPI.

By default the DBeeKeeper agent runs under the 'Local System' account.

The corresponding account in SQL Server is 'NT AUTHORITY\SYSTEM'.

This SQL user will need adding to either 'sysadmin' or 'serveradmin'.

Continue to provide the connection string the agent is to use to perform backups. The connection string is tested at this point.

Secure connection string storage

The connection string is stored securely. It is encrypted before being stored (the encryption keys used for this are not held within the database).

Set connection string

Wizard step 3 - Set backup path

Provide a path where you want the temporary backups to be made. We attempt to pre populate a suggested directory path.

The path must be writable by the database server as this is where it will output backups.

Similarly, DBeeKeeper needs to be able to access the directory to process the backup after it is made.

Should I create a new directory for this?

Yes. We will make edits to files within this directory and remove files after every completed backup when we perform 'Clearing up'.

Set backup path

Wizard step 4 - Test settings

Select a database to test the backup process. A copy-only backup is taken.

Click 'Test backup' to start the process.

Choose a database

The wizard will the test the process end to end.

Test setup!

Once the process has completed you can continue to your dashboard.

Setup complete!

Setup complete!

Well done, you've set up your first agent! The agent will auto update to make your life easier.