Page History

...

Download the distribution from the VIVO repository on GitHub. The standard distribution consists of the projects required to create a home directory for VIVO, and to copy the web application and search index. All the compiled code and dependencies are resolved from the Maven central repository at the time you run Maven.

The standard distribution is laid out as follows:

Code Block

language	text

vivo-1.1011.01/
  pom.xml
  example-settings.xml
  home/
    pom.xml
    src
  solrwebapp/
    pom.xml
    src
   webappinstaller/
    pomexample-settings.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 standard distribution, called " example-settings.xml "can be found in the installer directory of the distribution. You may copy this file (it can be called anything you like), and edit the contents to fit your requirements / system configuration.

...

Code Block

language	text

$ cd VIVO
VIVO$ mvn install -s installer/example-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 SolrWeb App
[INFO] VIVO Prepare Web App
[INFO]                                                                         
....

The VIVO home directory will now be created and the VIVO application installed to Tomcat.

...

Code Block

language	text

$ git clone https://github.com/vivo-project/Vitro.git Vitro -b rel-1.10-maint
$ git clone https://github.com/vivo-project/VIVO.git VIVO -b rel-1.10-maint
$ ls -l
drwxr-xr-x  user  group  1 Dec 12:00  Vitro
drwxr-xr-x  user  group  1 Dec 12:00  VIVO

Note

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

Note

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.

...

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 "example-settings.xml". You may copy this file (it can be called anything you like), and edit the contents to fit your requirements / system configuration.

...

Code Block

language	text

$ cd VIVO
VIVO$ mvn install -s installer/example-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 SolrWeb App
[INFO] VIVO Prepare Web App
[INFO]                                                                         
....

The VIVO home directory will now be created and the VIVO application installed to Tomcat. To run VIVO, please read the section below "Completing the Installation".

...

Code Block

language	text

$ cd VIVO
VIVO$ mvn install -s installer/example-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]                                                                         
....

...

Configure the Database Schema

Info

title	SDB vs TDB

Note, VIVO v1.11.0 uses SDB by default, however v1.11.1+ uses TDB by default. If you are using v1.11.1+ you can skip the 'Configuring the Database Schema' section.

The default configuration of VIVO is to use MySQL as a backing store for Jena SDB. Whilst VIVO / 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)

Code Block

language	text

$ 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 vitrodb CHARACTER SET utf8;
mysql> GRANT ALL ON vitrodb.* TO 'vitrodbUsername'@'localhost' IDENTIFIED BY 'vitrodbPassword';
mysql> FLUSH PRIVILEGES;

For For MySQL 8+, the second command must be split into two commands like so:

Code Block

language	text

mysql> CREATE USER 'vitrodbUsername'@'localhost' IDENTIFIED BY 'vitrodbPassword';
mysql> GRANT ALL PRIVILEGES ON vitrodb.* TO 'vitrodbUsername'@'localhost';
mysql> FLUSH PRIVILEGES;

Configure the Home Directory

There are two configuration files 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.

Code Block

language	text

$ cd /usr/local/vivo/home/config
/usr/local/vivo/home/config$ cp example.runtime.properties runtime.properties
/usr/local/vivo/home/config$ cp example.applicationSetup.n3 applicationSetup.n3

...

title	Minimum Configuration of runtime.properties Required

In order for your installation to work, you will need to edit runtime.properties and ensure that the VitroConnection properties are correct for your database engine. They should look something like this.

for your installation.

Code Block

language	text

$ cd /usr/local/vivo/home/config
/usr/local/vivo/home/config$ cp example.runtime.properties runtime.properties
/usr/local/vivo/home/config$ cp example.applicationSetup.n3 applicationSetup.n3

Note

title	Minimum Configuration of runtime.properties Required

In order for your installation to work, you will need to edit runtime.properties and ensure that the VitroConnection properties are correct for your database engine. They should look something like this.

Code Block

language	text

VitroConnection.DataSource.url = jdbc:mysql://localhost/vitrodb
VitroConnection.DataSource.username = vitrodbUsername
VitroConnection.DataSource.password = vitrodbPassword

Configure and Start Solr

As of the 1.11.0 release of VIVO, Solr must be independently deployed and configured with the schema expected by VIVO. Then VIVO must be configured to connect to the external Solr.

Download and install the latest 7.x version of Solr (installation instructions)
1. The directory in which Solr is installed is referenced below as ${SOLR_HOME} (e.g. /opt/solr/solr-7.7.2)
2. Package managers may result in ${SOLR_HOME} being different than the installation directory. You can confirm the value of ${SOLR_HOME} by visiting http://localhost:8983/solr and checking the value of "solr.solr.home" in the Java Properties list, or running
  Code Block
  language bash
  curl --silent http://localhost:8983/solr/admin/info/system | grep -e "solr_home"

Add the vivocore directory of the vivo-solr GitHub repository and its contents into ${SOLR_HOME}/server/solr

The end result should be a directory structure such as:

No Format
${SOLR_HOME}/server/solr/vivocore/core.properties └── conf/ ├── currency.xml ├── elevate.xml └── ...

Start Solr
No Format
${SOLR_HOME}/bin/solr start
Remove schema.xml from ${SOLR_HOME}/server/solr/vivocore/conf
1. When solr was started it created the managed-schema automatically from the schema.xml and is no longer needed
Update VIVO runtime.properties as below to point to the URL of your Solr
No Format
vitro.local.solr.url = http://localhost:8983/solr/vivocore
Start VIVO!
1. Note: If VIVO was started before connecting to Solr, please restart VIVO.

...

language	text

...

Configure and Start Tomcat

...

Take care when creating Context elements

Each of the webapps The webapp (VIVO) in the VIVO distribution (VIVO and Solr) includes a "context fragment" file, containing some of the deployment information for that webapp.

...

When you Start tomcat , you see that Tomcat recognizes the webapp, and that the webapp is able to present the initial page.
The startup status will indicate if the basic configuration of the system was successful. If there were any serious errors, you will see the status screen and will not be allowed to continue with VIVO. If there are warnings, you will see the status screen when you first access VIVO, but after that you may use VIVO without hinderance. In this case, you can review the startup status from siteAdmin -> Startup status.
Log in as root. Your root username is vivo_root@yourdomainname root@mydomain.edu (or the email you configured in runtime.properties). The first time root password is rootPassword. You will be asked to change it.

...

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Preparing the Installation Settings

Configure the Database Schema

Configure the Home Directory

Configure and Start Solr

Configure and Start Tomcat

Take care when creating Context elements