Introduction

This document tells you how to install VIVO on your computer.

• The introduction explains a few concepts about VIVO, how it is

...

• structured, and how it is built.
• The section entitled A simple installation describes a standard, simple installation for those who just want to get VIVO up and running.
• The section called Installation options describes several choices; some for production installations of VIVO, and some for developers who are working with VIVO on their desktops.

For information about this release, consult

...

the VIVO 1.6 Release Announcement. Links to this and other documentation can be found on the support page at VIVOweb.org.

...

...

...

...

...

How is VIVO distributed?

VIVO Source code

The latest release of VIVO can be found at the download page of VIVOweb.org. VIVO is distributed as source code, which you will use to build the application. This is because almost all site want to add their own customizations to VIVO.

These instructions will lead you through the process of building and installing VIVO.

Virtual appliance

VIVO is also available as a "virtual appliance", which you not need to build. We rely on the VIVO community to create new versions of the virtual appliance, so you may not find one that contains the latest release of VIVO. The latest virtual appliance can be found at the download page of VIVOweb.org.

VIVO and Vitro

VIVO is a research networking application that is built around a general-purpose RDF editor and browser named Vitro. VIVO packages Vitro with a display theme, an ontology, and many customizations. You will see references to Vitro occasionally in the installation instructions. For example, setting a property named vitro.home where you might expect to see vivo.home instead.

Remember that VIVO is a customization of Vitro.

Where will VIVO be on your computer?

Before beginning the installation, you should be aware of the four locations on your computer that will hold VIVO.

The VIVO distribution directory

This is created when you unpack the VIVO distribution file (see Download the VIVO source code, below). This is where you will create your build.properties file (see Specify build properties), and where you will make any modifications to the VIVO theme or code. You can create this wherever you choose.

VIVO inside Tomcat

When you run the build script to compile and deploy VIVO (see Compile and deploy), the files will be deployed to a directory inside Tomcat. This is the actual executing code for VIVO, but you won’t need to look at it or change it. If you need to change VIVO, make the changes in the distribution directory, and run the build script again. Tell the build script where to find Tomcat by setting tomcat.home in the build.properties file (see Specify build properties).

The VIVO home directory

This directory contains the runtime properties for VIVO. VIVO will also use this area to store some of its data. Uploaded image files are stored here, and the Solr search index is stored here also. This is also a place for the files of RDF data that will initialize the VIVO knowledge base. You can create this wherever you choose. Tell VIVO where to find the home directory by setting vitro.home in the build.properties file (see Specify build properties). You must create this directory before starting VIVO. You must create the runtime.properties file in this directory (see Specify runtime properties), and you must ensure that Tomcat has permission to read and write to this directory when it runs.

The VIVO knowledge base

Nearly all of the data that you enter into VIVO will be stored in a MySQL database. The actual location of this data depends on what system you have, and on how you install MySQL (see Install required software). You will access the data through VIVO, or occasionally through the MySQL client application.

After the installation, what next?

When you have VIVO up and running, please read the Site Administrator's Guide.

The first section describes a standard, simple installation for those who want to get VIVO up and running. The second section describes several installation options; some options are intended for a full-scale production installation of VIVO, and some are intended for a person who is developing VIVO on their own machine.

A simple installation

This section describes the process of getting VIVO up and running on your computer, for testing or experimentation, or just to gain familiarity with the process.

If you want to install VIVO on a production server, or if you want to develop VIVO code, you should also read the section on installation options.

Where is VIVO on your computer?

Preparing for VIVO

Install required software

Create an empty database

Building VIVO

Download the VIVO source code

Specify build properties

Compile and deploy

Running VIVO

Configure Tomcat

Specify runtime properties

Start Tomcat

Was the installation successful?

Using VIVO

Log in and add RDF data

Set the Contact Email Address

Review the VIVO terms of use

Installation options

Running VIVO behind an Apache server

Using an external authentication system

Developers' installation: obtaining VIVO source code from Git

Customizing VIVO with a "3-tier" build

Using a database other than MySQL

Using a servlet container other than Tomcat

Adding OpenSocial gadgets to VIVO

VIVO in a language other than English

Other installation options

...