Versions Compared

Key

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

...

Code Block
languagetext
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.

Code Block
languagetext
$ 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]                                                                         
....
 

At this point, the 

Completing The Installation

 

Installing from GitHub

Preparing the Repositories

...

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.

Preparing the Installation Settings

In order to fully install VIVO, you need to create a settings file that provides some essential information:

...

This file needs to be created following the Maven Settings Reference. A template file has 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.

Code Block
languagetext
$ 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.

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.

 

Code Block
languagetext
$ 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