Page History
...
- Configuration File Syntax/Sources: All DSpace configurations are loaded via Properties files (using the Configuration File Syntax detailed above)
- Note: Apache Commons Configuration does support other configuration sources such as XML configurations or database configurations (see its Overview documentation). At this time, DSpace does not utilize these other sorts of configurations by default. However, it would be possible to customize your local config-definition.xml to load settings from other locations.
- Configuration Files/Sources: By default, only two configuration files are loaded into Apache Commons Configuration for DSpace:
local.cfg
(see The local.cfg Configuration Properties File documentation below)dspace.cfg
(NOTE: allmodules/*.cfg
are loaded bydspace.cfg
via "include=
" statements at the end of that configuration file. They are essentially treated as sub-configs which are embedded/included into thedspace.cfg
)
- Configuration Override Scheme: The configuration override scheme is defined as follows. Configurations specified in earlier locations will automatically override any later values:
- System Properties (
-D[setting]=[value]
) override all other options - Environment Variables.
- DSpace provides a custom environment variable syntax as follows:
- All periods (.) in configuration names must be translated to "__P__" (two underscores, capital P, two underscores), e.g. "dspace__P__dir" environment variable will override the "dspace.dir" configuration in local.cfg (or other *.cfg files)
- All dashes (-) in configuration names must be translated to "__D__" (two underscores, capital D, two underscores), e.g. "authentication__D__ip__P__groupname" environment variable will override the "authentication-ip.groupname" configuration in local.cfg (or other *.cfg files)
- DSpace provides a custom environment variable syntax as follows:
local.cfg
dspace.cfg
(and allmodules/*.cfg
files) contain the default values for all settings.
- System Properties (
- Configuration Auto-Reload: By default, all configuration files are automatically checked every 5 seconds for changes. If they have changed, they are automatically reloaded.
...
Many of the database configurations are software-dependent. That is, it will be based on the choice of database software being used. Currently, DSpace properly supports PostgreSQL and Oracle.
Note | ||
---|---|---|
| ||
Oracle support has been deprecated in DSpace. It will no longer be supported as of June/July 2023. See https://github.com/DSpace/DSpace/issues/8214 We recommend all users install DSpace on PostrgreSQL (see above) |
Property: |
|
Example Value: |
|
Property: |
|
Example Value: |
|
Informational Note: | The above value is the default value when configuring with PostgreSQL. When using Oracle, use this value: |
Property: |
|
Example Value: |
|
Informational Note: | In the installation directions, the administrator is instructed to create the user "dspace" who will own the database "dspace". |
Property: |
|
Example Value: |
|
Informational Note: | This is the password that was prompted during the installation process (cf. 3.2.3. Installation) |
Property: |
|
Example Value: |
|
Informational Note: | If your database contains multiple schemas, you can avoid problems with retrieving the definitions of duplicate objects by specifying the schema name here that is used for DSpace by uncommenting the entry. This property is optional. For PostgreSQL databases, this is often best set to "public" (default schema). For Oracle databases, the schema is usually equivalent to the username of your database account. So, for Oracle, this may be set to |
Property: |
|
Example Value: |
|
Informational Note: | Maximum number of Database connections in the connection pool |
Property: |
|
Example Value: |
|
Informational Note: | Maximum time to wait before giving up if all connections in pool are busy (in milliseconds). |
Property: |
|
Example Value: |
|
Informational Note: | Maximum number of idle connections in pool. (-1 = unlimited) |
Property: |
|
Example Value: |
|
Informational Note: | This is a developer-based setting which determines whether you are allowed to run "./dspace database clean" to completely delete all content and tables in your database. This should always be set to "true" in Production to protect against accidentally deleting all your content by running that command. (Default is set to true) |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | The address on which your outgoing SMTP email server can be reached. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | SMTP mail server authentication username, if required. This property is optional. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | SMTP mail server authentication password, if required. This property is optional. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | The port on which your SMTP mail server can be reached. By default, port 25 is used. Change this setting if your SMTP mailserver is running on another port. This property is optional. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | The "From" address for email. Change the 'myu.edu' to the site's host name. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | When a user clicks on the feedback link/feature, the information will be sent to the email address of choice. This configuration is currently limited to only one recipient. This is also the email address displayed on the contacts page. | ||
Property: |
| ||
Example Value: |
| ||
Example Value: | Email address of the general site administrator (Webmaster). System notifications/reports and other sysadmin emails are sent to this email address. | ||
Property: | mail.admin.name | ||
Example Value: | mail.admin.name = DSpace Administrator | ||
Example Value: | Name associated with the mail.admin email address. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Enter the recipient for server errors and alerts. This property is optional and defaults to the | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Enter the recipient that will be notified when a new user registers on DSpace. This property is optional & defaults to no value. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Set the default mail character set. This may be over-ridden by providing a line inside the email template '#set($charset = "encoding")'. Otherwise this default is used. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | A comma separated list of hostnames that are allowed to refer browsers to email forms. This property is optional. UNSUPPORTED in DSpace 7.0 | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | If you need to pass extra settings to the Java mail library. Comma separated, equals sign between the key and the value. This property is optional. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | An option is added to disable the mailserver. By default, this property is set to ' | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specifies the name of a javax.mail.Session object stored in JNDI under | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | If no other language is explicitly stated in the submission-forms.xml, the default language will be attributed to the metadata values. See also Multilingual Support | ||
Property: | mail.message.headers | ||
Example Value: |
| ||
Informational Note: | When processing a message template, setting a Velocity variable whose name is one of the values of this configuration property will add or replace a message header of the same name, using the value of the variable as the header's value. See "Templates can set message headers". | ||
Property: | mail.welcome.enabled | ||
Example Value: | mail.welcome.enabled = true | ||
Informational Note: | Enable a "welcome letter" to the newly-registered user. By default this is false . See the welcome email template. |
...
Informations from the script will be printed to stderr while the XML output of the dissemination crosswalk will be printed to stdout. You can give a third parameter containing a filename to write the output into a file, but be careful: the file will be overwritten if it exists. When you are working on XSLTCrosswalks it is very helpful to get the original XML on which the XSLT processor works. Use the crosswalk dim to get the original XML:
Code Block | ||
---|---|---|
| ||
[dspace]/bin/dspace dsrun org.dspace.content.crosswalk.XSLTDisseminationCrosswalk dim 123456789/3 |
Testing a submission crosswalk works quite the same way. Use the following command-line utility, it calls the crosswalk plugin to translate an XML document you submit, and displays the resulting intermediate XML (DIM). Invoke it with:
...
Property: |
|
Example Value: |
|
Informational Note: | For backwards compatibility, the subscription emails by default include any modified items. The property key is COMMENTED OUT by default. |
Hiding Metadata
It is now possible to hide metadata from public consumption, so that is it's only available to users with WRITE permissions on the Administrator.Item. (NOTE: Prior to 7.6.1, Administrator privileges were required for hidden metadata. This was modified to allow users to submit hidden metadata fields, as well as allow Community/Collection Admins to see hidden metadata.)
Property: |
| Property: |
|
Example Value: |
| ||
Informational Note: | Hides the metadata in the property key above except to the administrator. Fields named here are hidden in the following places UNLESS the logged-in user is an Administratorhas WRITE permissions on the Item:
To designate a field as hidden, add a property here in the form: |
...
Property: |
|
Example Value: |
|
Informational Note: | Sets whether to display the contents of the license bundle (often just the deposit license in the standard DSpace installation). UNSUPPORTED in DSpace 7.0 |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width for the preview image. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height for the preview image. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | This is the brand text that will appear with the image. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | The height (in px) of the brand. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font for your Brand text that appears with the image. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font point (size) for your Brand text that appears with the image. Only used for BrandedPreviewJPEGFilter |
Property: |
|
Example Value: |
|
Informational Note: | The Dublin Core field that will display along with the preview. This field is optional. Only used for BrandedPreviewJPEGFilter |
Item Counts in user interface
Info |
---|
Available in 7.6 or later |
Optionally, you can enable item counts to be displayed in the user interface for every Community and Collection. This uses the same configuration that was in place for DSpace 6 and earlier.
Property: |
|
Example Value: |
|
Informational Note: | When showing the strengths (i.e. item counts), should they "true" this will display the count of archived items (in the User Interface's browse screens). By default this is "false" (disabled). When enabled, the counts may be counted in real time, or fetched from the cache (see next option). |
Property: |
|
Example Value: |
|
Informational Note: | When showing the strengths (i.e. item counts), should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count . Counts fetched in real time will perform an actual count of the index contents every time a page with this feature is requested, which may not scale. If you set the property key is set to cache ("true"), the counts will be cached on first load. UNSUPPORTED in DSpace 7.0 |
Browse Index Configuration
...
Property: |
|
Example Value: |
|
Informational Note: | This is an example of how one "Defines the Indexes". See "Defining the Indexes" in the next sub-section. |
Property: |
|
Example Value: |
|
Informational Note: | This is an example of how one "Defines the Sort Options". See "Defining Sort Options" in the following sub-section. |
...
Code Block |
---|
webui.browse.index.1 = dateissued:item:dateissued
webui.browse.index.2 = author:metadata:dc.contributor.*\,dc.creator:text
webui.browse.index.3 = title:item:title
webui.browse.index.4 = subject:metadata:dc.subject.*:text
#webui.browse.index.5 = dateaccessioned:item:dateaccessioned |
...
Element | Definition and Options (if available) |
---|---|
| n is the index number. The index numbers must start from 1 and increment continuously by 1 thereafter. Deviation from this will cause an error during install or a configuration update. So anytime you add a new browse index, remember to increase the number. (Commented out index numbers may be used over again). |
| The name by which the index will be identified. In order for the DSpace UI to display human-friendly description for this index, you'll need to update the UI's language packs (e.g.
|
| Only two options are available: "
|
| (Only for "metadata" indexes) The schema used for the field to be index. First part of a metadata field name. The default is dc (for Dublin Core). |
| (Only for "metadata" indexes) The schema element. Second part of a metadata field name. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A. |
| (Only for "metadata" indexes) This is the qualifier to the <element> component. Third part of a metadata field name. The user has two choices: an asterisk "*" or a proper qualifier of the element. The asterisk is a wildcard and causes DSpace to index all types of the schema element. For example, if you have the element "contributor" and the qualifier "*" then you would index all contributor data regardless of the qualifier. Another example, you have the element "subject" and the qualifier "lcsh" would cause the indexing of only those fields that have the qualifier "lcsh". (This means you would only index Library of Congress Subject Headings and not all data elements that are subjects.) |
| (Optional, should be set for "item" indexes) This refers to the sort type / data type of the field:
|
| (Optional) The default sort order. Choose |
...
Element | Definition and Options (if available) |
---|---|
| n is an arbitrary number you choose. |
| The name by which the sort option will be identified. This is the name by which it is referred in the "webui.browse.index" settings (see Defining the Indexes). |
| The schema used for the field to be sorted on in the index. The default is dc (for Dublin Core). |
| The schema element. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A. |
| This is the qualifier to the <element> component. The user has two choices: an asterisk "*" or a proper qualifier of the element. |
| This refers to the datatype of the field: |
...
Hierarchical Browse
...
Indexes
No configuration is necessary for hierarchical browse indexes (Browse by Subject Category). These are automatically generated based on the used controlled vocabularies in your submission forms. Default DSpace has one hierarchical browse index (Browse by Subject Category), since "srsc" is the only vocabulary used in the default submission-forms.xml.
Please note that when using another vocabulary, the UI's language packs (e.g. src/assets/i18n/en.json5) will need to be updated as well, e.g.:
"menu.section.browse_global_by_srsc": "By Subject Category"
"browse.metadata.srsc.breadcrumbs": "Browse by Subject Category"
"browse.comcol.by.srsc": "By Subject Category"
Starting with DSpace 7.6.1, these Hierarchical "Browse By" options can be disabled via the below configuration:
Property: | webui.browse.vocabularies.disabled |
Example Value: | webui.browse.vocabularies.disabled = srsc |
Informational Note: | By default, all controlled vocabularies used within your submission forms (submission-forms.xml) will be enabled in the Browse By menu of the User Interface. If you wish to disable any from display in the UI, you can list them in this configuration. Multiple values can be comma separated (or this config can be repeated). Changes to this configuration will not take effect until your servlet engine (e.g. Tomcat) is restarted. |
Other Browse Options
We set other browse values in the following section.
Property: | webui.browse.metadata.show-freq. |
Example Value: | webui.browse. |
We set other browse values in the following section.
Property: | webui.browse.metadata.show-freq. | ||
Example Value: | webui.browse.metadata.show-freq.1 = false | ||
Informational Note: | This enable/disable the show of frequencies (count) in metadata browse <n> refers to the browse configuration. As default frequencies are shown for all metadata browse | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This sets the option for how the indexes are sorted. All sort normalizations are carried out by the OrderFormatDelegate. The plugin manager can be used to specify your own delegates for each datatype. The default datatypes (and delegates) are:
If you redefine a default datatype here, the configuration will be used in preferences to the default. However, if you do not explicitly redefine a datatype, then the default will still be used in addition to the datatypes you do specify. As of DSpace release 1.5.2, the multi-lingual MARC21 title ordering is configured as default, as shown in the example above. To use the previous title ordering (before release 1.5.2), comment out the configuration in your dspace.cfg file. |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | By default, OpenSearch & Syndication feeds are set to true (on) . Change key to "false" to disable. NOTE this setting affects OpenSearch Support as well | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | By default, (set to false), URLs returned by the feed will point at the global handle resolver (e.g. http://hdl.handle.net/123456789/1). If set to true the local server URLs are used (e.g. http://myserver.myorg/handle/123456789/1). | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property customizes each single-value field displayed in the feed information for each item. Each of the fields takes a single metadata field. The form of the key is <scheme prefix>.<element>.<qualifier> In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property customizes each single-value field displayed in the feed information for each item. Each of the fields takes a single metadata field. The form of the key is <scheme prefix>.<element>.<qualifier> In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | One can customize the metadata fields to show in the feed for each item's description. Elements are displayed in the order they are specified in dspace.cfg.Like other property keys, the format of this property key is: webui.feed.item.description = <scheme prefix>.<element>.<qualifier>. In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | The name of field to use for authors (Atom only); repeatable. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Customize the image icon included with the site-wide feeds. This must be an absolute URL. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property enables Podcast Support on the RSS feed for the specified collection handles. The podcast is iTunes compatible and will expose the bitstreams in the items for viewing and download by the podcast reader. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property enables Podcast Support on the RSS feed for the specified community handles. The podcast is iTunes compatible and will expose the bitstreams in the items for viewing and download by the podcast reader. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property for Podcast Support, allows you to choose which MIME types of bitstreams are to be enclosed in the podcast feed. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This optional property for the Podcast Support will allow you to use a value for a metadata field as a replacement for actual bitstreams to be enclosed in the RSS feed. A use case for specifying the external sourceuri would be if you have a non-DSpace media streaming server that has a copy of your media file that you would prefer to have the media streamed from. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds |
OpenSearch Support
OpenSearch is a small set of conventions and documents for describing and using "search engines", meaning any service that returns a set of results for a query. See extensive description in the Business Layer section of the documentation.
Please note that RSS/Atom feeds require that OpenSearch is enabled to function.
...
Property: |
|
Example Value: |
|
Informational Note: | Whether or not OpenSearch is enabled. By default, the feature is enabled to support RSS/Atom feeds. Change to "false" to disable. |
Property: | websvc.opensearch.svccontext |
Example Value: | websvc.opensearch.svccontext = opensearchsearch |
Informational Note: | The URL path where OpenSearch is made available on the backend. For example, "opensearchsearch" means it is available at ${dspace.server.url}/opensearchsearch |
Property: |
|
Example Value: |
|
Informational Note: | Context for HTML request URLs. Change only for non-standard servlet mapping. |
Property: |
|
Example Value: |
|
Informational Note: | Present autodiscovery link in every page head. |
Property: |
|
Example Value: |
|
Informational Note: | Number of hours to retain results before recalculating. This applies to the Manakin interface only. |
Property: |
|
Example Value: |
|
Informational Note: | A short name used in browsers for search service. It should be sixteen (16) or fewer characters. |
Property: |
|
Example Value: |
|
Informational Note: | A longer name up to 48 characters. |
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: | Location of favicon for service, if any. They must by 16 x 16 pixels. You can provide your own local favicon instead of the default. |
Property: |
|
Example Value: |
|
Informational Note: | Sample query. This should return results. You can replace the sample query with search terms that should actually yield results in your repository. |
Property: |
|
Example Value: |
|
Informational Note: | Tags used to describe search service. |
Property: |
|
Example Value: |
|
Informational Note: | Result formats offered. Use one or more comma-separated from the list: html, atom, rss. Please note that html is required for auto discovery in browsers to function, and must be the first in the list if present. |
Content Inline Disposition Threshold / Format
The following configuration is configurations may be used to change the disposition behavior of the browser. That is, when the browser will attempt to open the file or download it to the user-specified location. For example, the default size is 8MB. When an item This allows you to specify when a file (bitstream) in DSpace should be downloaded, or attempt to be opened in a user's browser.
Property: |
|
Example value: |
|
Informational Note: | The default filesize is set to 8MB. When a file/bitstream being viewed is larger than 8MB, the user's browser will download the file to |
...
their local machine and the user will have to open it manually. All files smaller than this threshold will be sent "inline" to the user's browser, allowing the browser to decide whether to open it within the browser or download it. The value provided is always in bytes. For example: 4 MB = 4194304, 8 MB = 8388608, 16 MB = 16777216 NOTE: This threshold is only applied if the file/bitstream does NOT match the below "webui.content_disposition_format" list. | |
Property: |
|
Example value: |
|
Informational Note: | The default value is set to 8MB. This property key applies to the REST API. |
...
Set which file mimetypes or file extensions will be forced to download, regardless of the "threshold" set above. Multiple values may be provided by setting this property several times, or by passing it a comma-separated list. For example, setting this to "text/html, text/richtext" will ensure that all files/bitstreams matching those MIME Types will always be downloaded (and never open inline in the user's browser). File extensions may also be used to reference formats. For example, setting "pdf, xls" will ensure all files ending in ".pdf" or ".xls" will always be downloaded. |
Multi-file HTML Document/Site Settings
...