Upgrading VECTR

VECTR is a suite of services and components which can be hosted in various environments. Docker helps make it a lot easier to update, and once a migration is completed to a 5.5+ version it will be very straightforward. Upgrading/Migrating an existing installation in place can still be challenging. As a result, we'll be going into detail depending on your situation.


With 6.0 we've migrated to a new authentication platform. Because of this you'll need to make updates to the .env file to provide new variables. As always it's recommended to make a backup of your working VECTR directory just in case. The following lines must be added to the .env file.


This is the "name" displayed by the application at the login screen.



JWT signing (JWS) and encryption (JWE) keys. Do not use the same value for both signing and encryption! It is recommended to use at least 16 characters. You may use any printable unicode character

The following variables can be removed


Following this you can simply update the container version.

Update docker-compose.yml

    image: securityriskadvisors/vectr_tomcat:5.5.6


    image: securityriskadvisors/vectr_tomcat:6.0.1

Then simply

docker-compose down
docker-compose up

5.5.x - 5.7.x

For any minor revision 5.5.x - 5.7.x the best method is to edit your docker compose to reflect the latest version from Docker Hub

For example update docker-compose.yml

    image: securityriskadvisors/vectr_tomcat:5.5.6


    image: securityriskadvisors/vectr_tomcat:5.5.7

Then simply

docker-compose down
docker-compose up

Note this may not always be the recommended procedure for future upgrades, always check back here for guidance

5.1 - 5.4

If upgrading to the current version from an existing version between 5.1-5.4 there is a migration required. This is a detailed process that needs to be completed see Migration Process

5.0 and earlier

Prior to the VECTR 5.1 release, VECTR used a different authentication back-end service. The new service (CAS) is incompatible with user data and credentials from the old service in 5.0. If you are upgrading an existing installation prior to 5.1 you will need to perform additional steps to reset your user account to default credentials so you can login.

  1. Stop your VECTR docker containers and backup your VECTR data directory by copying the contents of it to a safe backup location (or perform a mongodump into a shared docker volume)

  2. Restart your VECTR docker containers and run sudo docker ps -a on your host to get the container name of your VECTR mongo container. You should see something like the following case where sravectr_mongo is my container name:

CONTAINER ID    IMAGE                   COMMAND                 NAMES
bb9eaa6a6030    vectr_tomcat:latest     "catalina.sh run"       sravectr_tomcat
bb9daaabbc33    mongo:3.4               "docker-entrypoint.s…"  sravectr_mongo
  1. To delete your old user db run the following command with your actual VECTR mongo container name in the correct argument position: sudo docker exec -it <YOUR_VECTR_MONGO_CONTAINER_NAME> mongo SRAUSERDB --eval "printjson(db.dropDatabase());"

  2. Stop your VECTR mongo containers and continue with upgrade instructions below if you received an OK message. The new authentication service will create a new default user account and you will be able to create additional accounts in the system.

Note: if you see a message saying "Hi, admin. You have successfully logged into the SRA SSO. However, you are seeing this page because CAS does not know about your target destination and how to get you there.", just wait a minute and try navigating to the site again.