Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add example for multi-valued configs

...

  • Using Environment variables. All environment variables MUST (1) be prefixed with "DSPACE_", (2) use underscores as separators (no dots allowed), and (3) use all uppercase.  Some examples are below:

    Code Block
    # "ui" settings environment variables
    ui.host => DSPACE_UI_HOST # The host name 
    ui.port => DSPACE_UI_PORT # The port number 
    ui.nameSpace => DSPACE_UI_NAMESPACE # The namespace
    ui.ssl => DSPACE_UI_SSL # Whether the angular application uses SSL [true/false]
    
    # "rest" settings environment variables
    rest.host => DSPACE_REST_HOST # The host name of the REST application
    rest.port => DSPACE_REST_PORT # The port number of the REST application
    rest.nameSpace => DSPACE_REST_NAMESPACE # The namespace of the REST application
    rest.ssl => DSPACE_REST_SSL # Whether the angular REST uses SSL [true/false]
    
    # Other examples
    defaultLanguage => DSPACE_DEFAULTLANGUAGE
    mediaViewer.video => DSPACE_MEDIAVIEWER_VIDEO
    
    # NOTE: At this time, only string/boolean/number based settings can be overridden in Environment variablesMulti-valued setting examples
    # If a setting can have multiple values (e.g. theme names), then use an index number (starting with zero)
    # to specify the multiple values.
    # The below example is equivalent to:
    # themes:
    #   - name: 'dspace'
    #   - name: 'mytheme'
    #     handle: '10673/123'
    DSPACE_THEMES_0_NAME = 'dspace'
    DSPACE_THEMES_1_NAME = 'mytheme'
    DSPACE_THEMES_1_HANDLE = '10673/123'


  • Or, by creating a .env (environment) file in the project root directory and setting the environment variables in that location.

...