Merging from maint 1.3 (3420) for upgrade (3409) and install (3361).
This commit is contained in:
ejc12
parent
89db251ea4
commit
e73af0d9a4
2 changed files with 397 additions and 365 deletions
151
doc/install.html
151
doc/install.html
|
|
@ -16,7 +16,7 @@
|
|||
<div id="wrapper-content" role="main">
|
||||
<h1>VIVO Release 1 V1.3 Installation Guide</h1>
|
||||
<small>
|
||||
July 22, 2011
|
||||
July 29, 2011
|
||||
</small>
|
||||
<toc>
|
||||
<ul>
|
||||
|
|
@ -29,25 +29,27 @@
|
|||
</ul>
|
||||
</toc>
|
||||
<!-- Release Announcement --><h2 id="announcement">Release anouncement for V1.3</h2>
|
||||
VIVO Release 1.3 incorporates changes to the search indexing, user
|
||||
accounts, menu management, ontology, and visualizations.
|
||||
<!-- Release Announcement -->VIVO Release 1.3 incorporates changes to the search
|
||||
indexing, user accounts, menu management, ontology, and visualizations, and begins
|
||||
integration of VIVO Harvester functions with VIVO's own ingest tools.
|
||||
<br>
|
||||
<h4>Search</h4>
|
||||
VIVO 1.3 will feature notable improvements to the local search,
|
||||
primarily to improve relevance ranking but also to boost the influence
|
||||
of semantic relationships in the search. This will improve recall by
|
||||
including text from related resources (e.g., adding a person’s grant
|
||||
and publication titles to his or her search entry) and by boosting
|
||||
overall relevance ranking based on the number and nature of connections
|
||||
from one individual to others.
|
||||
<br>
|
||||
VIVO is now using Apache Solr (http://lucene.apache.org/solr/) in place
|
||||
of Apache Lucene to improve indexing and faceting of search results.
|
||||
The migration to Solr also aligns the local search with the VIVO
|
||||
multi-site search site under development for release prior to the 2011
|
||||
VIVO Conference.
|
||||
<br>
|
||||
<p>
|
||||
VIVO 1.3 will feature notable improvements to the local search, primarily to
|
||||
improve relevance ranking but also to boost the influence of semantic relationships
|
||||
in the search. This will improve recall by including text from related resources
|
||||
(e.g., adding a person's grant and publication titles to his or her search entry)
|
||||
and by boosting overall relevance ranking based on the number and nature of
|
||||
connections from one individual to others.
|
||||
</p>
|
||||
<p>
|
||||
VIVO is now using Apache Solr (http://lucene.apache.org/solr/) in place of
|
||||
Apache Lucene to improve indexing and faceting of search results. The migration
|
||||
to Solr also aligns the local search with the VIVO multi-site search site under
|
||||
development for release prior to the 2011 VIVO Conference.
|
||||
</p>
|
||||
<h4>Authorization</h4>
|
||||
<p>
|
||||
Release 1.3 provides an entirely new model of authorization within the
|
||||
VIVO application to allow more granular control over system
|
||||
configuration and editing. The first phase of the new user account
|
||||
|
|
@ -55,42 +57,55 @@
|
|||
root acount, and password reset functionality where the password gets
|
||||
emailed to the user. The next phase will provide the ability to create
|
||||
new roles.
|
||||
<br>
|
||||
</p>
|
||||
<h4>Menu management</h4>
|
||||
<p>
|
||||
The menus across the top of the site (Home, People, Organizations,
|
||||
Research, Events) can now be managed in a web form instead of editing
|
||||
an RDF file. In addition to making site management much easier,
|
||||
form-based editing also allows more control over what classes of data
|
||||
are displayed and provides a mechanism to limit certain menu pages to
|
||||
content identified as internal to the institution.
|
||||
<br>
|
||||
</p>
|
||||
<h4>FreeMaker template improvements</h4>
|
||||
<p>
|
||||
While less directly visible to the public, version 1.3 also includes
|
||||
additional changes focused directly on supporting open source community
|
||||
involvement in extending and customizing VIVO. The development team
|
||||
began a year ago to transition VIVO’s code base away from Java Server
|
||||
began a year ago to transition VIVO's code base away from Java Server
|
||||
Pages to the FreeMarker page templating system that much more cleanly
|
||||
separates internal application programming logic from page display.
|
||||
<br>
|
||||
</p>
|
||||
<h4>Visualization</h4>
|
||||
The visualization team has implemented a Science Map visualization,
|
||||
<p>
|
||||
The visualization team has implemented a Map of Science visualization,
|
||||
which allows users to visually explore the scientific strengths of a
|
||||
university, school, department, or person in the VIVO instance. Users
|
||||
will be able to see where an organization or person’s interests lay
|
||||
will be able to see where an organization or person's interests lay
|
||||
across 13 major scientific disciplines or 554 sub-disciplines, and will
|
||||
be able to see how these disciplines and sub-disciplines interrelate
|
||||
with one another on the map of science. Wireframes and design
|
||||
documentation for upcoming enhanced versions of the Science Map
|
||||
visualization have already been developed; the Science Map
|
||||
documentation for upcoming enhanced versions of the Map of Science
|
||||
visualization have already been developed; the Map of Science
|
||||
visualization will most likely be in the form of a PDF that a user can
|
||||
download.
|
||||
<br>
|
||||
</p>
|
||||
<p>
|
||||
Several visualization also now provide a caching feature that improves
|
||||
performance after the initial processing.
|
||||
<br>
|
||||
</p>
|
||||
<h4>QR Codes</h4>
|
||||
Pages for people in VIVO have the option of displaying QR codes.
|
||||
<br>
|
||||
<p>
|
||||
Pages for people in VIVO now have an icon for displaying QR codes to allow
|
||||
capturing names and available contact information on mobile devices.
|
||||
</p>
|
||||
<h4>Harvester Integration</h4>
|
||||
<p>
|
||||
VIVO sites have the option with Release 1.3 of coordinating the configuration
|
||||
of VIVO and the Harvester to enable many Harvester functions to be initiated
|
||||
from the VIVO Ingest Tools menu in support of more unified and centralized
|
||||
management for data ingest.
|
||||
</p>
|
||||
<h4>Ontology changes</h4>
|
||||
<ul>
|
||||
<li>
|
||||
|
|
@ -114,11 +129,12 @@
|
|||
</li>
|
||||
</ul>
|
||||
<h4>Linked open data</h4>
|
||||
<p>
|
||||
Responses to linked data requests have been enhanced to include
|
||||
additional context about any individual, in working toward a goal of
|
||||
being able to provide all the data in a person's profile available as
|
||||
RDF via a single web request.
|
||||
<br>
|
||||
</p>
|
||||
<br>
|
||||
<hr><!-- Page break --><!-- Installation process for V1.2 --><h2 id="installation">Installation process for V1.3</h2>
|
||||
<p>
|
||||
|
|
@ -228,6 +244,9 @@
|
|||
<li>
|
||||
<a href="#installation_check">Was the installation successful?</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#termsofuse">Review the VIVO Terms of Use</a>
|
||||
</li>
|
||||
</ol>
|
||||
</toc>
|
||||
<h3 id="required_software">I. Install required software </h3>
|
||||
|
|
@ -258,7 +277,7 @@
|
|||
support websites.
|
||||
</p>
|
||||
<p>
|
||||
* Note that VIVO 1.2 will not run on older versions of MySQL that
|
||||
* Note that VIVO V1.2 or V1.3 will not run on older versions of MySQL that
|
||||
may have worked with 1.1.1. Be sure to run VIVO 1.2 with MySQL 5.1 or
|
||||
higher. Using unsupported versions may result in strange error messages
|
||||
related to table formatting or other unexpected problems.
|
||||
|
|
@ -292,8 +311,8 @@
|
|||
<br>
|
||||
</h3>
|
||||
<p>
|
||||
Download the VIVO application source as either <code>rel-1.2.zip</code>
|
||||
or <code>rel-1.2.gz</code>
|
||||
Download the VIVO application source as either <code>rel-1.3.zip</code>
|
||||
or <code>rel-1.3.gz</code>
|
||||
file and unpack it on your web server:
|
||||
<br>
|
||||
<a href="http://vivoweb.org/download">http://vivoweb.org/download</a>
|
||||
|
|
@ -417,8 +436,7 @@
|
|||
made to Solr, the IP address of the requestor must match one of the
|
||||
patterns, or the request will be rejected.
|
||||
<br>
|
||||
Examples:
|
||||
<code>
|
||||
Examples:<code>
|
||||
<ul>
|
||||
<li>
|
||||
vitro.local.solr.ipaddress.mask = 127\.0\.0\.1
|
||||
|
|
@ -534,22 +552,6 @@
|
|||
password
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
Specify the Jena triple store technology to use.
|
||||
SDB is Jena's SPARQL database; this setting allows RDF data to scale
|
||||
beyond the limits of the JVM heap. Set to RDB to use the older Jena RDB
|
||||
store with in-memory caching.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="odd_row">
|
||||
<td>
|
||||
VitroConnection.DataSource.tripleStoreType
|
||||
</td>
|
||||
<td>
|
||||
SDB
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
Specify the maximum number of active connections
|
||||
|
|
@ -667,15 +669,33 @@
|
|||
http://vivo.mydomain.edu/ns#networkId
|
||||
</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">
|
||||
The temporal graph visualization can require
|
||||
extensive machine resources. This can have a particularly noticable
|
||||
impact on memory usage if
|
||||
<ul>
|
||||
<li>
|
||||
VIVO is configured to use Jena SDB,
|
||||
</li>
|
||||
<li>
|
||||
The organization tree is deep,
|
||||
</li>
|
||||
|
|
@ -683,11 +703,8 @@
|
|||
The number of grants and publications is large.
|
||||
</li>
|
||||
</ul>
|
||||
The VIVO developers are working to make this visualization more
|
||||
efficient. In the meantime, VIVO release 1.2 guards against this impact
|
||||
by disabling the temporal graph visualization unless the
|
||||
"visualization.temporal" flag is set to "enabled". To enable it,
|
||||
uncomment the line for this setting.
|
||||
VIVO V1.3 mitigates this problem by the way of a caching
|
||||
mechanism and hence we can safely set this to be enabled by default.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="odd_row">
|
||||
|
|
@ -1077,12 +1094,26 @@
|
|||
administrator and go to "http://your-vivo-url/SearchIndex".
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="termsofuse">XIII. Review the VIVO Terms of Use</h3>
|
||||
<p>
|
||||
VIVO comes with a "Terms of Use" statement linked from the footer.
|
||||
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
|
||||
"Site Name", the file can be found here:<pre>[vivo_source_dir]/vitro-core/webapp/web/templates/freemarker/body/termsOfUse.ftl</pre>
|
||||
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>
|
||||
Now that you have VIVO up and running, please go read the <a href="http://sourceforge.net/apps/mediawiki/vivo/index.php?title=Site_Administrator_Guide">Site Administrator's Guide</a>.
|
||||
</p>
|
||||
</div>
|
||||
<!-- #wrapper-content -->
|
||||
<div id="footer" role="contentinfo">
|
||||
<p class="copyright">
|
||||
<small>
|
||||
©2011 All Rights Reserved | <a class="terms" href="/termsOfUse">Terms of Use</a>
|
||||
©2011 All Rights Reserved
|
||||
</small>
|
||||
| Powered
|
||||
by <a class="powered-by-vivo" href="http://vivoweb.org" target="_blank"><strong>VIVO</strong></a>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
<div id="wrapper-content" role="main">
|
||||
<h1>VIVO Release 1 V1.3 Upgrade Guide</h1>
|
||||
<small>
|
||||
July 28, 2011 - Upgrading from Release 1 V1.2 to Release 1 V1.3
|
||||
July 29, 2011 - Upgrading from Release 1 V1.2 to Release 1 V1.3
|
||||
</small>
|
||||
<toc>
|
||||
<ul>
|
||||
|
|
@ -364,21 +364,21 @@
|
|||
<toc>
|
||||
<ul>
|
||||
<li>
|
||||
The file used to register list views has changed to a directory where new
|
||||
<code>.rdf</code> or <code>.n3</code> files can be placed:
|
||||
<code>/vivo/productMods/WEB-INF/ontologies/app/loadedAtStartup</code>. The rdf required
|
||||
The file used to register list views has changed to a directory where new<code>.rdf</code>
|
||||
or <code>.n3</code>
|
||||
files can be placed: <code>/vivo/productMods/WEB-INF/ontologies/app/loadedAtStartup</code>. The rdf required
|
||||
to register a new view has not changed.
|
||||
</li>
|
||||
<li>
|
||||
<code><query-base></code> and <code><query-collated></code>
|
||||
<code><query-base></code>
|
||||
and <code><query-collated></code>
|
||||
have been replaced with a single query <code><query-select></code>
|
||||
that contains tags for fragments to be used only in the collated
|
||||
version of the query.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
These and other changes are documented in greater detail in
|
||||
<code style="whitespace:nowrap;">/vitro/doc/list_view_configuration_guidelines.txt</code>.
|
||||
These and other changes are documented in greater detail in<code style="whitespace:nowrap;">/vitro/doc/list_view_configuration_guidelines.txt</code>.
|
||||
</p>
|
||||
</toc>
|
||||
<h4 id="authorization">v. Authorization</h4>
|
||||
|
|
@ -893,23 +893,6 @@
|
|||
password
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
Specify the Jena triple store technology to
|
||||
use.
|
||||
SDB is Jena's SPARQL database; this setting allows RDF data to scale
|
||||
beyond the limits of the JVM heap. Set to RDB to use the older Jena RDB
|
||||
store with in-memory caching.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="odd_row">
|
||||
<td>
|
||||
VitroConnection.DataSource.tripleStoreType
|
||||
</td>
|
||||
<td>
|
||||
SDB
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
Specify the maximum number of active
|
||||
|
|
@ -1022,15 +1005,33 @@
|
|||
http://vivo.mydomain.edu/ns#networkId
|
||||
</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">
|
||||
The temporal graph visualization can require
|
||||
extensive machine resources. This can have a particularly noticable
|
||||
impact on memory usage if
|
||||
<ul>
|
||||
<li>
|
||||
VIVO is configured to use Jena SDB,
|
||||
</li>
|
||||
<li>
|
||||
The organization tree is deep,
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue