VIVO Documentation
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.
...
In order to run VIVO, please read the section below "Completing the Installation".
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||
---|---|---|
| ||
$ 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 that the Maven project numbers are kept in sync |
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.
...
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".
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.
...
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 | ||||
---|---|---|---|---|
|
Configure the Database Schema
Info | ||
---|---|---|
| ||
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 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 | ||
---|---|---|
| ||
$ 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 MySQL 8+, the second command must be split into two commands like so:
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
$ 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.
Code Block | ||
---|---|---|
| ||
VitroConnection.DataSource.url = jdbc:mysql://localhost/vitrodb
VitroConnection.DataSource.username = vitrodbUsername
VitroConnection.DataSource.password = vitrodbPassword |
Instead, example files are created in the home directory, which can be copied and used as the basis for your installation.
Code Block | ||
---|---|---|
| ||
$ 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 | |||||
---|---|---|---|---|---|
| |||||
In order for your installation to work, you will need to edit
|
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)
- The directory in which Solr is installed is referenced below as ${SOLR_HOME} (e.g. /opt/solr/solr-7.7.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"
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)
- The directory in which Solr is installed is referenced below as ${SOLR_HOME} (e.g. /opt/solr/solr-7.7.2)
- The directory in which Solr is installed is referenced below as ${SOLR_HOME} (e.g. /opt/solr/solr-7.7.2)
- 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
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!
- Note: If VIVO was started before connecting to Solr, please restart VIVO.
...
- 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.
...