2011-11-15 22:11:20 +00:00
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html lang="en">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
|
|
|
|
<meta charset="utf-8">
|
2011-11-16 17:34:17 +00:00
|
|
|
|
<title>Vitro Version 1.4 Installation Guide</title>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<link rel="stylesheet" href="./css/doc.css" media="screen">
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body>
|
|
|
|
|
|
<div id="branding" role="banner">
|
|
|
|
|
|
<h1 class="vitro-logo"><a href="/"><span class="displace">Vitro</span></a></h1>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<!-- Start of content -->
|
|
|
|
|
|
<div id="wrapper-content" role="main">
|
2011-11-16 17:34:17 +00:00
|
|
|
|
<h1>Vitro Version 1.4 Installation Guide</h1>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<small>
|
|
|
|
|
|
November 15, 2011
|
|
|
|
|
|
</small>
|
|
|
|
|
|
<toc>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#introduction">Introduction to the Vitro installation</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
2011-11-16 17:34:17 +00:00
|
|
|
|
<a href="#installation">Installation process for Version 1.4</a>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</toc>
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
This document is a summary of the Vitro installation process.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
These instructions assume that you are performing a clean install,
|
|
|
|
|
|
starting with an empty database, an empty Vitro home directory,
|
|
|
|
|
|
and a Tomcat installation with no Vitro webapp.
|
|
|
|
|
|
If you are upgrading a previous installation of Vitro,
|
|
|
|
|
|
you should consult the applicable “upgrade” file(s) in this directory.
|
|
|
|
|
|
</p>
|
2011-11-16 17:35:55 +00:00
|
|
|
|
<br>
|
|
|
|
|
|
<hr><!-- Page break --><!-- Introduction to the Vitro installation --><h2 id="introduction">Introduction to the Vitro installation</h2>
|
|
|
|
|
|
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
|
|
|
|
|
Before beginning the installation,
|
|
|
|
|
|
let’s discuss some of the major concepts relating to the Vitro installation.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Where does Vitro live on your computer?</h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Vitro exists in four locations on your computer, from the distribution to the runtime to the data storage.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h4>The Vitro distribution directory</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
This is created when you checkout the Vitro source code
|
|
|
|
|
|
(see <a href="#checkout_code">installation step III</a>, below).
|
|
|
|
|
|
This is where you will create your deploy.properties file
|
|
|
|
|
|
(see <a href="#deploy_properties">installation step V</a>, below),
|
|
|
|
|
|
and where you will make any modifications to the Vitro
|
|
|
|
|
|
theme or code. You can create this wherever you choose.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h4>Vitro inside Tomcat</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
When you run the build script to compile and deploy Vitro
|
|
|
|
|
|
(see <a href="#deploy">installation step VI</a>, below),
|
|
|
|
|
|
the files will be deployed to a
|
|
|
|
|
|
directory inside Tomcat. This is the actual executing code for Vitro,
|
|
|
|
|
|
but you won’t need to look at it or change it. If you need to change
|
|
|
|
|
|
Vitro, make the changes in the distribution directory, and run the build
|
|
|
|
|
|
script again. Tell the build script where to find Tomcat by setting <code>tomcat.home</code>
|
|
|
|
|
|
in the deploy.properties file (see <a href="#deploy_properties">installation step V</a>,
|
|
|
|
|
|
below).
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h4>The Vitro home directory</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Vitro will use this area to store some of the data it uses. Uploaded
|
|
|
|
|
|
image files are stored here, and the search index is stored here also.
|
|
|
|
|
|
You can create this wherever you choose. Tell Vitro where to find the
|
|
|
|
|
|
home directory by setting <code>vitro.home.directory</code>
|
|
|
|
|
|
in the
|
|
|
|
|
|
deploy.properties file (see <a href="#deploy_properties">installation step V</a>,
|
|
|
|
|
|
below). You must create this directory before starting Vitro, and you
|
|
|
|
|
|
must ensure that Tomcat has permission to read and write to this
|
|
|
|
|
|
directory when it runs.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h4>The MySQL database</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Essentially all of the data that you store in Vitro will be given to
|
|
|
|
|
|
MySQL for storage. The actual location of this data depends on what
|
|
|
|
|
|
system you have, and on how you install MySQL
|
|
|
|
|
|
(see <a href="#required_software">installation step I</a>, below).
|
|
|
|
|
|
but you won’t need to
|
|
|
|
|
|
know the location. You will access the data through Vitro, or
|
|
|
|
|
|
occasionally through the MySQL client application.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>The relationship between Vitro and VIVO</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<h4>“Vitro Inside”</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Vitro was developed as a
|
|
|
|
|
|
“general-purpose web-based ontology and instance editor with customizable public browsing.”
|
|
|
|
|
|
It is useful on its own, but also serves as the basis for several products,
|
|
|
|
|
|
including VIVO. [http://sourceforge.net/projects/vivo/]
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
In 2009, the National Institutes of Health (NIH) awarded a major grant to advance the development of VIVO.
|
|
|
|
|
|
Much of the recent development on Vitro has been in support of that grant.
|
|
|
|
|
|
However, Vitro retains its own identity,
|
|
|
|
|
|
and still serves as the core of many projects and products.
|
|
|
|
|
|
Some of these are currently in use, and some are still in the planning stages.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Because VIVO was so well funded, and because it is widely used,
|
|
|
|
|
|
someone seeking help with Vitro might find information that applies to VIVO instead.
|
|
|
|
|
|
In many cases, that information will apply to Vitro as well.
|
|
|
|
|
|
However, there are some notable exceptions:
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>Ontology</h5>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Vitro is essentially a blank slate, and is suitable for use with almost any ontology.
|
|
|
|
|
|
It is packaged with a minimal ontology, sufficient to run the application itself.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
VIVO is packaged with a rich ontology, tailored to scientists and educators.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>Theme</h5>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Vitro and VIVO are each packaged with their own default theme.
|
|
|
|
|
|
The VIVO theme is more extensive,
|
|
|
|
|
|
since it includes custom pages and custom list views that apply to the VIVO ontology.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>Visualizations</h5>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
VIVO includes some rich visualization tools that are specific to the VIVO ontology.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>Harvester</h5>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
VIVO includes an RDF Harvester tool for importing data from sources of record.
|
|
|
|
|
|
The Harvester may be useful for Vitro as well, but it was developed for VIVO,
|
|
|
|
|
|
and may have some dependencies on VIVO.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Release schedule and names</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Currently, the Vitro release schedule is coordinated with the VIVO releases,
|
2011-11-16 17:34:17 +00:00
|
|
|
|
so version 1.4 of Vitro forms the basis of version 1.4 of VIVO.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
In the Vitro code repository, the release tags illustrate this relationship.
|
2011-11-16 17:34:17 +00:00
|
|
|
|
For example, the Vitro revision that was tagged for version 1.4 of VIVO is named “rel-vivo-1.4”
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
As the project progresses,
|
|
|
|
|
|
we will also see Vitro releases named for versions of Datastar and other Vitro-based products.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
2011-11-16 17:34:17 +00:00
|
|
|
|
<hr><!-- Page break --><!-- Installation process for Version 1.4 --><h2 id="installation">Installation process for Version 1.4</h2>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
This document is a summary of the Vitro installation process.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<toc>
|
|
|
|
|
|
<h3>Steps to Installation</h3>
|
|
|
|
|
|
<ol class="roman1">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#required_software">Install required software</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#create_database">Create an empty MySQL database</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#checkout_code">Check out the Vitro Source Code</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#deploy_properties">Specify deployment properties</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#deploy">Compile and deploy</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
2011-11-23 16:04:51 +00:00
|
|
|
|
<a href="#tomcat_settings">Configure Tomcat</a>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#start_tomcat">Start Tomcat</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#add_rdf">Log in and add RDF data</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#contact_email">Set the Contact Email Address (if
|
|
|
|
|
|
using "Contact Us" form)</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#tomcat_connector">Setup Apache Tomcat Connector</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#external_auth">Using an External Authentication
|
2011-11-16 17:30:30 +00:00
|
|
|
|
System with Vitro</a>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="#installation_check">Was the installation successful?</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
<a href="#termsofuse">Review the Vitro Terms of Use</a>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
</toc>
|
|
|
|
|
|
<h3 id="required_software">I. Install required software </h3>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Before installing Vitro, make sure that the following software is
|
2011-11-15 22:11:20 +00:00
|
|
|
|
installed on the desired machine:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Java (SE) 1.6 or higher, <a href="http://java.sun.com">http://java.sun.com</a>
|
|
|
|
|
|
(Not OpenJDK)
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Apache Tomcat 6.x or higher, <a href="http://tomcat.apache.org">http://tomcat.apache.org</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Apache Ant 1.7 or higher, <a href="http://ant.apache.org">http://ant.apache.org</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
MySQL 5.1 or higher*, <a href="http://www.mysql.com">http://www.mysql.com</a>
|
|
|
|
|
|
</li>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
<li>
|
|
|
|
|
|
Apache Subversion 1.6.x or higher*, <a href="http://subversion.apache.org/">http://subversion.apache.org/</a>
|
|
|
|
|
|
</li>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Be sure to set up the environment variables for <code java_home="">JAVA_HOME</code>
|
|
|
|
|
|
and <code>ANT_HOME</code>
|
|
|
|
|
|
and add the executables to your path per
|
|
|
|
|
|
your operating system and installation directions from the software
|
|
|
|
|
|
support websites.
|
|
|
|
|
|
</p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<h3 id="create_database">II. Create an empty MySQL database </h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Decide on a database name, username, and password. Log into your
|
|
|
|
|
|
MySQL server and create a new database in MySQL that uses <code>UTF-8
|
|
|
|
|
|
encoding</code>. You will need these values for Step IV when you
|
|
|
|
|
|
configure the deployment properties. At the MySQL command line you can
|
|
|
|
|
|
create the database and user with these commands substituting your
|
|
|
|
|
|
values for <code>dbname</code>, <code>username</code>, and <code>password</code>.
|
|
|
|
|
|
Most
|
|
|
|
|
|
of
|
|
|
|
|
|
the
|
|
|
|
|
|
time, the hostname will equal <code>localhost</code>.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre> CREATE DATABASE dbname CHARACTER SET utf8;<br></pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Grant access to a database user. For example:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre> GRANT ALL ON dbname.* TO 'username'@'hostname' IDENTIFIED BY 'password';<br></pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Keep track of the database name, username, and password for Step
|
|
|
|
|
|
IV.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h3 id="checkout_code">III. Check out the Vitro Source Code
|
|
|
|
|
|
<br>
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Use subversion to check out the Vitro source code from SourceForge:
|
|
|
|
|
|
<pre> svn checkout svn://svn.code.sf.net/p/vivo/vitro/code/trunk</code> <em>[Vitro_distribution_dir]</em></pre>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h3 id="deploy_properties">IV. Specify deployment properties </h3>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
In the <code>webapp</code> directory of the Vitro distribution, copy the file <code>example.deploy.properties</code>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
to a file named simply <code>deploy.properties</code>. This file sets
|
|
|
|
|
|
several properties used in compilation and deployment.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<em>Windows:</em>
|
|
|
|
|
|
For those installing on Windows operating
|
|
|
|
|
|
system, include the windows drive and use the forward slash "/" and not
|
|
|
|
|
|
the back slash "\" in the directory locations, e.g. <code>c:/tomcat</code>.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<em>External authentication:</em>
|
|
|
|
|
|
If you want to use an external
|
|
|
|
|
|
authentication system like Shibboleth or CUWebAuth, you will need to
|
|
|
|
|
|
set two additional properties in this file. See the section below
|
2011-11-16 17:30:30 +00:00
|
|
|
|
entitled <a href="#external_auth">Using an External Authentication System with Vitro</a>.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<table border='1' bordercolor="#CCCCCC" cellspacing="5">
|
|
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
Property Name
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
Example Value
|
|
|
|
|
|
</th>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Default namespace: Vitro installations make their
|
2011-11-15 22:11:20 +00:00
|
|
|
|
RDF resources available for harvest using linked data. Requests for RDF
|
|
|
|
|
|
resource URIs redirect to HTML or RDF representations as specified by
|
2011-11-16 17:30:30 +00:00
|
|
|
|
the client. To make this possible, Vitro's default namespace must have a
|
|
|
|
|
|
certain structure and begin with the public web address of the Vitro
|
|
|
|
|
|
installation. For example, if the web address of a Vitro installation is
|
|
|
|
|
|
"http://vitro.example.edu/" the default namespace must be set to
|
|
|
|
|
|
"http://vitro.example.edu/individual/" in order to support linked data.
|
|
|
|
|
|
Similarly, if Vitro is installed at "http://www.example.edu/vitro" the
|
2011-11-15 22:11:20 +00:00
|
|
|
|
default namespace must be set to
|
2011-11-16 17:30:30 +00:00
|
|
|
|
"http://www.example.edu/vitro/individual/"
|
|
|
|
|
|
<h5>* The namespace must end with "individual/" (including the trailing slash).</h5>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
Vitro.defaultNamespace
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
http://vitro.mydomain.edu/individual/
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Directory where tomcat is installed.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
tomcat.home
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
/usr/local/tomcat
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Name of your Vitro application.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
webapp.name
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
vitro
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
2011-11-16 17:30:30 +00:00
|
|
|
|
URL of Solr context used in local Vitro search.
|
|
|
|
|
|
Should consist of:<pre> scheme + servername + port + vitro_webapp_name + "solr"</pre>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
In the standard installation, the Solr context will be on the same
|
2011-11-16 17:30:30 +00:00
|
|
|
|
server as Vitro, and in the same Tomcat instance. The path will be the
|
|
|
|
|
|
Vitro webapp.name (specified above) + "solr"
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
vitro.local.solr.url
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
http://localhost:8080/vitrosolr
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Restricts access to the Solr search platform.
|
|
|
|
|
|
One or more regular expressions, separated by commas. When a request is
|
|
|
|
|
|
made to Solr, the IP address of the requestor must match one of the
|
|
|
|
|
|
patterns, or the request will be rejected.
|
|
|
|
|
|
<br>
|
|
|
|
|
|
Examples:<code>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
vitro.local.solr.ipaddress.mask = 127\.0\.0\.1
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
vitro.local.solr.ipaddress.mask =
|
|
|
|
|
|
127\.0\.0\.1,0:0:0:0:0:0:0:1
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
vitro.local.solr.ipaddress.mask = 169.254.*
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</code>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
vitro.local.solr.ipaddress.mask
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
127\.0\.0\.1,0:0:0:0:0:0:0:1
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Directory where the Vitro application will store
|
2011-11-15 22:11:20 +00:00
|
|
|
|
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 user who the Tomcat service is running as.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
vitro.home.directory
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
/usr/local/vitro/data
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify an SMTP host that the application will
|
|
|
|
|
|
use for sending e-mail (Optional). If this is left blank, the contact
|
|
|
|
|
|
form will be hidden and disabled, and users will not be notified of
|
|
|
|
|
|
changes to their accounts.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
email.smtpHost
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
smtp.servername.edu
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify an email address which will appear as
|
|
|
|
|
|
the sender in e-mail notifications to users (Optional). If a user
|
|
|
|
|
|
replies to the notification, this address will receive the reply. If a
|
|
|
|
|
|
user's e-mail address is invalid, this address will receive the error
|
|
|
|
|
|
notice. If this is left blank, users will not be notified of changes to
|
|
|
|
|
|
their accounts.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
email.replyTo
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
vitroAdmin@my.domain.edu
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify the JDBC URL of your database. Change
|
2011-11-16 17:30:30 +00:00
|
|
|
|
the end of the URL to reflect your database name (if it is not "vitro").
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.url
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
jdbc:mysql://localhost/vitro
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Change the username to match the authorized user
|
|
|
|
|
|
you created in MySQL.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.username
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
username
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Change the password to match the password you
|
|
|
|
|
|
created in MySQL.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.password
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
password
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify the maximum number of active connections
|
|
|
|
|
|
in the database connection pool to support the anticipated number of
|
|
|
|
|
|
concurrent page requests. It is not necessary to adjust this value when
|
|
|
|
|
|
using the RDB configuration.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.pool.maxActive
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
40
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify the maximum number of database
|
|
|
|
|
|
connections that will be allowed to remain idle in the connection pool.
|
|
|
|
|
|
Default is 25% of the maximum number of active connections.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.pool.maxIdle
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
10
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Change the dbtype setting to use a database
|
|
|
|
|
|
other than MySQL. Otherwise, leave this value unchanged. Possible
|
|
|
|
|
|
values are DB2, derby, HSQLDB, H2, MySQL, Oracle, PostgreSQL, and
|
|
|
|
|
|
SQLServer. Refer to http://openjena.org/wiki/SDB/Databases_Supported
|
|
|
|
|
|
for additional information.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.dbtype
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
MySQL
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify a driver class name to use a database
|
|
|
|
|
|
other than MySQL. Otherwise, leave this value unchanged. This JAR file
|
|
|
|
|
|
for this driver must be added to the the webapp/lib directory within
|
|
|
|
|
|
the vitro.core.dir specified above.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.driver
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
com.mysql.jdbc.Driver
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Change the validation query used to test
|
|
|
|
|
|
database connections only if necessary to use a database other than
|
|
|
|
|
|
MySQL. Otherwise, leave this value unchanged.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
VitroConnection.DataSource.validationQuery
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
SELECT 1
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
Specify the email address of the root user
|
2011-11-16 17:30:30 +00:00
|
|
|
|
account for the Vitro application. This user will have an initial
|
2011-11-15 22:11:20 +00:00
|
|
|
|
temporary password of 'rootPassword'. You will be prompted to create a
|
|
|
|
|
|
new password on first login.
|
|
|
|
|
|
<p>
|
|
|
|
|
|
NOTE: The root user account has access to all data and all
|
2011-11-16 17:30:30 +00:00
|
|
|
|
operations in Vitro. Data views may be surprising when logged in as the
|
2011-11-15 22:11:20 +00:00
|
|
|
|
root user. It is best to create a Site Admin account to use for every
|
|
|
|
|
|
day administrative tasks.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
rootUser.emailAddress
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
vitroAdmin@my.domain.edu
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
The URI of a property that can be used to
|
|
|
|
|
|
associate an Individual with a user account. When a user logs in with a
|
|
|
|
|
|
name that matches the value of this property, the user will be
|
|
|
|
|
|
authorized to edit that Individual
|
|
|
|
|
|
(the value of the property must be either a String literal or an untyped literal).
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
selfEditing.idMatchingProperty
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
http://vitro.mydomain.edu/ns#networkId
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
If an external authentication system like Shibboleth or CUWebAuth is to be
|
|
|
|
|
|
used, these properties say how the login button should be labeled, and which
|
|
|
|
|
|
HTTP header will contain the user ID from the authentication system. If such
|
|
|
|
|
|
a system is not to be used, leave these commented out. Consult the installation
|
|
|
|
|
|
instructions for more details.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="odd_row">
|
|
|
|
|
|
<td>
|
|
|
|
|
|
externalAuth.buttonText
|
|
|
|
|
|
<br/>
|
|
|
|
|
|
externalAuth.netIdHeaderName
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
Log in using BearCat Shibboleth
|
|
|
|
|
|
<br/>
|
|
|
|
|
|
remote_userID
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td colspan="2">
|
|
|
|
|
|
An absolute file path, pointing to the root directory of the Harvester utility.
|
|
|
|
|
|
You must include the final slash.
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
<h3 id="deploy">V. Compile and deploy</h3>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
At the command line, from the top level of the Vitro distribution
|
2011-11-15 22:11:20 +00:00
|
|
|
|
directory, type:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre> ant all<br> </pre>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
to build Vitro and deploy to Tomcat's webapps directory.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
2011-11-23 16:04:51 +00:00
|
|
|
|
<h3 id="tomcat_settings">VI. Configure Tomcat</h3>
|
|
|
|
|
|
<h4>Set JVM parameters</h4>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro copies small sections of your RDF database into
|
2011-11-15 22:11:20 +00:00
|
|
|
|
memory in order to serve Web requests quickly (the in-memory copy and
|
|
|
|
|
|
the underlying database are kept in synch as edits are performed).
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro may require more memory than that allocated to Tomcat by
|
2011-11-15 22:11:20 +00:00
|
|
|
|
default. With most installations of Tomcat, the "setenv.sh" or
|
|
|
|
|
|
"setenv.bat" file in Tomcat's bin directory is a convenient place to
|
|
|
|
|
|
set the memory parameters. <em>If this file does not exist in Tomcat's
|
|
|
|
|
|
bin directory, you can create it.</em>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
For example:
|
|
|
|
|
|
</p>
|
2011-11-16 16:55:34 +00:00
|
|
|
|
<pre> export CATALINA_OPTS="-Xms512m -Xmx512m -XX:MaxPermSize=128m"<br> </pre>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-16 16:55:34 +00:00
|
|
|
|
This sets Tomcat to allocate an initial heap of 512 megabytes, a
|
|
|
|
|
|
maximum heap of 512 megabytes, and a PermGen space of 128 megs. Lower
|
|
|
|
|
|
values may suffice, especially for small test installations.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
If an OutOfMemoryError is encountered during Vitro execution, it can
|
2011-11-15 22:11:20 +00:00
|
|
|
|
be remedied by increasing the heap parameters and restarting Tomcat.
|
|
|
|
|
|
</p>
|
2011-11-23 16:04:51 +00:00
|
|
|
|
<h4>Set security limits</h4>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-23 16:04:51 +00:00
|
|
|
|
Vitro is a multithreaded web application that may
|
2011-11-15 22:11:20 +00:00
|
|
|
|
require more threads than are permitted under your Linux installation's
|
|
|
|
|
|
default configuration. Ensure that your installation can support the
|
|
|
|
|
|
required number of threads by making the following edits to <code>/etc/security/limits.conf</code>:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre> apache hard nproc 400<br> tomcat6 hard nproc 1500 <br> </pre>
|
2011-11-23 16:04:51 +00:00
|
|
|
|
<h4>Set URI encoding</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
In order for Solr to correctly search for international characters (>127),
|
|
|
|
|
|
you must configure Tomcat to conform to the URI standard by
|
|
|
|
|
|
accepting percent-encoded UTF-8.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Edit Tomcat's conf/server.xml and add the following attribute to each of the
|
|
|
|
|
|
Connector elements: URIEncoding="UTF-8".
|
|
|
|
|
|
<pre>
|
|
|
|
|
|
<Server ...>
|
|
|
|
|
|
<Service ...>
|
|
|
|
|
|
<Connector ... URIEncoding="UTF-8"/>
|
|
|
|
|
|
...
|
|
|
|
|
|
</Connector>
|
|
|
|
|
|
</Service>
|
|
|
|
|
|
</Server>
|
|
|
|
|
|
</pre>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<h3 id="start_tomcat">VII. Start Tomcat </h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Most Tomcat installations can be started by running <code>startup.sh</code>
|
|
|
|
|
|
or <code>startup.bat</code>
|
|
|
|
|
|
in Tomcat's bin directory. Point your
|
2011-11-16 17:30:30 +00:00
|
|
|
|
browser to "http://localhost:8080/vitro/" to test the application. If
|
|
|
|
|
|
Tomcat does not start up, or the Vitro application is not visible, check
|
2011-11-15 22:11:20 +00:00
|
|
|
|
the files in Tomcat's logs directory. Error messages are commonly found
|
|
|
|
|
|
in <code>catalina.out</code>
|
|
|
|
|
|
or <code>localhost.log</code>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h3 id="add_rdf">VIII. Log in and add RDF data </h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
If the startup was successful, you will see a welcome message
|
2011-11-16 17:30:30 +00:00
|
|
|
|
informing you that you have successfully installed Vitro. Click the "Log
|
2011-11-15 22:11:20 +00:00
|
|
|
|
in" link near the upper right corner. Log in with the <code>rootUser.emailAddress</code>
|
|
|
|
|
|
you set up in Step IV. The initial password for the root account is
|
|
|
|
|
|
"rootPassword" (without the quotes). On first login, you will be
|
|
|
|
|
|
prompted to select a new password and verify it a second time. When login is
|
|
|
|
|
|
complete, the search index is checked and, if it is empty,
|
|
|
|
|
|
a full index build will be triggered in the background, in order to ensure
|
|
|
|
|
|
complete functionality throughout the site.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
After logging in, you will be presented with a
|
|
|
|
|
|
menu of editing options. Here you can create OWL classes, object
|
|
|
|
|
|
properties, data properties, and configure the display of data.
|
|
|
|
|
|
Currently, any classes you wish to make visible on your website must be
|
|
|
|
|
|
part of a class group, and there are a number of visibility and display
|
2011-11-16 16:55:34 +00:00
|
|
|
|
options available for each ontology entity. Vitro comes with a minimal
|
|
|
|
|
|
ontology. You will likely want to upload additional ontologies from an RDF file.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Under the "Advanced Data Tools" click "Add/Remove RDF Data." Note
|
|
|
|
|
|
that Vitro currently works best with OWL-DL ontologies and has only
|
|
|
|
|
|
limited support for pure RDF data. You can enter a URL pointing to the
|
|
|
|
|
|
RDF data you wish to load or upload from a file on your local machine.
|
|
|
|
|
|
Ensure that the "add RDF" radio button is selected. You will also
|
|
|
|
|
|
likely want to check "create classgroups automatically."
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Clicking the "Index" tab in the navigation bar at the top right of
|
|
|
|
|
|
the page will show a simple index of the knowledge base.
|
|
|
|
|
|
</p>
|
2011-11-16 16:55:34 +00:00
|
|
|
|
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<h3 id="contact_email">IX. Set the Contact Email Address (if using
|
|
|
|
|
|
"Contact Us" form)</h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
If you have configured your application to use the "Contact Us"
|
|
|
|
|
|
feature in Step IV (<code>email.smtpHost</code>), you will also need to
|
2011-11-16 17:30:30 +00:00
|
|
|
|
add an email address to the Vitro application. This is the email
|
2011-11-15 22:11:20 +00:00
|
|
|
|
to which the contact form will submit. It can be a list server or an
|
|
|
|
|
|
individual's email address.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Log in as a system administrator. Navigate to the "Site Admin"
|
|
|
|
|
|
table of contents (link in the right side of the header). Go to "Site
|
|
|
|
|
|
Information" (under "Site Configuration"). In the "Site Information
|
|
|
|
|
|
Editing Form," enter a functional email address in the field "Contact
|
|
|
|
|
|
Email Address" and submit the change.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
If you set the <code>email.smtpHost</code>
|
|
|
|
|
|
in Step IV and do NOT
|
|
|
|
|
|
provide an email address in this step, your users will receive a java
|
|
|
|
|
|
error in the interface.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h3 id="tomcat_connector">X. Set up Apache Tomcat Connector </h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
It is recommended that a Tomcat Connector such as mod_jk be used to
|
|
|
|
|
|
ensure that the site address does not include the port number (e.g.
|
|
|
|
|
|
8080) and an additional reference to the Tomcat context name (e.g.
|
2011-11-16 17:30:30 +00:00
|
|
|
|
/vitro).
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
This will make Vitro available at "http://example.com" instead of
|
|
|
|
|
|
"http://example.com:8080/vitro"
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Using the mod_jk connector allows for communication between Tomcat
|
|
|
|
|
|
and the primary web server. The <a href="http://tomcat.apache.org/connectors-doc/generic_howto/quick.html">Quick
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Start HowTo</a>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
on the Apache site describes the minimum server
|
|
|
|
|
|
configurations for several popular web servers.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
After setting up the mod_jk connector above, you will need to
|
|
|
|
|
|
modify the Tomcat's server.xml (located in <code>[tomcat root]/conf/</code>)
|
|
|
|
|
|
to
|
|
|
|
|
|
respond
|
|
|
|
|
|
to
|
|
|
|
|
|
requests from Apache via the connector. Look for the
|
|
|
|
|
|
<connector> directive and add the following properties:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre> connectionTimeout="20000" maxThreads="320" keepAliveTimeout="20000" <br> </pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Note: the value for maxThreads (320) is equal to the value for
|
|
|
|
|
|
MaxClients in the apache's <code>httpd.conf</code>
|
|
|
|
|
|
file.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Locate the <code><Host name="localhost"...></code>
|
|
|
|
|
|
directive
|
|
|
|
|
|
and update as follows:
|
|
|
|
|
|
</p>
|
2011-11-16 16:55:34 +00:00
|
|
|
|
<pre> <Host name="localhost" appBase="webapps"
|
|
|
|
|
|
DeployOnStartup="false"
|
|
|
|
|
|
unpackWARs="true" autoDeploy="false"
|
|
|
|
|
|
xmlValidation="false" xmlNamespaceAware="false">
|
|
|
|
|
|
|
|
|
|
|
|
<Alias>example.com</Alias>
|
|
|
|
|
|
|
|
|
|
|
|
<Context path=""
|
2011-11-16 17:30:30 +00:00
|
|
|
|
docBase="/usr/local/tomcat/webapps/vitro"
|
2011-11-16 16:55:34 +00:00
|
|
|
|
reloadable="true"
|
|
|
|
|
|
cookies="true" >
|
|
|
|
|
|
|
|
|
|
|
|
<Manager pathname="" />
|
|
|
|
|
|
|
|
|
|
|
|
<Environment type="java.lang.String" override="false"
|
|
|
|
|
|
name="path.configuration"
|
|
|
|
|
|
value="deploy.properties"
|
|
|
|
|
|
/>
|
|
|
|
|
|
</Context>
|
|
|
|
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
</pre>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<h3 id="external_auth">XI. Using an External Authentication System
|
2011-11-16 17:30:30 +00:00
|
|
|
|
with Vitro </h3>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro can be configured to work with an external authentication
|
2011-11-15 22:11:20 +00:00
|
|
|
|
system like Shibboleth or CUWebAuth.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro must be accessible only through an Apache HTTP server. The
|
2011-11-15 22:11:20 +00:00
|
|
|
|
Apache server will be configured to invoke the external authentication
|
|
|
|
|
|
system. When the user completes the authentication, the Apache server
|
2011-11-16 17:30:30 +00:00
|
|
|
|
will pass a network ID to Vitro, to identify the user.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
If Vitro has an account for that user, the user will be logged in
|
|
|
|
|
|
with the privileges of that account. In the absence of an account, Vitro
|
2011-11-15 22:11:20 +00:00
|
|
|
|
will try to find a page associated with the user. If such a page is
|
|
|
|
|
|
found, the user can log in to edit his own profile information.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h4>Configuring the Apache server</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Your institution will provide you with instructions for setting up
|
|
|
|
|
|
the external authentication system. The Apache server must be
|
2011-11-16 17:30:30 +00:00
|
|
|
|
configured to secure a page in Vitro. When a user reaches this secured
|
2011-11-15 22:11:20 +00:00
|
|
|
|
page, the Apache server will invoke the external authentication system.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
For Vitro, this secured page is named: <code>/loginExternalAuthReturn</code>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
When your instructions call for the location of the secured page,
|
|
|
|
|
|
this is the value you should use.
|
|
|
|
|
|
</p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
<h4>Configuring Vitro</h4>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
To enable external authentication, Vitro requires three values in
|
2011-11-15 22:11:20 +00:00
|
|
|
|
the <code>deploy.properties</code>
|
|
|
|
|
|
file.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>The name of the HTTP header that will hold the external user's
|
|
|
|
|
|
network ID.</h5>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
When a user completes the authentication process, the Apache
|
|
|
|
|
|
server will put the user's network ID into one of the headers of the
|
|
|
|
|
|
HTTP request. The instructions from your institution should tell you
|
|
|
|
|
|
which header is used for this purpose.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
You need to tell Vitro the name of that HTTP header. Insert a
|
2011-11-15 22:11:20 +00:00
|
|
|
|
line like this in the deploy.properties file:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre>externalAuth.netIdHeaderName = [the header name]</pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
For example:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre>externalAuth.netIdHeaderName = remote_userID</pre>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>The text for the Login button.</h5>
|
|
|
|
|
|
To start the authentication process, the user will click on a button in
|
2011-11-16 17:30:30 +00:00
|
|
|
|
the Vitro login form. You need to tell Vitro what text should appear in
|
2011-11-15 22:11:20 +00:00
|
|
|
|
that button.
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Put a line like this in the deploy.properties file:
|
|
|
|
|
|
externalAuth.buttonText = [the text for your login button] For example:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre>externalAuth.buttonText = Log in using BearCat Shibboleth</pre>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
The Vitro login form will display a button labelled "Log in
|
2011-11-15 22:11:20 +00:00
|
|
|
|
using BearCat Shibboleth".
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>Associating a User with a profile page.</h5>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro will try to associate the user with a profile
|
|
|
|
|
|
page, so the user may edit his own profile data. Vitro will search the
|
2011-11-15 22:11:20 +00:00
|
|
|
|
data model for a person with a property that matches the User’s network
|
|
|
|
|
|
ID (the value of the property must be either a String literal or an
|
2011-11-16 17:30:30 +00:00
|
|
|
|
untyped literal). You need to tell Vitro what property should be used
|
2011-11-15 22:11:20 +00:00
|
|
|
|
for matching. Insert a line like this in the deploy.properties file:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<pre>selfEditing.idMatchingProperty = [the URI of the property]</pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
For example:
|
|
|
|
|
|
</p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
<pre>selfEditing.idMatchingProperty = http://vitro.mydomain.edu/ns#networkId</pre>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h3 id="installation_check">XII. Was the installation successful? </h3>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
If you have completed the previous steps, you have good indications
|
|
|
|
|
|
that the installation was successful.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Step VII showed that Tomcat recognized the webapp, and that the
|
|
|
|
|
|
webapp was able to present the initial page.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Step VIII verified that you can log in to the administrator
|
|
|
|
|
|
account.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Here is a simple test to see whether the ontology files were
|
|
|
|
|
|
loaded:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Click on the "Index" link on the upper right, below the logo.
|
|
|
|
|
|
You should see a "locations" section, with links for "Country" and
|
|
|
|
|
|
"Geographic Location." The index is built in a background thread, so on
|
|
|
|
|
|
your first login, you may see an empty index instead. Refresh the page
|
|
|
|
|
|
periodically to see whether the index will be populated. This may take
|
2011-11-16 17:30:30 +00:00
|
|
|
|
some time: with Vitro installed on a modest laptop computer, loading the
|
2011-11-15 22:11:20 +00:00
|
|
|
|
ontology files and building the index took more than 5 minutes from the
|
|
|
|
|
|
time that Tomcat was started.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Click on the "Country" link. You should see an alphabetical list
|
|
|
|
|
|
of the countries of the world.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Here is a test to see whether your system is configured to serve
|
|
|
|
|
|
linked data:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Point your browser to the home page of your website, and click
|
|
|
|
|
|
the "Log in" link near the upper right corner. Log in with the <code>rootUser.emailAddress</code>
|
|
|
|
|
|
you set up in Step IV. If this is your first time logging in, you will
|
|
|
|
|
|
be prompted to change the password.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
After you have successfully logged in, click "site admin" in the
|
|
|
|
|
|
upper right corner. In the drop down under "Data Input" select "Faculty
|
|
|
|
|
|
Member(core)" and click the "Add individual of this class" button.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Enter the name "test individual" under the field "Individual
|
|
|
|
|
|
Name," scroll to the bottom, and click "Create New Record." You will be
|
|
|
|
|
|
taken to the "Individual Control Panel." Make note of the value of the
|
|
|
|
|
|
field "URI" - it will be used in the next step.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Open a new web browser or browser tab to the page <a href="http://marbles.sourceforge.net/">http://marbles.sourceforge.net/</a>.
|
|
|
|
|
|
In
|
|
|
|
|
|
the
|
|
|
|
|
|
pink
|
|
|
|
|
|
box on that page enter the URI of the individual you
|
|
|
|
|
|
created in the previous step and click "open."
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
In the resulting page search for the URI of the "test
|
|
|
|
|
|
individual." You should find it towards the bottom of the page next to
|
|
|
|
|
|
a red dot followed by "redirect (303)." This indicates that you are
|
|
|
|
|
|
successfully serving linked RDF data. If the URI of the "test
|
|
|
|
|
|
individual" is followed by "failed (400)" you are not successfully
|
|
|
|
|
|
serving linked data.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
Finally, test the search index.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
Type the word "Australia" into the search box, and click on the
|
|
|
|
|
|
Search button.You should see a page of results, with links to countries
|
|
|
|
|
|
that border Australia, individuals that include Australia, and to
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Australia itself. If the search is not successful, try rebuilding the search index:
|
|
|
|
|
|
log in as a site
|
|
|
|
|
|
administrator and go to "http://your-vitro-url/SearchIndex".
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
<h3 id="termsofuse">XIII. Review the Vitro Terms of Use</h3>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
Vitro comes with a "Terms of Use" statement linked from the footer.
|
2011-11-15 22:11:20 +00:00
|
|
|
|
The "Site Name" you assign in the "Site Information" form under the <strong>Site Admin</strong>
|
|
|
|
|
|
area will be inserted into the "Terms of Use"
|
|
|
|
|
|
statement. If you want to edit the text content more than just the
|
2011-11-16 17:30:30 +00:00
|
|
|
|
"Site Name", the file can be found here:<pre>[vitro_source_dir]/webapp/web/templates/freemarker/body/termsOfUse.ftl</pre>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
Be sure to make the changes in your source files and deploy them to your
|
|
|
|
|
|
tomcat so you don't lose your changes next time you deploy for another reason.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h3>Next Step ...</h3>
|
|
|
|
|
|
<p>
|
2011-11-16 17:30:30 +00:00
|
|
|
|
There is no further documentation specifically for Vitro.
|
|
|
|
|
|
However, you may find helpful information in the
|
|
|
|
|
|
<a href="http://sourceforge.net/apps/mediawiki/vivo/index.php?title=Site_Administrator_Guide">
|
|
|
|
|
|
VIVO Site Administrator's Guide</a>.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
For instant access to Vitro developers visit the VIVO IRC Channel:
|
|
|
|
|
|
<pre> Network: irc.freenode.net
|
|
|
|
|
|
Channel: #VIVO
|
|
|
|
|
|
WebInterface: http://webchat.freenode.net/</pre>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
2011-11-15 22:11:20 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<!-- #wrapper-content -->
|
|
|
|
|
|
<div id="footer" role="contentinfo">
|
|
|
|
|
|
<p class="copyright">
|
|
|
|
|
|
<small>
|
|
|
|
|
|
©2011 All Rights Reserved
|
|
|
|
|
|
</small>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
