Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Overview

Upgrading If you are already running VIVO 1.10.x, you can upgrade to VIVO 1.10 requires upgrading your triple stores (content and configuration).  A procedure is provided below.  You should consider:

...

11.x without making any configuration or data changes.  Follow the procedure in Installing VIVO while using your existing installation settings (installation.xml).  If you have customized your VIVO 1.11 installation, you will need to take action to preserve those customizations. 


Note

...

If you have customizations, please see:

...

Changes to runtime.properties

Location

...

Upgrading from VIVO 1.10

...

Password hashing settings

VIVO 1.10 includes security enhancements to the way passwords are stored in VIVO. Three new settings are now required in runtime.properties. Add the following to an older version of runtime.settings (default settings shown):

Code Block
titleruntime.settings (snippet)
argon2.parallelism = 1
argon2.memory = 1024
argon2.time = 1000

For a full explanation of the new settings, see example.runtime.properties.

Upgrading The Triple Stores

Upgrading the triple stores (there are two - content and configuration) involves dumping the contents of your stores, and then reloading them, using tools provided with VIVO.

In order to upgrade your triple stores, use the following steps (replace <your-settings.xml> and <vivo_home> with the appropriate values for your system.

...

To export your triple stores, use the jena2tools utility provided with VIVO 1.10.0, in <vivo home dir>/bin, specifying the export command, as shown below.

Code Block
java -jar jena2tools.jar -e -d <vivo_home>

Arguments:

-d - the location of the Vitro/VIVO home directory

-e - run in export mode

On execution, the program will read your configuration files, find your VIVO configuration within the vivo home directory, and get the necessary information to connect to your configuration triple store, and your content triple store. If your triple store(s) are not SDB or TDB backed, they will be skipped.

jena2tools will then extract the contents of the triple stores, and write them to <vivo_home>/dumps

Warning

In rare cases jena2tools will fail with a java.lang.NullPointerException. This can occur if VIVO was not properly shut down before upgrading.

The preferred fix for this is to restore VIVO 1.9.x and see that it is properly started and shut down before upgrading. If this is not practical, another workaround is to delete the file named tdbModels/journal.jrnl in the Vitro/VIVO home directory. This may result in the loss of the most recent login information.

...

.x prior versions

If you are running VIVO 1.9.x please perform steps needed to upgrade to 1.10.x at Upgrading VIVO 1.9.x to 1.10.x

If you are running VIVO 1.8.x please perform steps needed to upgrade to 1.9.x at Upgrading VIVO 1.8.x to 1.9.x

If you are running VIVO 1.5.x - 1.7.x please perform steps needed to upgrade to 1.8.1 at Upgrading VIVO from release 1.5 to release 1.8.1

...

Drop your database and recreate it as empty, just as you would for creating a new VIVO install.  jena3tools must find an empty database (no tables) as named in your runtime.properties and will recreate your content triple store using the triples produced by jena2tools

Code Block
mysql> DROP DATABASE vitrodb;
mysql> CREATE DATABASE vitrodb CHARACTER SET utf8;
mysql> GRANT ALL ON vitrodb.* TO 'vitrodbUsername'@'localhost' IDENTIFIED BY 'vitrodbPassword';

Delete all files in <vivo_home>/tdbModels.  Jena3tools will rebuild your configuration tdbModels based on the content created by jena2tools

Code Block
rm -rf <vivo_home>/tdbModels

...

Having exported your triple stores, you can reload them using jena3tools, also available with VIVO 1.10, specifying the import command.

Code Block
java -jar jena3tools.jar -i -d <vivo_home>

Arguments:

-d - the location of the Vitro/VIVO home directory

-i - run in import mode

On execution, the program will find your VIVO configuration within the home directory, as well as the dumps that you have created with jena2tools. It will import them into the SDB and TDB triple stores, based on the configuration of your VIVO instance.

jena3tools will be present in <vivo home dir>/bin when you install the 1.10.

...