DSpace Configuration Key Index

This page is intended to be complete list of configuration keys for the current DSpace
release, in alphabetical order.
These are the keys that may be used in `config/dspace.cfg`.
It was originally compiled for
a different project, but it's posted on the wiki so the greater DSpace community can refer
to it, and correct any errors they find.

Please update this page with any new configuration keys you add, or if you find one we missed.

Note on the format: Any key ending in star (`.`*) is shorthand
for "all keys beginning with this prefix". For example, the key
`plugin.named.*` means, any key that starts with `"plugin.named."`.

 assetstore.dir
 assetstore.dir.*

The first form, `assetstore.dir`, is the pathname of the first directory used by a filesystem-based asset store. You can add more directories (presumably on separate Unix filesystems) with keys such as `assetstore.dir.1`, `assetstore.dir.2`, etc. The first assetstore directory is always 0.

 assetstore.incoming

Specify the number of the store to use for new bitstreams with this property. The default is 0 (zero) which corresponds to the `assetstore.dir` value. A value of 1 corresponds to `assetstore.dir.1`.

 authentication.x509.autoregister

If true, create e-persons for unknown names in valid certificates. Default is `false`.

 authentication.x509.ca.cert

Path of the X.509 certificate identifying the Certifying Authority for acceptable (trusted) client certificates. Default is none.

 authentication.x509.keystore.password

When keystore is used (see below) this is the password togain access to it.

 authentication.x509.keystore.path

Path of the keystore containing X.509 certificate to identify the acceptable (trusted) Certifying Authorities for client certificates.

 crosswalk.mods.properties.*

Path of a crosswalk configuration file for an instance of the configurable MODS dissemination crosswalk, `MODSDisseminationCrosswalk`.The `*` is replaced by the plugin name which is configured, and the value is a pathname, relative to the value of `dspace.dir`. For example, this line configures a plugin named `"MODS"`:

 crosswalk.qdc.properties.*

Path of a crosswalk configuration file for an instance of theconfigurable Qualfied DC dissemination crosswalk, `QDCCrosswalk`.The `*` is replaced by the plugin name which is configured, and the value is a pathname, relative to the value of `dspace.dir`. For example, this line configures a plugin named `"QDC"`:

 crosswalk.qdc.namespace.*

Sets the XML namespace(s) for a configurable XSLT submission plugin. The namespace prefix is part of the configuration key, with the following syntax:

e.g. this defines the `dc` prefix for the `QDC` plugin:

 crosswalk.qdc.schemaLocation.*

Sets the schemaLocation URL for a configurable XSLT submission plugin. Replacethe `*` with the configured plugin name. The value is theexact value of the `schemaLocation` attribute, i.e. a namespace URI, whitespace separator, and the schema URL.

 crosswalk.submission.*

Path of an XSL stylesheet for the XSLT-driven submission crosswalk. The structure of the key is:

where plugin is the plugin-name. The value of the key is a path, which may be written relative to the `dspace.dir` directory.

 dav.access.anonymous

Switch to allow anonymous (un-authenticated) access to the WebDAV interface in the LNI. Default is `false`.

 dav.debug.xml

Switch to enable extra debugging messages showing XML documents sent and received by the WebDAV interface in the LightweightNetworkInterface LNI. They are written to the DSpace log at `DEBUG` priority. Default is `false`. Turning this on can be helpful when you are troubleshooting a new WebDAV client.

 dav.propfind.limit

Imposes an artificial maximum limit on the number of objectstouched by a recursive `PROPFIND` request in the WebDAV interface(LightweightNetworkInterface LNI). Default is no limit. Set this to protect your DSpace server from malicious clients.

 db.driver

Class name of JDBC driver, e.g. `org.postgresql.Driver`.

 db.maxconnections

Maximum number of DB connections in pool.

 db.maxidle

Maximum number of idle connections in pool (-1 = unlimited).

 db.maxwait

Maximum time to wait before giving up if all connections in pool are busy,in milliseconds.

 db.name

Database's generic name or type: must be "oracle", or "postgres".

 db.password

Database password for login.

 db.url

JDBC URL for connecting to the database.

 db.username

Database username for login.

 default.language

Default language for content of submissions. (NOT for UI.)

 dspace.dir

DSpace installation directory.

 dspace.hostname

Fully-qualfied host name of server - should match base URL. Do not include port number

 dspace.name

Human-readable name of the site.

 dspace.url

DSpace base URL. Include port number etc., but NOT trailing slash.Example: `http://dspace.myu.edu:8080/dspace`

 handle.prefix

Handle prefix assigned by CNRI Handle System, or `"123456789"`for a test/development system.

 ldap.email_field

LDAP object field where the user's email address is stored.

 ldap.enable

Switch to activate LDAP authentication module. This is reallyno longer needed with stackable authentication since it can simply be left out of the stack to turn it off, so always set to `true` if you are using LDAP at all.

 ldap.givenname_field

LDAP object field where the user's given names are stored.

 ldap.id_field

This is the unique identifier field in the LDAP directorywhere the username is stored.

 ldap.object_context

Object context used when authenticating theuser. It is appended to the ldap.id_field and username. Must match the LDAP server configuration.

 ldap.phone_field

LDAP object field where the phone number is stored.

 ldap.provider_url

URL to the institution's ldap server.

 ldap.search_context

