Versions Compared

Old Version 8

changes.mady.by.user Jim Blake

Saved on

compared with

New Version 9

changes.mady.by.user Jim Blake

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Windows: 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. c:/tomcat.

Basic properties

These properties define some fundamental aspects of your VIVO installation. Most sites will need to modify each of these values.

Property name

Vitro.defaultNamespace

Description

The default RDF namespace for this installation.

VIVO installations make their RDF resources available for harvest using linked data. Requests for RDF resource URIs redirect to HTML or RDF representations as specified by the client. To make this possible, VIVO's default namespace must have a certain structure and begin with the public web address of the VIVO installation. For example, if the web address of a VIVO installation is "http://vivo.example.edu/" the default namespace must be set to "http://vivo.example.edu/individual/" in order to support linked data. Similarly, if VIVO is installed at "http://www.example.edu/vivo" the default namespace must be set to "http://www.example.edu/vivo/individual/"

* The namespace must end with "individual/" (including the trailing slash).
Default valueNONE
Example valuehttp://vivo.mydomain.edu/individual/
Property name

rootUser.emailAddress

Description Specify the email address of the root user account for the VIVO application. This user will have an initial temporary password of rootPassword. You will be prompted to create a new password on first login.

NOTE: The root user account has access to all data and all operations in VIVO. Data views may be surprising when logged in as the root user. It is best to create a Site Admin account to use for every day administrative tasks.

Default valueNONE
Example valuevivoAdmin@my.domain.edu
Property name

vitroVitroConnection.local.solrDataSource.url

Description Specify the JDBC URL of Solr context used in local VIVO search. Should consist of:your database. Change the end of the URL to reflect your database name (if it is not "vivo").
Default valueNONE
Example valuejdbc:mysql://localhost/vivo
Property name

VitroConnection.DataSource.username

Description Change the username to match the authorized user you created in MySQL.
Default valueNONE
Example valueusername
Property name

VitroConnection.DataSource.password

Description Change the password to match the password you created in MySQL.
Pre
scheme + servername + port + vivo_webapp_name + "solr"

 

In the standard installation, the Solr context will be on the same server as VIVO, and in the same Tomcat instance. The path will be the VIVO webapp.name (specified above) + "solr"
Default valueNONE
Example valuehttp://localhost:8080/vivosolrpassword
Property name

email.smtpHost

DescriptionSpecify 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.
Default valueNONE
Example valuesmtp.servername.edu
Property name

email.replyTo

DescriptionSpecify 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.
Default valueNONE
Example valuevivoAdmin@my.domain.edu

Extended properties

These are properties that many sites will not need to modify.

Property name

vitro.local.solr

Property name

VitroConnection.DataSource.url

Description Specify the JDBC

URL of

your database. Change the end of the URL to reflect your database name (if it is not "vivo").
Default valueNONE
Example valuejdbc:mysql://localhost/vivo
Property name

VitroConnection.DataSource.username

Solr context used in local VIVO search. Should consist of:

Pre
scheme + servername + port + vivo_webapp_name + "solr"

 

In the standard installation, the Solr context will be on the same server as VIVO, and in the same Tomcat instance. The path will be the VIVO webapp.name (specified above) + "solr"

Description Change the username to match the authorized user you created in MySQL.

Default valueNONE
Example valueusername
Property name

VitroConnection.DataSource.password

Description Change the password to match the password you created in MySQL.
Default valueNONE
Example valuepassword
Property name

XXX

Description 
Default valueNONE
Example valuexxx

 

 

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.
VitroConnection.DataSource.pool.maxActive40
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.
VitroConnection.DataSource.pool.maxIdle10
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.
VitroConnection.DataSource.dbtypeMySQL
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.
VitroConnection.DataSource.drivercom.mysql.jdbc.Driver
Change the validation query used to test database connections only if necessary to use a database other than MySQL. Otherwise, leave this value unchanged.
VitroConnection.DataSource.validationQuerySELECT 1
Set the endpointURI only if you wish to store semantic data in an external triple store instead of MySQL. Enter the URI of the triple store's SPARQL endpoint for querying data.
VitroConnection.DataSource.endpointURI
Set the updateEndpointURI only if you wish to store semantic data in an external triple store instead of MySQL. Enter the URI at which the triple store responds to SPARQL UPDATE requests. This setting is only necessary if the triple store does not support updates via its main URI. If the endpointURI above is not set, this setting has no effect.
VitroConnection.DataSource.updateEndpointURI
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).
selfEditing.idMatchingPropertyhttp://vivo.mydomain.edu/ns#networkId
If an external authentication system like Shibboleth or CUWebAuth is to be used, this property says which HTTP header will contain the user ID from the authentication system. If such a system is not to be used, leave this commented out.
externalAuth.netIdHeaderNameremote_userID
The temporal graph visualization can require extensive machine resources. This can have a particularly noticable impact on memory usage if
  • The organization tree is deep,
  • The number of grants and publications is large.
