Page History
...
- General Configuration - addresses general conventions used with configuring the
local.cfg
file,dspace.cfg
and other configuration files which use similar conventions. - The local.cfg Configuration Properties FilesFile - describes how to use the
local.cfg
file to store all your locally customized configurations - The dspace.cfg Configuration Properties File - specifies the basic
dspace.cfg
file settings (these settings specify the default configuration for DSpace) Optional or Advanced Configuration Settings - contain other more advanced settings that are optional in the
dspace.cfg
configuration file.
...
[dspace]/config/dspace.cfg
: The primary configuration file, which contains the main configurations for DSpace.[dspace]/config/modules/*.cfg
: Module configuration files, which are specific to various modules/features within DSpace.[dspace]/config/local.cfg
: A (optional, but highly recommended) localized copy of configurations/settings specific to your DSpace (see see The local.cfg documentation Configuration Properties File below)- Additional feature-specific configuration files also exist under
[dspace]/config/
, some of these include:default.license
: the default deposit license used by DSpace during the submission process (see Submission User Interface documentation)hibernate.cfg.xml
: The Hibernate class configuration for the DSpace database (almost never requires changing)input-forms.xml
: The default deposit input forms for DSpace (see Submission User Interface documentation)item-submission.xml
: the default item submission process for DSpace (see Submission User Interface documentation)launcher.xml
: The configuration of the DSpace command-line "launcher" ([dspace]/bin/dspace
, see the DSpace Command Launcher documentation)log4j.properties
: The default logging settings for DSpace log files (usually placed in[dspace]/log
)news-side.html
andnews-top.html
: HTML news configuration files for the JSPUI homepage (see JSPUI Configuration and Customization)news-xmlui.xml
: News configuration file for the XMLUI homepage (see XMLUI Configuration and Customization)workflow.xml
: Configuration for the Configurable Workflow feature (not used by default)xmlui.xconf
: Configuration for the XMLUI (see XMLUI Configuration and Customization)
...
Info | ||
---|---|---|
| ||
As of DSpace 6, the old "
|
Warning | ||
---|---|---|
| ||
If you are upgrading from an earlier version of DSpace, you will need to be aware that many configuration names/keys have changed. Because Apache Commons Configuration allows for auto-overriding of configurations, all configuration names/keys in different In order to create this powerful ability to override configurations in your Additionally, while the This means that DSpace 5.x (or below) configurations are NOT guarranteed guaranteed compatible with DSpace 6. While you obviously can use your old configurations as a reference, you will need to start with fresh copy of all configuration files, and reapply any necessary configuration changes (this has always been the recommended procedure). However, as you'll see below, you'll likely want to do that anyways in order to take full advantage of the new |
...
A example [dspace-source]/
is provided wtih with DSpace. The example only provides a few key configurations which most DSpace sites are likely to need to customize. However, you may add (or remove) any other configuration to your dspace/config/
local.cfg.EXAMPLElocal.cfg
to customize it as you see fit.
To get started, simply create your own [dspace-source]/dspace/config/local.cfg
based on the example, e.g.
Code Block |
---|
cd [dspace-source]/dspace/config/
cp local.cfg.EXAMPLE local.cfg |
You can then begin to edit your local.cfg
with your local settings for DSpace. There are a few key things to note about the local.cfg
file:
- Override any default configurations: 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
- Configuration Syntax: The
local.cfg
file uses the Apache Commons Configuration Property file syntax (like all *.cfg files) . For more information see the section on Configuration File Syntax above.- This means the
local.cfg
also supports enhanced features like the ability to include other config files (via "include=
" statements).
- This means the
- Override local.cfg via System Properties: As needed, you also are able to OVERRIDE settings in your
local.cfg
by specifying them as System Properties or Environment Variables.- For example, if you wanted to change your
dspace.dir
in development/staging environment, you could specify it as a System Property (e.g.-Ddspace.dir=[new-location]
). This new value will override any value in bothlocal.cfg
anddspace.cfg
.
- For example, if you wanted to change your
...
Here's a very basic example of settings you could place into your local.cfg
file (with inline comments):
...