This guide describes the configuration properties for all the eagle-i applications, with the following exceptions:
- Repository application (configuration properties can be found here)
- Repository for the public SPARQL endpoint (configuration properties can be found Public SPARQL Endpoint)
- Note: There are optional properties for this component listed in this guide.
The properties described here are to be used in the eagle-i-apps.properties file. This file should be located in the eagle-i configuration directory, e.g. /opt/eaglei/conf.
We strongly recommend that any properties containing credentials should be placed in eagle-i-apps-credentials.properties and the file should be placed in a directory within the classpath and only accessible by a root user, e.g. /opt/eaglei/.config.
This guide has been updated to reflect changes with the 3.0.4 release.
Basic Properties
The following properties apply to a simple installation (no optional features).
Property Name (*indicates a required property) | Description | Type (Expected Value) | Default Value |
|---|---|---|---|
Header and footer navigation for application pages | |||
eaglei.ui.gwt.uiconfig.centralNavbarUrl | The location of the html snippet used as the top navigation on pages served from the central site. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
eaglei.ui.gwt.uiconfig.centralFooterNavUrl | The location of the html snippet used as the top navigation on pages served from the central site. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
eaglei.ui.gwt.uiconfig.institutionNavbarUrl | The location of the html snippet used as the top navigation on pages served from certain institution applications site. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
eaglei.ui.gwt.uiconfig.institutionFooterNavUrl | The location of the html snippet used as the top navigation on pages served from certain institution applications site. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
eaglei.ui.gwt.uiconfig.sweetNavbarUrl | The location of the html snippet used as the top navigation on pages served from the SWEET application. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
eaglei.ui.gwt.uiconfig.sweetFooterNavUrl | The location of the html snippet used as the top navigation on pages served from the SWEET application. If none is provided, a backup file is used. N.B. the backup file may not represent the latest links. | String (URL) | none |
| Configures the email server hostname to be used by the applications. | String (hostname) | none |
eaglei.email.mta.port | Configures the port to use for the email server that will be used by the applications. | Integer | 25 |
eaglei.email.mta.ssl | Configures the email server to use SSL. Set to true to use SSL. Please note email credentials are required if using SSL. See below. | Boolean | false |
| Specifies the email address that will be used as the sender of the emails sent by the applications. | String (email) | none |
| Specifies the name to use for the postmaster email address. | String | none |
| Specifies the email address that will receive the feedback when using the 'Give us feedback' button. Please note that this property is not required when using a feedback method other than email. | String (email) | none |
Other | |||
eaglei.search.is.central | Indicates if the search application is an instance of Institution Search or Central Search. Set to true for Central Search. Please note that both search applications cannot coexist. | Boolean | false |
Credentials | |||
eaglei.email.mta.username | The username to use for the email server. Please note that this is required when using SSL for email. | String | none |
eaglei.email.mta.password | The password to use for the email server. Please note that this is required when using SSL for email. | String | none |
| The username for a repository user who has add, remove and read access to the graph NG_GLobalProxy, which is used for caching centrally curated resource data locally. This user is used in the automated synchronization of the centrally curated resources data. | String | none |
| The password for a repository user who has add, remove and read access to the graph NG_GLobalProxy, which is used for caching centrally curated resource data locally. This user is used in the automated synchronization of the centrally curated resources data. | String | none |
| The username for a repository user who has no roles. This user is used for webservices provide by SWEET. These services include the generation of the resource provider summary lists on the landing page for the institution, i.e. http://alaska.eagle-i.net. | String | none |
| The password for a repository user who has no roles. This user is used for webservices provide by SWEET. These services include the generation of the resource provider summary lists on the landing page for the institution, i.e. http://alaska.eagle-i.net. | String | none |
Optional Properties
Property Name (*indicates a required property for using the feature) | Description | Type (Expected Value) | Default Value |
|---|---|---|---|
eaglei.ui.analyticsId | Specifies the google analytics ID to use. Please note that the data usage fora node is mutually exclusive with usage on the central search node. | String | none |
Feature: Centrally curated resources repository details | |||
eaglei.datatools.globalPolling.frequency | Specifies how frequently the local cache of the centrally curated resources should be synchronized with the centrally curated resources repository. | Integer | 24 |
eaglei.datatools.globalPolling.unit | Specifies the unit of how frequently the local cache of the centrally curated resources should be synchronized with the centrally curated resources repository. Please note that this value must be a Java TimeUnit. | String | HOURS |
Feature: Public SPARQL Endpoint details | |||
| Specifies the base url for the source repository that is used to supply the data for the public SPARQL endpoint. Please note that this url should not contain the repository endpoint. | String (URL) | none |
| Specifies the url for the public SPARQL endpoint. This is the url that is used for accessing the public SPARQL endpoint and is also the destination of the data from the source repository. Please note that this url does contain the application endpoint (sparqler). | String (URL) | none |
| The username for a repository user who has Level 4 access to the source repository. | String | none |
| The password for a repository user who has Level 4 access to the source repository. | String | none |
| The username for a repository user who has Level 4 access to the target repository. | String | none |
| The password for a repository user who has Level 4 access to the target repository. | String | none |
Feature: Enable login for Institution Search | |||
| Indicates if the search application should require a login. When set to true in an institution search, users are authenticated with their SWEET credentials. Please note that this should not be set for central search. | Boolean | false |
| Specify the url that users should be redirected to when they logout of the search application. Please note that this should not be set if not using login. | String (URL) | none |
Feature: Enable a localized ontology details | |||
| Specifies the IRI (Internationalized URI) for the institution specific ontology. Used when specifying institution specific annotations. | String (IRI) | none |
| Specifies the source file containing the institution specific ontology. | String | none |
Feature: Logging search queries to a relational database | |||
| Specifies the base jdbc url to be used in the logging database connection string. e.g. jdbs:mysql:// | String | none |
| Specifies the hostname (and port number if applicable) to be used in the logging database connection string. e.g. localhost:2980 | String | none |
| Specifies the name of the database to be used in the logging database connection string. | String | none |
| Specifies the user name for accessing the logging database. | String | none |
| Specifies the password for accessing the logging database. | String | none |
Advanced Properties
The following properties have defaults that are used by the eagle-i applications. They are listed here for completeness and as a guide for contributors. Please do not override the default values unless you are sure of what you are doing.
Property Nam | Description | Type (Expected Value) | Default Value |
|---|---|---|---|
eaglei.email.termRequests | Specifies the email address to send term requests to. Please note changing this from the default may result in unfulfilled term requests. | String (email) | term-requests@eagle-i.net |
eaglei.datatools.uses.globals | Specifies if the SWEET application should retrieve data from the Centrally Curated Resources repository. Set to true to use retrieve data. Please note that a repository user is required in order to cache the data locally for use, see above basic properties. Please see optional properties for additional configuration options to use when retrieving data. | Boolean | true |
eaglei.search.harvester.polling | The frequency that search should harvest data from the repository for indexing. In Institution Search, this will determine how frequently data is to be harvested from the institution's repository. In Central Search, this will determine how frequently data is to be harvested from each of the institutions in the network. Harvesting is the process of getting any new or changed data from the repository. Resources are only found by search if they have been harvested by the search application. | Long (ms) | 30000 |
eaglei.noderegistry.pingInterval | The frequency that central search should check the repositories on the network for their current status. | Long (ms) | 30000 |
| Length of allowed idleness for a user. If a user is not active for this amount of time (default is 4 hours), the application will log the user out. | Long (ms) | 14400000 |
| Location of the content site. Used to build links within various applications. | String (URL) | https://eagle-i.net |
| The location of the javascript for the search bar. This location should be at the root. A pre-determined folder structure to the script is used. | String (URL) | https://eagle-i.net |
| URL of where the javascript search bar should perform its searches. | String (URL) | https://eagle-i.net/central |
eaglei.ui.gwt.search.nodeRegistryUrl | The endpoint to access the node registry from applications other than central serarch. | String (URL) | https://search.eagle-i.net/central/configs |
| Specifies the location of the ontology webservice that is used by SWEET for certain drop downs. Also used by other applications to build the URL to click through to the entry in the ontology browser. Please note that this can also be used during development in conjunction with the dev mode flag to specify an alternate ontology. | String (URL) | https://search.eagle-i.net/model |
| Specifies the IRI (Internationalized URI) of the core eagle-i application layer owl file | String (IRI) | http://eagle-i.org/ont/app/1.0/eagle-i-core-app.owl |
| Accepts all certificates, including self-signed certificates for http communications that are handled programatically (i.e. between sweet/search and the repository). This is intended for use during development or while evaluating the software, without having to obtain a real certificate. To avoid possible security risks, this property must not exist in production or else it should be set to FALSE. | Boolean | false |
| This flag specifies whether or not the application should be run in developer mode. Developer mode allows for bypassing certain lengthy processes that are necessary during development. To determine what bypasses are done, please look in the code. To specify developer mode should be active, set this to true. | Boolean | false |
Overview
Content Tools