Skip to main content
Version: 3.6.x and earlier

Updating a JATOS server installation

Updating the server instance is equivalent to doing it locally, but make sure that you know what you're doing; especially if you have paired JATOS with a MySQL database.

Backup your JATOS

The easiest way to backup is to do a snapshot of the whole server. If you use an external MySQL database with your JATOS, make a backup e.g. using mysqldump -u yourUserName -p yourDatabaseName > yourDatabaseName.out - or a snapshot of the whole database server.

As with updating of a local JATOS installation you can do it automatically or manually.

After updating you can check the new JATOS installation with the test page: go to AdministrationTests and check that all tests are 'OK' (in older version the test page is under '/jatos/test', e.g. for a local installation: localhost:9000/jatos/test).

This is the easiest way but is only available since JATOS 3.3.5. Then it's the same as in a local installation.

If you did a manual backup before you don't need to do the backup offered during the update process.

Manual Update (if automatic doesn't work for you)

You have two ways to update manually: 1) Keep your studies but discard all your result data and batches. 2) Keep everything, including your studies and result data (might not always be possible).

First option: quick and dirty (discarding result data)

You can just follow the update instructions for the local installation. If you use a MySQL database don't forget to configure it with a clean and new one (not the one from your old JATOS). Do not use the new JATOS with the old MySQL database unless you choose to keep your data, as described below.

Second option: keeping everything

This means that we have to configure the MySQL database or copy the embedded H2 database files.

  1. Stop the old JATOS using ./ stop
  2. Copy the new JATOS version to your server, e.g. copy it into the same folder where your old JATOS is located. Don't yet remove the old JATOS instance.
  3. Unzip the new JATOS (unzip
  4. From the old JATOS installation copy some folders to the new one
    1. Your assets root folder to the new JATOS installation (Note: By default your assets root folder is called study_assets_root and lays in the JATOS folder but you might have changed this.
    2. If exists, your folder for uploaded result files (Note: By default this folder is called result_uploads and lays in the JATOS folder but you might have changed this. This folder exists since version 3.5.1.
    3. If exists, study_logs
  5. Database
    • H2 - If you are using the default H2 database: From your the folder of your old JATOS installation copy the folder database to the new JATOS installation. Remember to stop JATOS before copying the folder.
    • MySQL - For MySQL you don't have to change anything on the database side.
  6. Configure the new JATOS like the old one - usually it's enough to copy the production.conf from the old conf folder into the new one
  7. Start the new JATOS using ./ start
  8. Open JATOS' test page (AdministrationTests) and check that everything is 'OK'