VIVO V1.4 (and later) mitigates this problem by the way of a caching mechanism and hence we can safely set this to be enabled by default.
visualization.temporalenabled
The temporal graph visualization is used to compare different organizations/people within an organization on parameters like number of publications or grants. By default, the app will attempt to make its best guess at the top level organization in your instance. If you're unhappy with this selection, uncomment out the property below and set it to the URI of the organization individual you want to identify as the top level organization. It will be used as the default whenever the temporal graph visualization is rendered without being passed an explicit org. For example, to use "Ponce School of Medicine" as the top organization:
visualization.topLevelOrg = http://vivo.psm.edu/individual/n2862
visualization.topLevelOrghttp://vivo-trunk.indiana.edu/individual/topLevelOrgURI
An absolute file path, pointing to the root directory of the Harvester utility. You must include the final slash.
harvester.location/usr/local/vivo/harvester/
Types of individual for which we can create proxy editors. If this is omitted, defaults to http://www.w3.org/2002/07/owl#Thing
proxy.eligibleTypeListhttp://xmlns.com/foaf/0.1/Person, http://xmlns.com/foaf/0.1/Organization
Tell VIVO to generate HTTP headers on its responses to facilitate caching the profile pages that it creates. This can improve performance, but it can also result in serving stale data. Default is false if not set. For more information, see the VIVO wiki page: Use HTTP caching to improve performance
http.createCacheHeaderstrue
Show only the most appropriate data values based on the Accept-Language header supplied by the browser. Default is false if not set.
RDFService.languageFilterfalse
Force VIVO to use a specific language or Locale instead of those specified by the browser. This affects RDF data retrieved from the model, if RDFService.languageFilter is true. This also affects the text of pages that have been modified to support multiple languages.
languages.forceLocaleen_US
A list of supported languages or Locales that the user may choose to use instead of the one specified by the browser. Selection images must be available in the i18n/images directory of the theme. This affects RDF data retrieved from the model, if RDFService.languageFilter is true. This also affects the text of pages that have been modified to support multiple languages.
languages.selectableLocalesen, es, fr_FR
On the VIVO home page, display a global map highlighting the geographical focus of foaf:person individuals. The default is enabled.
homePage.geoFocusMaps = enabledenabled
MultiViews for foaf:person profile pages. VIVO supports the simultaneous use of a full foaf:Person profile page view and a "quick" page view that emphasizes the individual's own webpage presence. Implementing this feature requires an installation to develop a web service that captures images of web pages or to use an existing service outside of VIVO, usually for a small fee. The default is disabled.
MultiViews.profilePageTypes=disableddisabled

Start Tomcat

Warning
TBD

Was the installation successful?

Warning
TBD

Using VIVO

Warning
TBD

Log in and add RDF data

Warning
TBD

Set the Contact Email Address

Warning
TBD

Review the VIVO terms of use

Warning
TBD

Installation options

Warning
TBD

Running VIVO behind an Apache server

Warning
TBD

Using an external authentication system

Warning
TBD
Warning

External authentication: If you want to use an external authentication system like Shibboleth or CUWebAuth, you will need to set an additional property in this file. See the step below entitled Using an External Authentication System with VIVO.

 

Developers' installation: obtaining VIVO source code from Git

Warning
TBD

Customizing VIVO with a "3-tier" build

Warning
TBD

Using a database other than MySQL

Warning

TBD

Warning

Optional external triple store

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.

 

Using a servlet container other than Tomcat

Warning
TBD

Adding OpenSocial gadgets to VIVO

Warning
TBD
Warning
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		 

VIVO in a language other than English

Warning
TBD
http://localhost:8080/vivosolr
Warning
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).
selfEditing.idMatchingPropertyhttp://vivo.mydomain.edu/ns#networkId
The temporal graph visualization can require extensive machine resources. This can have a particularly noticable impact on memory usage if
  • The organization tree is deep,
  • The number of grants and publications is large.
