Be sure to review System Requirements before installing VIVO. 

Anchor
Distribution Distribution

Installing from Distribution

Overview

Download the 1.9.x distribution release 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:

vivo-21.010.0/
  pom.xml
  example-settings.xml
  home/
    pom.xml
    src
  solr/
    pom.xml
    src
  webapp/
    pom.xml
    src

...

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

Installing VIVO

Permissions

Make sure:

• The maven user has write permission to the Tomcat webapps directory. Maven will fail silently if it cannot copy files to tomcat.
• The tomcat user has write permission to the <vivo-dir>/home  directory.

Installing VIVO

Once you have an appropriate settings file (these instructions will assume that you are using Once you have an appropriate settings file (these instructions will assume that you are using example-settings.xml - replace this with your actual file), you simply need to run Maven, specifying the install goal and your settings file.

...

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

...

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.

Installing VIVO

Default Installer

Permissions

Make sure:

• The maven user has write permission to the Tomcat webapps directory. Maven will fail silently if it cannot copy files to tomcat.
• The tomcat user has write permission to the <vivo-dir>/home  directory.

Installing VIVO

Default Installer

Once you have an appropriate settings file (these instructions will assume that you are using installer/example-settings.xml - replace this with your actual file), you simply need to run Maven, specifying the install goal and your settings file.

...

The VIVO home directory will now be created and the VIVO application installed to Tomcat. In order to 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 customizations, 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/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]                                                                         
....

The VIVO home directory will now be created and the VIVO application installed to Tomcat, including any customizations that are defined in your local installer project.

...

  To run VIVO, please read the section below "Completing the Installation".

Anchor
Completing Completing

Completing the Installation

...

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

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

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

Configure the Home Directory

...

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

...

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

...

VIVO is a multithreaded web application that may require more threads than are permitted under the default configuration of your operating system's installation's default configuration. Ensure that your installation can support the required number of threads for your application.  For a Linux production environment you may wish to make the following edits to /etc/security/limits.conf, replacing apache and tomcat with the appropriate user or group name for your setup:

...