This document details the process for upgrading an existing ChemLocator docker installation. If you have not installed ChemLocator yet, the installation guide is appropriate.
Connect to the host machine where the ChemLocator installation is located, using
ssh. Next, find the folder where ChemLocator is installed.
We typically recommend
/usr/share/chemaxon/chemlocator/ as the default folder.
In case there are multiple environments hosted (e.g. production, testing, etc),
there may be further subfolders. The folder we are looking for is the one which
docker-compose.yml, for the environment we want to upgrade.
Change into this folder via the
All of the following steps assume you are in this folder.
The ChemLocator repository is located at
hub.chemaxon.com. By performing
docker login to this repository, you will be able to pull the ChemLocator
docker images. To start the login, use the following command:
docker login hub.chemaxon.com
The ChemLocator team should be able to provide you with a username and password.
Stop the ChemLocator containers using the following command:
sudo docker-compose stop
Note: this step might be optional for development environments.
docker-compose.yml file with any text editor. Version number you are
currently using will appear in two places, in both cases following the
node, just under the
chemlocator-java nodes, respectively
(see examples below). Both of these needs to be updated to the latest version
number, which should have been provided to you, and will be of the format
v188.8.131.52. As an example, changing form version
Before the change:
chemlocator: image: chemlocator.azurecr.io/chemaxon/chemlocator:v0.9.2.0
chemlocator-java: image: chemlocator.azurecr.io/chemaxon/chemlocator-java:v0.9.2.0
After the change:
chemlocator: image: chemlocator.azurecr.io/chemaxon/chemlocator:v184.108.40.206
chemlocator-java: image: chemlocator.azurecr.io/chemaxon/chemlocator-java:v220.127.116.11
Note: if you are going to be using CLiDE, you should also perform this process
for the line with the
chemlocator-java-clide image, instead of
You can use the
docker-compose pull command to update the images mentioned in
sudo docker-compose pull
Docker will go through each of the images mentioned in the file, and pull the latest version of the images specified.
This step is optional, and can be skipped.
Since we are going to have a lot of console logs output, it is recommended
that you clear your console via the
Start up the ChemLocator containers as a foreground process as follows:
sudo docker-compose up
There are two checks we can make to see that the images have been updated:
chemlocator-java. This is the first indication that an upgrade of images has been detected by Docker, and has been performed.
In preparation for starting ChemLocator as a background process in the next step, first stop it by pressing Ctrl+C in the console, and waiting for all the containers to stop.
docker-compose with the
-d flag, to indicate that it should run in
sudo docker-compose up -d