Current Release

This documentation covers the latest release of VIVO, version 1.10.x.
If you are able to help contribute to this documentation, please contact sysadmin at duraspace dot org
Looking for another version? See all documentation.

Skip to end of metadata
Go to start of metadata

Overview

VIVO's operation can be determined by setting corresponding properties in runtime.properties.

VIVO Runtime Properties

PropertyDescription
Vitro.defaultNamespace = http://vivo.mydomain.edu/individual/
        

This namespace will be used when generating URIs for objects created in the editor. In order to serve linked data, the default namespace must be composed as follows (optional elements in parentheses): scheme + server_name (+ port) (+ servlet_context) + "/individual/" For example, Cornell's default namespace is:
http://vivo.cornell.edu/individual/

rootUser.emailAddress = vivo_root@mydomain.edu

The email address of the root user for the VIVO application. The password for this user is initially set to "rootPassword", but you will be asked to change the password the first time you log in.

argon2.parallelism =1

For argon2i password handling. A parallelism degree defines the number of parallel threads

argon2.memory = 1024

For argon2i password handling. A memory cost defines the memory usage, given in kilobytes

argon2.time = 1000

For argon2i password handling. A time cost defines the amount of computation realized and therefore the execution time, given in a number of iterations.

For determining the optimal values of the parameters for your setup please refer to the white paper section  9 https://github.com/P-H-C/phc-winner-argon2/blob/master/argon2-specs.pdf

VitroConnection.DataSource.url = jdbc:mysql://localhost/vitrodb      
VitroConnection.DataSource.username = vitrodbUsername
VitroConnection.DataSource.password = vitrodbPassword

The basic parameters for a database connection. Change the end of the URL to reflect your database name (if it is not "vitrodb"). Change the username and password to match the authorized database user you created.

email.smtpHost = smtp.mydomain.edu
email.replyTo = vivoAdmin@mydomain.edu
        

Email parameters which VIVO can use to send mail. If these are left empty, the "Contact Us" form will be disabled and users will not be notified of changes to their accounts.

vitro.local.solr.url = http://localhost:8080/vivosolr 

URL of Solr context used in local VIVO search. This will usually consist of: scheme + server_name + 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 in build.properties) + "solr" Example: vitro.local.solr.url = http://localhost:8080/vivosolr

selfEditing.idMatchingProperty = 
http://vivo.mydomain.edu/ns#networkId

Associates user accounts with user profiles. URI of a datatype property. If the value of the property is the same on the user's profile and the user's account (specified via "Matching ID"), the profile is associated with the account.

externalAuth.netIdHeaderName = remote_userID

If an external authentication system such as 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. See Using an external authentication system

VitroConnection.DataSource.pool.maxActive = 40

The maximum number of active connections in the database connection pool. Increase this value to support a greater number of concurrent page requests.

VitroConnection.DataSource.pool.maxIdle = 10

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.dbtype = MySQL
VitroConnection.DataSource.driver = com.mysql.jdbc.Driver
VitroConnection.DataSource.validationQuery = SELECT 1

Parameters to change in order to use VIVO with a database other than MySQL. These parameters allow you to change the relational database that is used as the back end for Jena SDB. If you want to use a triple store other than SDB, you will need to edit applicationSetup.n3. See the installation instructions for more details.

OpenSocial.shindigURL = http://localhost:8080/shindigorng
        

For OpenSocial integration, the base URL of the ORNG Shindig server. Usually, this is the same host and port number as VIVO itself, with a context path of "shindigorng".

OpenSocial.tokenService = myhost.mydomain.edu:8777

For OpenSocial integration, The host name and port number of the service that provides security tokens for VIVO and Shindig to share. For now, the host name must be the actual host, not "localhost" or "127.0.0.1" The port number must be 8777

OpenSocial.tokenKeyFile = 
/usr/local/vivo/data/shindig/openssl/securitytokenkey.txt

For OpenSocial integration. The path to the key file that will be used when generating security tokens for VIVO and shindig to share.

