VIVO Documentation
Old Release
This documentation relates to an old version of VIVO, version 1.9.x. Looking for another version? See all documentation.
Installing from Distribution
Overview
vivo-1.9.0-rel/
pom.xml
default-settings.xml
home/
pom.xml
src
solr/
pom.xml
src
webapp/
pom.xml
src
Preparing the Installation Settings
In order to fully install VIVO, you need to create a settings file that provides some essential information:
app-name
vivo-dir
tomcat-dir
This file needs to be created following the Maven Settings Reference. A template file already exists within the VIVO project, called "default-settings.xml". You may copy this file (it can be called anything you like), and edit the contents to fit your requirements / system configuration.
Installing VIVO
Once you have an appropriate settings file (these instructions will assume that you are using default-settings.xml - replace this with your actual file), you simply need to run Maven, specifying the install goal, and your settings file.
$ cd VIVO VIVO$ mvn install -s default-settings.xml [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------------ [INFO] Reactor Build Order: [INFO] [INFO] Vitro [INFO] Vitro Dependencies [INFO] Vitro API [INFO] VIVO [INFO] VIVO API [INFO] Vitro Web App [INFO] VIVO Web App [INFO] Vitro Home [INFO] VIVO Home [INFO] Vitro Solr App [INFO] VIVO Installer [INFO] VIVO Prepare Home [INFO] VIVO Prepare Solr App [INFO] VIVO Prepare Web App [INFO] ....
The VIVO home directory will now be created, the VIVO application installed to Tomcat.
In order to run VIVO, please read the section below "Completing the Installation".
Installing from GitHub
Preparing the Repositories
In order to install the development code from GitHub, you need to clone both the Vitro and VIVO repositories from the vivo-project organization. These clones should be in sibling directories called "Vitro" and "VIVO" respectively:
$ git clone https://github.com/vivo-project/Vitro.git Vitro -b develop $ git clone https://github.com/vivo-project/VIVO.git VIVO -b develop $ ls -l drwxr-xr-x user group 1 Dec 12:00 Vitro drwxr-xr-x user group 1 Dec 12:00 VIVO
If you do not place the Vitro code in a sibling directory called "Vitro", then you will have to supply the "vitro-core" property to Maven - e.g. mvn package -Dvitro-core=~/Vitro
It is expected that the Maven project numbers are kept in sync between the Vitro / VIVO projects, however, depending on when you update / sync your repositories, you may need to adjust the project version numbers for the build to work.
Preparing the Installation Settings
In order to fully install VIVO, you need to create a settings file that provides some essential information:
app-name
vivo-dir
tomcat-dir
This file needs to be created following the Maven Settings Reference. A template file already exists in the "installer" directory within the VIVO project, called "default-settings.xml". You may copy this file (it can be called anything you like), and edit the contents to fit your requirements / system configuration.
Installing VIVO
Default Installer
Once you have an appropriate settings file (these instructions will assume that you are using installer/default-settings.xml - replace this with your actual file), you simply need to run Maven, specifying the install goal, and your settings file.
$ cd VIVO VIVO$ mvn install -s installer/default-settings.xml [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------------ [INFO] Reactor Build Order: [INFO] [INFO] Vitro [INFO] Vitro Dependencies [INFO] Vitro API [INFO] VIVO [INFO] VIVO API [INFO] Vitro Web App [INFO] VIVO Web App [INFO] Vitro Home [INFO] VIVO Home [INFO] Vitro Solr App [INFO] VIVO Installer [INFO] VIVO Prepare Home [INFO] VIVO Prepare Solr App [INFO] VIVO Prepare Web App [INFO] ....
The VIVO home directory will now be created, the VIVO application installed to Tomcat.
In order to run VIVO, please read the section below "Completing the Installation".
Custom Installer
If you want to use the source code / GitHub clone with your own customisations, you can exclude the supplied installer project, and use your own customized installer project instead. To do so, you need to supply the location of your custom installer project as the "vivo-installer-dir" property. This can be done on the command line, or in the settings.xml. If you are supplying a relative path, it should be relative to the location of the VIVO/pom.xml.
$ cd VIVO VIVO$ mvn install -s installer/default-settings.xml -Dvivo-installer-dir=../myedu-vivo [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------------ [INFO] Reactor Build Order: [INFO] [INFO] Vitro [INFO] Vitro Dependencies [INFO] Vitro API [INFO] VIVO [INFO] VIVO API [INFO] Vitro Web App [INFO] VIVO Web App [INFO] Vitro Home [INFO] VIVO Home [INFO] Vitro Solr App [INFO] Custom VIVO Installer [INFO] Custom VIVO Prepare Home [INFO] Custom VIVO Prepare Solr App [INFO] Custom VIVO Prepare Web App [INFO] ....
The VIVO home directory will now be created, the VIVO application installed to Tomcat, including any customizations that are defined in your local installer project.
Completing The Installation
Configure the Database Schema
The default configuration of VIVO is to use MySQL as a backing store for Jena SDB. Whilst VIVO / Jena will create the necessary tables for the triple store, a database (schema) and authentication details need to have been created first. To do so, log in to MySQL as a superuser (e.g. root)
$ mysql -u root -p Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 2 Server version: 5.7.9 MySQL Community Server (GPL) Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. mysql> CREATE DATABASE vivodb CHARACTER SET utf8; mysql> GRANT ALL ON vivodb.* TO 'vitrodbUsername'@'localhost' IDENTIFIED BY 'vitrodbPassword';
Configure the Home Directory
There are two configuration that are required to be in the home directory. By default, the installer does not create them, so that they are not overwritten when you redeploy the application. Instead, example files are created in the home directory, which can be copied and used as the basis for your installation.
$ cd /usr/local/vivo/home /usr/local/vivo/home$ cp example.runtime.properties runtime.properties /usr/local/vivo/home$ cd config /usr/local/vivo/home/config$ cp example.applicationSetup.n3 applicationSetup.n3
Minimum Configuration Required
In order for your installation to work, you will need to edit the runtime.properties, and ensure that the VitroConnection properties are correct for your database engine. They should look something like this.
VitroConnection.DataSource.url = jdbc:mysql://localhost/vivodb VitroConnection.DataSource.username = vitrodbUsername VitroConnection.DataSource.password = vitrodbPassword
Configure and Start Tomcat
Overview
Content Tools
All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license
, unless otherwise noted.