Skip to content

Update Instructions (On-Premise/Docker)

Update instructions for Botium Box Enterprise Edition (On-Premise)

Quick Steps

In most cases, the update is as simple as this:

  1. Update the Botium Box version tag in your docker-compose.yml

  2. Run docker-compose up -d

Full Update Instructions

It is highly recommended to make a database backup before starting a software update.

Note

Botium Box is built in a way to do automatic database migrations wherever possible, but we strongly advice to act according to Murphy’s law.

See Operational Tasks: Backup/Restore/Monitoring for instructions how to backup and restore your database with phpMyAdmin.

Getting the Software

Download or pull this Github Repository first to get the Docker compose definitions updates.

> cd botium-box-premium-dist

> git pull

Docker images itself are published on Docker Hub.

Git Conflicts

Most likely, you did some changes to your local distribution repository (license key) - in this case, there will be a git conflict. Either clone the repository into a different directory, or reset the local distribution (extract the license key first and add it again afterwards):

> git checkout docker-compose.yml

Manual Preparation Steps

For certain Botium Box releases, there are manual migration steps to be done. Please consult Botium Box Migration Steps if it applies to the update in question.

Updating the Docker Images

The Botium Box docker images have a version tag and will be pulled by docker automatically. You can run these commands to pull the latest Botium Box images manually (replace <version> with the version tag to pull):

>docker-compose pull

Rebuilding and Restarting Botium Box

Botium Box now has to be restarted, and docker has to be adviced that new docker container images are available. First stop Botium Box:

>docker-compose stop

Then start it up again - this can take a while:

> docker-compose up -d

Updating Agents List

When the Botium Box Agents containers are updated, what’s actually happening is a removal and recreation of the containers. In case your Botium Box license only includes a limited number of agents, you have to remove the existing agents from the Agents section in Botium Box, in order to free the resources for the new agents coming up on the update.

Manual Finalization Steps

For certain Botium Box releases, there are manual migration steps to be done. Please consult Botium Box Migration Steps if it applies to the update in question.

Logout and Login

To reset the client session, please logout and login again with your webbrowser.