VIVO V1.4 (and later) mitigates this problem by the way of a caching mechanism and hence we can safely set this to be enabled by default.
visualization.temporalenabled
The temporal graph visualization is used to compare different organizations/people within an organization on parameters like number of publications or grants. By default, the app will attempt to make its best guess at the top level organization in your instance. If you're unhappy with this selection, uncomment out the property below and set it to the URI of the organization individual you want to identify as the top level organization. It will be used as the default whenever the temporal graph visualization is rendered without being passed an explicit org. For example, to use "Ponce School of Medicine" as the top organization:
visualization.topLevelOrg = http://vivo.psm.edu/individual/n2862
visualization.topLevelOrghttp://vivo-trunk.indiana.edu/individual/topLevelOrgURI
An absolute file path, pointing to the root directory of the Harvester utility. You must include the final slash.
harvester.location/usr/local/vivo/harvester/
Types of individual for which we can create proxy editors. If this is omitted, defaults to http://www.w3.org/2002/07/owl#Thing
proxy.eligibleTypeListhttp://xmlns.com/foaf/0.1/Person, http://xmlns.com/foaf/0.1/Organization
Tell VIVO to generate HTTP headers on its responses to facilitate caching the profile pages that it creates. This can improve performance, but it can also result in serving stale data. Default is false if not set. For more information, see the VIVO wiki page: Use HTTP caching to improve performance
http.createCacheHeaderstrue
On the VIVO home page, display a global map highlighting the geographical focus of foaf:person individuals. The default is enabled.
homePage.geoFocusMaps = enabledenabled
MultiViews for foaf:person profile pages. VIVO supports the simultaneous use of a full foaf:Person profile page view and a "quick" page view that emphasizes the individual's own webpage presence. Implementing this feature requires an installation to develop a web service that captures images of web pages or to use an existing service outside of VIVO, usually for a small fee. The default is disabled.
MultiViews.profilePageTypes=disableddisabled

Additional properties

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 properties.

 

 

Property name

XXX

Description 
Default valueNONE
Example valuexxx

 

 

Start Tomcat

Warning
TBD

Was the installation successful?

Warning
TBD

Using VIVO

Warning
TBD

Log in and add RDF data

Warning
TBD

Set the Contact Email Address

Warning
TBD

Review the VIVO terms of use

Warning
TBD

Installation options

Warning
TBD

Running VIVO behind an Apache server

Warning
TBD

Using an external authentication system

Warning
TBD
Warning

External authentication: If you want to use an external authentication system like Shibboleth or CUWebAuth, you will need to set an additional property in this file. See the step below entitled Using an External Authentication System with VIVO.

If an external authentication system like Shibboleth or CUWebAuth is to be used, this property says which HTTP header will contain the user ID from the authentication system. If such a system is not to be used, leave this commented out.
externalAuth.netIdHeaderNameremote_userID

 

Developers' installation: obtaining VIVO source code from Git

Warning
TBD

Customizing VIVO with a "3-tier" build

Warning
TBD

Using a database other than MySQL

Warning

TBD

Warning

Optional external triple store

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.

Warning
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.
VitroConnection.DataSource.pool.maxActive40
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.
VitroConnection.DataSource.pool.maxIdle10
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.
VitroConnection.DataSource.dbtypeMySQL
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.
VitroConnection.DataSource.drivercom.mysql.jdbc.Driver
Change the validation query used to test database connections only if necessary to use a database other than MySQL. Otherwise, leave this value unchanged.
VitroConnection.DataSource.validationQuerySELECT 1
Set the endpointURI only if you wish to store semantic data in an external triple store instead of MySQL. Enter the URI of the triple store's SPARQL endpoint for querying data.
VitroConnection.DataSource.endpointURI
Set the updateEndpointURI only if you wish to store semantic data in an external triple store instead of MySQL. Enter the URI at which the triple store responds to SPARQL UPDATE requests. This setting is only necessary if the triple store does not support updates via its main URI. If the endpointURI above is not set, this setting has no effect.
VitroConnection.DataSource.updateEndpointURI

 

Using a servlet container other than Tomcat

Warning
TBD

Adding OpenSocial gadgets to VIVO

Warning
TBD
Warning
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		 

VIVO in a language other than English

Warning
TBD
Warning
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.addToBuildes_MX
Warning
Show only the most appropriate data values based on the Accept-Language header supplied by the browser. Default is false if not set.
RDFService.languageFilterfalse
Force VIVO to use a specific language or Locale instead of those specified by the browser. This affects RDF data retrieved from the model, if RDFService.languageFilter is true. This also affects the text of pages that have been modified to support multiple languages.
languages.forceLocaleen_US
A list of supported languages or Locales that the user may choose to use instead of the one specified by the browser. Selection images must be available in the i18n/images directory of the theme. This affects RDF data retrieved from the model, if RDFService.languageFilter is true. This also affects the text of pages that have been modified to support multiple languages.
languages.selectableLocalesen, es, fr_FR
Warning
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.addToBuildes_MX

 

Other installation options

...