Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 3.9 KB

Configuration.md

File metadata and controls

88 lines (66 loc) · 3.9 KB
Raw

Configuration

Default configuration file is located at config/config.yml. All configuration options should be listed in the default typescript file src/config/default-app-config.ts. Please do not change this file directly! To override the default configuration values, create local files that override the parameters you need to change. You can use config.example.yml as a starting point.

  • Create a new config.(dev or development).yml file in config/ for development environment;
  • Create a new config.(prod or production).yml file in config/ for production environment;

Alternatively, create a desired app config file at an external location and set the path as environment variable DSPACE_APP_CONFIG_PATH.

e.g.

DSPACE_APP_CONFIG_PATH=/usr/local/dspace/config/config.yml

Configuration options can be overridden by setting environment variables.

Nodejs server

When you start dspace-angular on node, it spins up an http server on which it listens for incoming connections. You can define the ip address and port the server should bind itsself to, and if ssl should be enabled not. By default it listens on localhost:4000. If you want it to listen on all your network connections, configure it to bind itself to 0.0.0.0.

To change this configuration, change the options ui.host, ui.port and ui.ssl in the appropriate configuration file (see above):

ui:
  ssl: false
  host: localhost
  port: 4000
  nameSpace: /

Alternately you can set the following environment variables. If any of these are set, it will override all configuration files:

  DSPACE_SSL=true
  DSPACE_HOST=localhost
  DSPACE_PORT=4000
  DSPACE_NAMESPACE=/

or

  DSPACE_UI_SSL=true
  DSPACE_UI_HOST=localhost
  DSPACE_UI_PORT=4000
  DSPACE_UI_NAMESPACE=/

DSpace's REST endpoint

dspace-angular connects to your DSpace installation by using its REST endpoint. To do so, you have to define the ip address, port and if ssl should be enabled. You can do this in a configuration file (see above) by adding the following options:

rest:
  ssl: true
  host: api7.dspace.org
  port: 443
  nameSpace: /server
}

Alternately you can set the following environment variables. If any of these are set, it will override all configuration files:

  DSPACE_REST_SSL=true
  DSPACE_REST_HOST=api7.dspace.org
  DSPACE_REST_PORT=443
  DSPACE_REST_NAMESPACE=/server

Environment variable naming convention

Settings can be set using the following convention for naming the environment variables:

  1. replace all . with _
  2. convert all characters to upper case
  3. prefix with DSPACE_

e.g.

cache.msToLive.default => DSPACE_CACHE_MSTOLIVE_DEFAULT
auth.ui.timeUntilIdle => DSPACE_AUTH_UI_TIMEUNTILIDLE

Supporting analytics services other than Google Analytics

This project makes use of Angulartics to track usage events and send them to Google Analytics.

Angulartics can be configured to work with a number of other services besides Google Analytics as well, e.g. Piwik, Google Tag Manager, or Azure Application Insights to name a few.

In order to start using one of these services, select it from the Angulartics Providers page, and follow the instructions on how to configure it.

The Google Analytics script was added in main.browser.ts instead of the <head> tag in index.html to ensure events get sent when the page is shown in a client's browser, and not when it's rendered on the universal server. Likely you'll want to do the same when adding a new service.