Deprecated. This material represents early efforts and may be of interest to historians. It doe not describe current VIVO efforts.
...
Note |
---|
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. |
When you have VIVO up and running, please read the Site Administrator's Guide.
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.
...
Warning |
---|
TBD |
The build process in the Compile and deploy step created a file called example.runtime.properties
in your VIVO home directory (specified by vitro.home
in the build.properties
file). Rename this file to runtime.properties
and edit the file to suit your installation, as described below.
...
The runtime.properties file can accept many additional properties, but most of them don't apply to the standard installation. If you choose any of the Installation options, you may need to set some of these those properties.
Property name |
|
---|---|
Description | |
Default value | NONE |
Example value | xxx |
Warning |
---|
TBD |
Warning |
---|
TBD |
Warning |
---|
TBD |
Warning |
---|
TBD |
Warning |
---|
TBD |
...
Most Tomcat installations can be started by running startup.sh
or startup.bat
in Tomcat's bin
directory. Start Tomcat and direct your browser to http://localhost:8080/vivo
to test the application. Note that Tomcat may require several minutes to start VIVO.
On start up VIVO will run some diagnostic tests. If a problem is detected the normal VIVO pages will redirect to a startup status page describing the problem. You can stop Tomcat, attempt to fix the problem and proceed from the Compile and deploy step. If the problem is not serious, the startup status page may offer a continue
link which will allow you to use VIVO in spite of the problems.
If the startup was successful, you will see the VIVO home page.
If Tomcat does not start up, or the VIVO application is not visible, check the files in Tomcat's logs directory. Error messages are commonly found in [tomcat]/logs/catalina.out
, [tomcat]/logs/vivo.all.log
or [tomcat]/logs/localhost.log
Direct your browser to the VIVO home page. Click the "Log in" link near the upper right corner. Log in with the rootUser.emailAddress
that you set in the runtime.properties
file. The initial password for the root account is rootPassword
. When you first log in, VIVO will require you to change the password. 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.
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 any individual must have an rdfs:label. There are a number of visibility and display options available for classes and properites. VIVO comes with a core VIVO ontology, but you may also upload other ontologies from an RDF file.
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."
Clicking the "Index" tab in the navigation bar at the top right of the page will show a simple index of the knowledge base.
See more documentation for configuring VIVO, ingesting data, and manually adding data at http://vivoweb.org/support.
If you have configured your application to use the "Contact Us" feature (email.smtpHost
is set in the runtime.properties
file), you will also need to add an email address to the VIVO application. This is the email to which the contact form will submit. It can be a list server or an individual's email address.
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.
If you set the email.smtpHost
in the runtime.properties
file, and do NOT provide an email address in this step, your users will see an error message instead of the expected contact form.
VIVO comes with a "Terms of Use" statement linked from the footer. The "Site Name" you assign in the "Site Information" form under the Site Admin 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:
[vivo_source_dir]/vitro-core/webapp/web/templates/freemarker/body/termsOfUse.ftl
Your "Terms of Use" statement is also referenced in the Linked Open Data (RDF) that your site produces, so you should be sure that it accurately reflects the way that your data may be used.
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.
Warning |
---|
TBD |
...
Warning |
---|
TBD |
Property name |
|
---|---|
Description | |
Default value | NONE |
Example value | xxx |
0