OpenSocial.sandbox = True

For OpenSocial integration. Only set sandbox to True for dev/test environments. Comment out or set to False in production

RDFService.languageFilter = false

Show only the most appropriate data values based on the Accept-Language header supplied by the browser. Default is false if not set.

languages.forceLocale = en_US

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.selectableLocales = en_US, es_GO

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. This should not be used with languages.forceLocale, which will override it.

orcid.clientId = 0000-0000-0000-000X
orcid.clientPassword = 00000000-0000-0000-0000-000000000000
orcid.webappBaseUrl = http://localhost:8080/vivo orcid.externalIdCommonName = VIVO Cornell Identifier
orcid.apiVersion = 2.0
orcid.api = release | sandbox
ORCiD integration parameters. See Activating the ORCID integration
google.maps.key=

To use the Google Maps (e.g. Map of Science), you need to have a key for Google Maps. See https://developers.google.com/maps/documentation/javascript/get-api-key When you have a key, uncomment the line below and add it here

resource.altmetric=disabled

Uncomment and set this to disabled if you don't want AltMetric badges

resource.altmetric.displayto=right

Display the badge to the left or right of the title (default = right). Options: left, right

resource.altmetric.badge-type=donut

Badge type to display (default = donut) Options: See AltMetric documentation - recommended settings: donut, medium-donut

resource.altmetric.hide-no-mentions=true

Hide the badge if there are no mentions (default = true) Options: true, false

resource.altmetric.badge-popover=right

Display more details about the score when you hover over the badge (default = right) Options, right, left, up, down

resource.altmetric.badge-details=right
Display extended details alongside the badge (default = none)
homePage.geoFocusMaps=enabled

When the following flag is set to enabled, the VIVO home page displays a global map highlighting the geographical focus of foaf:person individuals. See Home page customizations

multiViews.profilePageTypes=enabled

VIVO supports the simultaneous use of a full foaf:Person profile page view and a "quick" page view that emphasizes the individual's 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. See Multiple profile types for foaf:Person

http.createCacheHeaders = true

Tell VIVO to generate HTTP headers on its responses to facilitate caching the profile pages that it creates. See Use HTTP caching to improve performance Developers will likely want to leave caching disabled, since a change to a Freemarker template or to a Java class would not cause the page to be considered stale.

harvester.location = /usr/local/vivo/harvester/

Absolute path on the server of the Harvester root directory. You must include the final slash. Setting a value for harvester.location indicates that the Harvester is installed at this path. This will enable the Harvester functions in the Ingest Tools page.

visualization.topLevelOrg = 
http://vivo.mydomain.edu/individual/topLevelOrgURI

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.temporal = enabled

The temporal graph visualization can require extensive machine resources. This can have a particularly noticeable impact on memory usage if The organization tree is deep, The number of grants and publications is large. VIVO 1.3 release mitigates this problem by the way of a caching mechanism hence we can safely set this to be enabled by default.

proxy.eligibleTypeList = http://xmlns.com/foaf/0.1/Person, 
http://xmlns.com/foaf/0.1/Organization

Types of individual for which we can create proxy editors. If this is omitted, defaults to http://www.w3.org/2002/07/owl#Thing

Vitro.reconcile.defaultTypeList = 
http://vivoweb.org/ontology/core#Role, core:Role;
http://vivoweb.org/ontology/core#AcademicDegree, core:Academic Degree;
http://purl.org/NET/c4dm/event.owl#Event, event:Event;
http://vivoweb.org/ontology/core#Location, core:Location;
http://xmlns.com/foaf/0.1/Organization, foaf:Organization;
http://xmlns.com/foaf/0.1/Person, foaf:Person;
http://purl.obolibrary.org/obo/IAO_0000030, obo:IAO_0000030

Default type(s) for Google Refine Reconciliation Service. The format for this property is id, name; id1, name1; id2, name2 etc. For more information, see Service Metadata from this page: https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-Api

  • No labels