Versions Compared

Old Version 20

changes.mady.by.user Andrea Bollini (4Science)

Saved on

compared with

New Version 21

changes.mady.by.user Tim Donohue

Saved on

Key

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

...

Warning
titleDo not remove or comment out settings in build.properties

When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings.  Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting.  Instead, if you wish to remove/disable a particular setting, just clear out its value.  For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g.

mail.registration.notify=

Info
titleYou may add new settings to your build.properties or custom *.properties

Based on your institution's needs, you may wish to add settings to your own build.properties (or custom *.properties) file. This is actually a relatively easy process.

Any existing DSpace configuration (any config in dspace.cfg or in any configuration file under [dspace-src]/dspace/config/modules/*.cfg) can be "moved" into your local build.properties file via the following process:

  1. First, copy the existing configuration from the *.cfg file into your local build.properties file.  You can actually choose to rename this configuration in build.properties, if it makes more sense. Essentially, the name of the new configuration in build.properties is entirely up to you.
    1. For example, if you want to copy the LDAP "provider_url" from [dspace-src]/dspace/config/modules/authentication-ldap.cfg to your build.properties, you may wish to rename it to "ldap.provider_url" within build.properties
    2. You can also choose to keep the name of the configuration the same in build.properties. For example, if you wish to move the "xmlui.google.analytics.key" (from dspace.cfg) to your build.properties, you could keep the name the same.
  2. Second, you will need to modify the corresponding configuration file (the config file you copied the setting from) so that it now references your newly added build.properties setting. This is achieved by using the "${setting-in-build.properties}" placeholder.
    1. For example, to reference a new "ldap.provider_url" setting in build.properties (mentioned in 1.a above) , just modify the [dspace-src]/dspace/config/modules/authentication-ldap.cfg file to have a line that says provider_url=${ldap.provider_url} (The first part is the name of the actual config in authentication-ldap.cfg, and the second part is the name of the config in build.properties)
    2. Another example: To reference a new "xmlui.google.analytics.key" setting in build.properties (mentioned in 1.b above), just modify the [dspace-src]/dspace/config/dspace.cfg file to have a line that says xmlui.google.analytics.key=${xmlui.google.analytics.key}  (The first part is the name of the actual config in dspace.cfg, and the second part is the name of the config in build.properties)

 

The dspace.cfg Configuration Properties File

...