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."`.
Code Block |
---|
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.
Code Block |
---|
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`.
Code Block |
---|
authentication.x509.autoregister
|
If true, create e-persons for unknown names in valid certificates. Default is `false`.
Code Block |
---|
authentication.x509.ca.cert
|
Path of the X.509 certificate identifying the Certifying Authority for acceptable (trusted) client certificates. Default is none.
Code Block |
---|
authentication.x509.keystore.password
|
When keystore is used (see below) this is the password togain access to it.
Code Block |
---|
authentication.x509.keystore.path
|
Path of the keystore containing X.509 certificate to identify the acceptable (trusted) Certifying Authorities for client certificates.
Code Block |
---|
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"`:
Panel |
---|
`crosswalk.mods.properties.MODS = crosswalks/mods.props` |
Code Block |
---|
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"`:
Panel |
---|
`crosswalk.qdc.properties.QDC = crosswalks/qdc.props` |
Code Block |
---|
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:
Panel |
---|
`crosswalk.qdc.namespace.`plugin`.`prefix` = `namespace-URI |
e.g. this defines the `dc` prefix for the `QDC` plugin:
Code Block |
---|
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.
Code Block |
---|
crosswalk.submission.*
|
Path of an XSL stylesheet for the XSLT-driven submission crosswalk. The structure of the key is:
Panel |
---|
`crosswalk.submission.`plugin`.stylesheet` |
where plugin is the plugin-name. The value of the key is a path, which may be written relative to the `dspace.dir` directory.
Code Block |
---|
dav.access.anonymous
|
Switch to allow anonymous (un-authenticated) access to the WebDAV interface in the LNI. Default is `false`.
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.
Code Block |
---|
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.
Class name of JDBC driver, e.g. `org.postgresql.Driver`.
Code Block |
---|
db.maxconnections
|
Maximum number of DB connections in pool.
Maximum number of idle connections in pool (-1 = unlimited).
Maximum time to wait before giving up if all connections in pool are busy,in milliseconds.
Database's generic name or type: must be "oracle", or "postgres".
Database password for login.
JDBC URL for connecting to the database.
Database username for login.
Code Block |
---|
default.language
|
Default language for content of submissions. (NOT for UI.)
DSpace installation directory.
Code Block |
---|
dspace.hostname
|
Fully-qualfied host name of server - should match base URL. Do not include port number
Human-readable name of the site.
DSpace base URL. Include port number etc., but NOT trailing slash.Example: `http://dspace.myu.edu:8080/dspace`
Handle prefix assigned by CNRI Handle System, or `"123456789"`for a test/development system.
Code Block |
---|
ldap.email_field
|
LDAP object field where the user's email address is stored.
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.
Code Block |
---|
ldap.givenname_field
|
LDAP object field where the user's given names are stored.
This is the unique identifier field in the LDAP directorywhere the username is stored.
Code Block |
---|
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.
Code Block |
---|
ldap.phone_field
|
LDAP object field where the phone number is stored.
Code Block |
---|
ldap.provider_url
|
URL to the institution's ldap server.
Code Block |
---|
ldap.search_context
|
Search context used when looking up a user's LDAP object to retrieve their data for autoregistering.
Code Block |
---|
ldap.surname_field
|
LDAP object field where the user's last name is stored.
Panel |
---|
Path of directory for writing DSpace log files. |
Panel |
---|
General site administration (Webmaster) e-mail address. |
Code Block |
---|
mail.from.address
|
Panel |
---|
Email address that mail DSpace sends should appear to come from. |
Panel |
---|
Hostname of SMTP mail server. |
Code Block |
---|
mail.server.password
|
Panel |
---|
SMTP mail server authentication password. (Default: none) |
Code Block |
---|
mail.server.username
|
Panel |
---|
SMTP mail server authentication username. (Default: none) |
Code Block |
---|
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.
Code Block |
---|
mets.submission.preserveManifest
|
Switch controlling whether the METS manifest itself is saved asa bitstream in the `METADATA` bundle. Default is `false`.
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:
Panel |
---|
`mets.xsd.`prefix` = `namespace XSD-path |
e.g.
Panel |
---|
`mets.xsd.dc = http://purl.org/dc/elements/1.1/ dc.xsd`The prefix is added mainly to keep configuration keys unique.The path is relative to the DSpace installation directory orits `schemas` subdirectory (both are tried). |
Code Block |
---|
oai.didl.maxresponse
|
Code Block |
---|
plugin.named.*
|
Named plugin configuration. See PluginManager page for details.
Code Block |
---|
plugin.reusable.*
|
Reusable plugin configuration. See PluginManager page for details.
Code Block |
---|
plugin.selfnamed.*
|
Self-named plugin configuration. See PluginManager page for details.
Code Block |
---|
plugin.sequence.*
|
Sequence plugin configuration. See PluginManager page for details.
Code Block |
---|
plugin.single.*
|
Single plugin configuration. See PluginManager page for details.
Path to directory where statistics reports are written.
Switch saying whether statistics reports should be visible to the public.
Code Block |
---|
search.analyzer
|
Class name of Lucene analyzer; default is `org.dspace.search.DSAnalyzer`
Path to directory where search index files are written.
Code Block |
---|
search.index.*
|
DC metadata elements.qualifiers to be indexed for search. See `config/dspace.cfg` for details.
Code Block |
---|
search.max-clauses
|
Higher values of search.max-clauses will enable prefix searches to work onlarge repositories
Code Block |
---|
search.maxfieldlength
|
Maximum number of terms indexed for a single field in Lucene.-1 is unlimited.
Code Block |
---|
search.operator
|
Boolean operator to use between search terms, `OR` or `AND` (default is `OR`).
Code Block |
---|
sfx.server.url
|
SFX query is appended to this URL.If this property is commented out or omitted, SFX support is switched off.
Code Block |
---|
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.
Maximum size of uploaded files in bytes, negative setting will result in no limit being set
Code Block |
---|
upload.temp.dir
|
Path to directory to temporarily store uploaded files.
Code Block |
---|
webui.browse.index.author
|
Metadata field name to use for Author browse index, e.g. `dc.contributor.*`.
Code Block |
---|
webui.browse.index.date
|
Metadata field name to use for Date browse index, e.g. `dc.date.issued`.
Code Block |
---|
webui.browse.index.subject
|
Metadata field name to use for Subject browse index, e.g. `dc.subject.*`.
Code Block |
---|
webui.browse.index.title
|
Metadata field name to use for Title browse index, e.g. `dc.title`.
Code Block |
---|
webui.browse.thumbnail.linkbehaviour
|
Where should clicking on a thumbnail from browse/search take the user.Only values currently supported are `"item"` and `"bitstream"`.
Code Block |
---|
webui.browse.thumbnail.maxheight
|
Maximum dimensions of browse and search thumbnail images.
Code Block |
---|
webui.browse.thumbnail.maxwidth
|
Maximum dimensions of browse and search thumbnail images.
Code Block |
---|
webui.browse.thumbnail.show
|
Switch to enable displaying thumbnailes in browse and list views.
Code Block |
---|
webui.controlledvocabulary.enable
|
Enable or disable the controlled vocabulary add-on.
Code Block |
---|
webui.feed.cache.age
|
Number of hours to keep cached syndication feeds before checking currency.
Code Block |
---|
webui.feed.cache.size
|
Maximum number of syndication feeds in memory cache.
Code Block |
---|
webui.feed.enable
|
Enable syndication feeds - links display on community and collection home page
Code Block |
---|
webui.feed.formats
|
Which syndication formats to offer.
Code Block |
---|
webui.feed.items
|
Number of DSpace items per feed (the most recent submissions).
Code Block |
---|
webui.feed.localresolve
|
Set to `true` to use local server URLs.
Code Block |
---|
webui.item.thumbnail.show
|
Switch: whether to display the thumb against each bitstream.
Code Block |
---|
webui.itemdisplay.*
|
Specify which collections use which views by (collection) Handle.
Code Block |
---|
webui.itemlist.columns
|
Customise the DC fields to use in the item listing page.
Code Block |
---|
webui.ldap.autoregister
|
Switch to enable auto-registering users authenticating through LDAP.
Code Block |
---|
webui.licence_bundle.show
|
Switch, whether to display the contents of the licence (aka `LICENSE`) bundle in an Item view.
Code Block |
---|
webui.package.default
|
Default package format chosen by `DisseminatePackageServlet`,see patch 1442299.
Code Block |
---|
webui.preview.brand.abbrev
|
Panel |
---|
Abbreviated form of the `webui.preview.brand` text, this will be used when the preview image cannot fit the normal text. |
Code Block |
---|
webui.preview.brand.fontpoint
|
Panel |
---|
Point size of brand label font. |
Code Block |
---|
webui.preview.brand.font
|
Font name of brand label font.
Code Block |
---|
webui.preview.brand.height
|
Panel |
---|
Height in pixels of the brand. |
Code Block |
---|
webui.preview.brand
|
Brand text, e.g. institution name.
Code Block |
---|
webui.preview.enabled
|
Switch to enable item preview.
Code Block |
---|
webui.preview.maxheight
|
Maximum dimensions of the preview image.
Code Block |
---|
webui.preview.maxwidth
|
Maximum dimensions of the preview image.
Code Block |
---|
webui.strengths.show
|
Switch, whether to display collection and community strengths.
Code Block |
---|
webui.submit.blocktheses
|
Should the submit UI block submissions marked as theses?
Code Block |
---|
webui.submit.enable-cc
|
Switch to enable asking for Creative Commons license in submission UI.
Code Block |
---|
webui.suggest.enable
|
Show a link to the item recommendation page from item display page?
Code Block |
---|
webui.suggest.recipient
|
Panel |
---|
Default name of recipient - replaced by user input if present. |
Code Block |
---|
webui.suggest.sender
|
Panel |
---|
Default name of recommender - replaced by user input if present. |