Search context used when looking up a user's LDAP object to retrieve their data for autoregistering.

 ldap.surname_field

LDAP object field where the user's last name is stored.

 log.dir

 mail.admin

 mail.from.address

 mail.server

 mail.server.password

 mail.server.username

 mets.submission.crosswalk.*

Name of crosswalk plugin to call on for metadata identified bythe name in place of the "*" in the configuration key. For example, `mets.submission.crosswalk.DC = QDC` means when a METS manifestcontaining metadata identified as `"DC"` is ingested, the `QDC` crosswalk plugin gets called to interpret it.

 mets.submission.preserveManifest

Switch controlling whether the METS manifest itself is saved asa bitstream in the `METADATA` bundle. Default is `false`.

 mets.xsd.*

Paths to local XML Schema documents for certain namespaces. Thevalidating parser uses the local versions of the schemas for better speed and reliability. The format of a configuration line is:

e.g.

 oai.didl.maxresponse

 plugin.named.*

Named plugin configuration. See PluginManager page for details.

 plugin.reusable.*

Reusable plugin configuration. See PluginManager page for details.

 plugin.selfnamed.*

Self-named plugin configuration. See PluginManager page for details.

 plugin.sequence.*

Sequence plugin configuration. See PluginManager page for details.

 plugin.single.*

Single plugin configuration. See PluginManager page for details.

 report.dir

Path to directory where statistics reports are written.

 report.public

Switch saying whether statistics reports should be visible to the public.

 search.analyzer

Class name of Lucene analyzer; default is `org.dspace.search.DSAnalyzer`

 search.dir

Path to directory where search index files are written.

 search.index.*

DC metadata elements.qualifiers to be indexed for search. See `config/dspace.cfg` for details.

 search.max-clauses

Higher values of search.max-clauses will enable prefix searches to work onlarge repositories

 search.maxfieldlength

Maximum number of terms indexed for a single field in Lucene.-1 is unlimited.

 search.operator

Boolean operator to use between search terms, `OR` or `AND` (default is `OR`).

 sfx.server.url

SFX query is appended to this URL.If this property is commented out or omitted, SFX support is switched off.

 srb.defaultstorageresource.*
 srb.homedirectory.*
 srb.host.*
 srb.mcatzone.*
 srb.mdasdomainname.*
 srb.parentdir.*
 srb.password.*
 srb.port.*
 srb.username.*

SRB configuration for one SRB instance; replace the `".*"` in keys with a number like `.1`. See `config/dspace.cfg` for details.

 suggest

 upload.max

Maximum size of uploaded files in bytes, negative setting will result in no limit being set

 upload.temp.dir

Path to directory to temporarily store uploaded files.

 webui.browse.index.author

Metadata field name to use for Author browse index, e.g. `dc.contributor.*`.

 webui.browse.index.date

Metadata field name to use for Date browse index, e.g. `dc.date.issued`.

 webui.browse.index.subject

Metadata field name to use for Subject browse index, e.g. `dc.subject.*`.

 webui.browse.index.title

Metadata field name to use for Title browse index, e.g. `dc.title`.

 webui.browse.thumbnail.linkbehaviour

Where should clicking on a thumbnail from browse/search take the user.Only values currently supported are `"item"` and `"bitstream"`.

 webui.browse.thumbnail.maxheight

Maximum dimensions of browse and search thumbnail images.

 webui.browse.thumbnail.maxwidth

Maximum dimensions of browse and search thumbnail images.

 webui.browse.thumbnail.show

Switch to enable displaying thumbnailes in browse and list views.

 webui.controlledvocabulary.enable

Enable or disable the controlled vocabulary add-on.

 webui.feed.cache.age

Number of hours to keep cached syndication feeds before checking currency.

 webui.feed.cache.size

Maximum number of syndication feeds in memory cache.

 webui.feed.enable

Enable syndication feeds - links display on community and collection home page

 webui.feed.formats

Which syndication formats to offer.

 webui.feed.items

Number of DSpace items per feed (the most recent submissions).

 webui.feed.localresolve

Set to `true` to use local server URLs.

 webui.item.thumbnail.show

Switch: whether to display the thumb against each bitstream.

 webui.itemdisplay.*

Specify which collections use which views by (collection) Handle.

 webui.itemlist.columns

Customise the DC fields to use in the item listing page.

 webui.ldap.autoregister

Switch to enable auto-registering users authenticating through LDAP.

 webui.licence_bundle.show

Switch, whether to display the contents of the licence (aka `LICENSE`) bundle in an Item view.

 webui.package.default

Default package format chosen by `DisseminatePackageServlet`,see patch 1442299.

 webui.preview.brand.abbrev

 webui.preview.brand.fontpoint

 webui.preview.brand.font

Font name of brand label font.

 webui.preview.brand.height

 webui.preview.brand

Brand text, e.g. institution name.

 webui.preview.enabled

Switch to enable item preview.

 webui.preview.maxheight

Maximum dimensions of the preview image.

 webui.preview.maxwidth

Maximum dimensions of the preview image.

 webui.strengths.show

Switch, whether to display collection and community strengths.

 webui.submit.blocktheses

Should the submit UI block submissions marked as theses?

 webui.submit.enable-cc

Switch to enable asking for Creative Commons license in submission UI.

 webui.suggest.enable

Show a link to the item recommendation page from item display page?

 webui.suggest.recipient

 webui.suggest.sender