Skip to content


Add an agent

Adding agents to your dashboard is quick and easy.

Log in and view your dashboard.

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

Name the agent

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

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

Proceed through the installation on a suitable machine.

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


The chosen machine must be able to communicate with:

  • Database server
  • Network location temporary backups are stored
  • DBeeKeeper services (see connection details below)

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

Wizard step 1 - Confirm the agent has connected to our services

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 2 - Confirm the client can respond to messages we send

An agent needs to be able to publish messages to DBeeKeeper services. This uses the same connection details as above.

Wizard step 3 - Set connection string

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

Set connection string

Wizard step 4 - Set backup path

Provide a path where you want the temporary backups to be made.

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 5 - perform a test backup

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

Click 'Test backup' to start the process.

Choose a database

Once complete you may proceed to the dashboard.

Setup complete!

Setup complete!

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