Deprecated. This material represents early efforts and may be of interest to historians. It doe not describe current VIVO efforts.
Deprecated. This material represents early efforts and may be of interest to historians. It doe not describe current VIVO efforts.
This document is a summary of the VIVO installation process. 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.
These instructions assume that you are performing a clean install, including emptying an existing database, emptying the VIVO home directory, and removing a previous installation from the Tomcat webapps directory. VIVO may not work as expected if you install over an an earlier version. If you are upgrading an existing service, please consult the Upgrade Instructions for VIVO release 1.6.
The section entitled A simple installation describes a standard, simple installation for those who want to get VIVO up and running. The second called Installation options section describes several choices; some 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.
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.
Before beginning the installation, let's look at the four locations on your computer that will hold VIVO.
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, below), and where you will make any modifications to the VIVO theme or code. You can create this wherever you choose.
When you run the build script to compile and deploy VIVO (see Compile and deploy, below), 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, below).
This directory contains the runtime configuration 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 or 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, below). You must create this directory before starting VIVO. You must create the runtime.properties
file in this directory (see Specify runtime properties, below), and you must ensure that Tomcat has permission to read and write to this directory when it runs.
By default, nearly all of the data that you enter into VIVO will be stored in MySQL. The actual location of this data depends on what system you have, and on how you install MySQL (see Install required software, below). but you won’t need to know the location. You will access the data through VIVO, or occasionally through the MySQL client application.
Depending on your Installation options, these directories may have different locations, or may be specified in different ways. They may even exist on different computers. Regardless of the options, these four locations are important for any installation of VIVO.
Before installing VIVO, make sure that the following software is installed on the desired machine:
Be sure to set up the environment variables for JAVA_HOME
and ANT_HOME
and add the executables to your path, as required. This requirement depends on the operating system you are using. Consult the installation directions from the software support websites.
The following browsers are supported for this release
You can test the software installation by typing these commands:
java -version mysql --version ant -version
Each of these command should print a response that tells you what version is installed. If any of these commands prints an error message, or reports an unexpected version number, you should review your installation.
Decide on a database name, username, and password.You will need these values for this step, and again when you Specify runtime properties.
Log into your MySQL server and create a new database in MySQL that uses UTF-8
encoding
. At the MySQL command line you can create the database and user with these commands substituting your values for dbname
, username
, and password
. Most of the time, the hostname will be localhost
.
CREATE DATABASE dbname CHARACTER SET utf8; GRANT ALL ON dbname.* TO 'username'@'hostname' IDENTIFIED BY 'password';
Download the VIVO application source as either rel-1.6.zip
or rel-1.6.gz
file and unpack it on your web server:
http://vivoweb.org/download
At the top level of the VIVO distribution directory, copy the file example.build.properties
to a file named simply build.properties
. Edit the file to suit your installation, as described in the following table.
These properties are used in compiling VIVO and deploying it to Tomcat. They will be incorporated into VIVO when it is compiled. If you want to change these properties at a later date, you will need to stop Tomcat, repeat the Compile and deploy step, and restart Tomcat.
Windows: For those installing on a Windows operating system, include the windows drive, but use the forward slash "/" and not the back slash "\" in the directory locations, e.g. c:/tomcat
.
Property name |
|
---|---|
Description | The directory where Vitro code is located. In most deployments, this is set to ./vitro-core (It is not uncommon for this setting to point elsewhere in development environments). |
Default value | NONE |
Example value | ./vitro-core |
Property name |
|
---|---|
Description | The directory where tomcat is installed. |
Default value | NONE |
Example value | /usr/local/tomcat |
Property name |
|
---|---|
Description | The name of your VIVO application. This is not a name that will be displayed to the user. This name appears in the URL used to access VIVO, and in the path to the VIVO directory within Tomcat. |
Default value | NONE |
Example value | vivo |
Property name |
|
---|---|
Description | The directory where VIVO will store the data that it creates. This includes uploaded files (usually images) and the Solr search index. Be sure this directory exists and is writable by the Tomcat service. |
Default value | NONE |
Example value | /usr/local/vivo/home |
In the previous step, you defined the location of the VIVO home directory, by specifying vitro.home
in the build.properties
file. If that directory does not exist, create it now.
At the command line, from the top level of the VIVO distribution directory, type:
ant all
to build VIVO and deploy to Tomcat's webapps directory.
The build script may run for as much as five minutes, and creates more than 100 lines of output. The process comprises several steps:
The output of the build may include a variety of warning messages. The Java compiler may warn of code that is outdated. Unit tests may produce warning messages, and some tests may be ignored if they do not produce consistent results.
BUILD SUCCESSFUL Total time: 1 minute 49 seconds |
If the output ends with a success message, the build was successful. Proceed to the next step.
BUILD FAILED Total time: 35 seconds |
If the output ends with a failure message, the build has failed. Find the cause of the failure, fix the problem, and run the script again.
TBD
VIVO can configured to use a different triple store for the bulk of its semantic data, so long as this triple store supports Web-based use of the SPARQL language to query and modify its data. If you elect to use a separate triple store, note that VIVO's MySQL database is still required for basic configuration and user account data. In order to connect VIVO to an external triple store, you will need to know two URIs: the store's endpoint URI for issuing SPARQL queries that read data, and its URI for issuing SPARQL UPDATE commands. These URIs are typically kept separate in order to make it easier to secure the triple store against unauthorized edits. With Sesame, for example, the update URI is usually the query endpoint URI with "/statements" appended. You will need to know these two URIs later when you specify runtime properties.
These values are used when deploying VIVO as an OpenSocial container and integrating with OpenSocial gadgets (see Step 13, below). If you are creating a VIVO installation that does not use OpenSocial gadgets, these values are omitted. | |
OpenSocial.shindigURL OpenSocial.tokenService OpenSocial.tokenKeyFile OpenSocial.sandbox |
Languages (in addition to American English) that will be built into your VIVO site. The languages must be found in the languages directory of the VIVO distribution. See the VIVO Wiki for more information. | |
languages.addToBuild | es_MX |