...
In DSpace 5 or below, DSpace used it's own custom Property-based configuration scheme, along with a custom build.properties
which could tweak the build/compilation process in order to "override" some pre-selected configurations in the dspace.cfg
file. While this configuration scheme "worked" at a basic level, it required a lot of custom variable interpolation (i.e. filtering) to occur in both the Maven build process (mvn package
) and the Ant install process (ant fresh_install
or ant update
). The end result was that configuration files in your DSpace installation directory ([dspace.dir]
) contained the correct settings from your build.properties file, but all variables (${setting}
) were filled out. So, it was no longer possible to easily tweak certain key settings (like dspace.dir
or solr.server
) without having to either re-run the entire build process or make corrections to several files at once.
...
- Apache Commons Configuration is a well-established Java library whose goal is to make configuration more flexible and easier to manage.
- It automatically interpolates all settings at runtime. This means we no longer need to replace variables (
${setting}
) within our configurations. They will be auto-determined at runtime based on the value of that variable within one of the configuration files For more on variable interpolation see its Basic Features documentation - It is a flexible configuration scheme. It can read configurations from several sources at once, including Properties files, XML config files and even database tables (see its Overview documentation). Currently, in the DSpace Enhanced Configuration Scheme we are still only using Properties files, similar to DSpace 5 and below. But, we now be able to easily move all or some configurations to XML configs or database config tables.
- The locations of the configuration sources can be easily customized by DSpace administrators in a new
config-definition.xml
file, which configures Apache Commons Configuration for DSpace. More on that below. - The
config-definition.xml
file itself is simply a "configuration definition" file as defined by Apache Commons Configuration. See the Configuration File Documentation for more details.
- The locations of the configuration sources can be easily customized by DSpace administrators in a new
- It allows for easy overriding of configuration values from other sources. How the overrides occur is up to how you've configured Apache Commons Configuration. For DSpace, we have a new
config-definition.xml
which defines the following override scheme (again, this can be easily tweaked for local needs):- If a setting is specified in Java System Properties (e.g.
-D[setting]=[value]
), it overrides the same setting found in any below location - If a setting is specified as an Environment Variable, it overrides the same setting found in any below location
- If a setting is specified in the new
local.cfg
configuration file, it overrides the default value in any below location - Default values for all settings are specified in the
dspace.cfg
and themodules/*.cfg
configuration files.
- If a setting is specified in Java System Properties (e.g.
- It supports enhanced Properties files. This means our
dspace.cfg
,local.cfg
and other configuration files can now immediately support some enhanced options, including:- The ability to easily include other configuration files via: "
include=[config-file-location]
" (See the end of the updateddspace.cfg
for examples) - The ability to provide lists of values to "array" configurations by specifying the setting multiple times (rather than creating a giant comma separated configuration spanning multiple lines). For example, enabling both LDAP and Password authentication can now be done via these two lines:
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.authenticate.LDAPAuthentication
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.authenticate.PasswordAuthentication
- For more information see the Commons Config Properties File documentation
- The ability to easily include other configuration files via: "
- More information/ features can also be found in the Apache Commons Configuration v1.10 User Guide
Building / Installing DSpace
With the Enhanced Configuration Scheme, the DSpace build process is slightly changed. The build.properties
file no longer exists and therefore has no effect on the build process.
Here's how the basics of building/installing DSpace:
- Download DSpace (as normal)
cd [dspace-source]
- Create your own initial local.cfg configuration file
cp local.cfg.EXAMPLE local.cfg
- The following fields MUST be specified in your local.cfg in order to install DSpace:
- dspace.dir
- database connection information (db.url, etc.)
- Build/Compile/Install as normal
mvn clean package
ant fresh_install
(orant update
)
- Once DSpace is installed, your local.cfg will be copied over to your
[dspace.dir]/config/
location. At that time you can optionally tweak it further (see local.cfg documentation below)
Note |
---|
Unlike the old |
local.cfg
The local.cfg
file is the new way to customize your DSpace configuration based on your local needs.
There are a few key things to note about this configuration file:
- Any setting in your
local.cfg
will automatically OVERRIDE a setting of the same name in thedspace.cfg
or anymodules/*.cfg
file. This also means that you can copy ANY configuration (fromdspace.cfg
or anymodules/*.cfg
file) into your local.cfg
to specify a new value.- For example, specifying
dspace.url
inlocal.cfg
will override the default value ofdspace.url
indspace.cfg
. - Also, specifying
oai.solr.url
inlocal.cfg
will override the default value ofoai.solr.url
inconfig/modules/oai.cfg
- For example, specifying
- The
local.cfg
file is an Apache Commons Configuration Property file. This means it can also include other config files (via "include=
" statements). For more information see the Commons Config Properties File documentation