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.
...
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 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 |
...
Property: |
|
Example Value: |
|
Informational Note: | Root directory of DSpace installation. Omit the trailing slash '/'. Note that this setting is used by default in other settings, e.g. (On Windows be sure to use forward slashes for the directory path! For example: "C:/dspace" is a valid path for Window.) |
Property: |
|
Example Value: | |
Informational Note: | Main URL at which DSpace backend ("server" webapp) is publicly available. If using port 80 (HTTP) or 443 (HTTPS), you may omit the port number. Otherwise the port number must be included. Do not include a trailing slash (' |
Property: |
|
Example Value: |
|
Informational note | Main URL at which the DSpace frontend (Angular User Interface) is publicly available. If using port 80 (HTTP) or 443 (HTTPS), you may omit the port number. Otherwise the port number must be included. Do not include a trailing slash (' This URL should obviously be the same one configured in your Angular UI's environment.prod.tsmatch the URL you type in the browser to access your User Interface. In the backend, this URL is primarily used to build UI-based URLs in sitemaps, email messages, etc. Therefore, it need not be set on initial installation, but it should be configured as soon as your user interface is installed. If you are not using the DSpace UI (and running the backend "headless"), this may be set to the URL of whatever you consider your primary "user interface". |
Property: |
|
Example Value: |
|
Informational Note: | Short and sweet site name, used in e-mails, exports and machine interfaces (e.g. OAI-PMH). It is not currently used by the Angular UI. |
...
General Solr Configuration
DSpace uses Solr for various indexing purposes, and uses a pool of open connections to manage communication with Solr. These properties configure the connections between DSpace and Solr.
See also the additional Solr configuration properties for specific indexes such as search, statistics, authority and OAI PMHMany 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.
Property: | dbsolr. | urlserver |
Example Value: | dbsolr. url server = jdbchttp: postgresql://localhost: 54328983/ dspacesolr | |
Informational Note:The | above value is the default value when configuring with PostgreSQL. When using Oracle, use this value: jbdc.oracle.thin:@//host:port/dspace Base URL to the Solr server. Specific indexes append to this value. | |
Property: | db
| username
|
Example Value: |
| |
Informational Note: | In the installation directions, the administrator is instructed to create the user "dspace" who will own the database "dspace"The maximum number of connections that will be opened between DSpace and Solr. | |
Property: | dbsolr.client. | passwordmaxPerRoute |
Example Value: | dbsolr.client. password maxPerRoute = dspacepassword15 | |
Informational Note: | This is the password that was prompted during the installation process (cf. 3.2.3. Installation)The maximum number of connections that will be opened between DSpace and a specific Solr instance (if you have more than one). | |
Property: | dbsolr.client. | schemakeepAlive |
Example Value: | dbsolr.client. schema keepAlive = public5000 | |
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${db.username} in most scenarios. | The default amount of time that a connection in use will be held open, in milliseconds. Solr may specify a different keep-alive interval and it will be obeyed. | |
Property: | solr.client.timeToLive | |
Example Value: | solr.client.timeToLive = 600 | |
Informational Note: | The maximum amount of time before an open connection will be closed when idle, in seconds. New connections will be opened as needed, subject to the above limits. |
DSpace Database Configuration
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: |
|
Informational Note:Maximum number of Database connections in the connection pool | The above value is the default value when configuring with PostgreSQL. When using Oracle, use this value: |
Property: |
|
Example Value: |
|
Informational Note:Maximum | time to wait before giving up if all connections in pool are busy (in milliseconds)In the installation directions, the administrator is instructed to create the user "dspace" who will own the database "dspace". |
Property: |
|
Example Value: |
|
Informational Note: | Maximum number of idle connections in pool. (-1 = unlimitedThis is the password that was prompted during the installation process (cf. 3.2.3. Installation) |
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) |
To provide the database connection pool externally
Alternately, you may supply a configured connection pool out of JNDI. The object must be named jdbc/dspace
(the full path is java:comp/env/jdbc/dspace
). DSpace will always look up this name and, if found, will use the returned object as its database connection pool. If not found, the above db.*
properties will be used to create the pool.
If you are using Tomcat, then the object might be defined using a <Resource>
element, or connected to a <Resource>
child of <GlobalNamingResources>
using a <ResourceLink>
element. See your Servlet container's documentation for details of configuring the JNDI initial context.
Earlier releases of DSpace provided a configuration property db.jndi
to specify the name to be looked up, but that has been removed. The name is specified in config/spring/api/core-hibernate.xml
if you really need to change it.
DSpace Email Settings
The configuration of email is simple and provides a mechanism to alert the person(s) responsible for different features of the DSpace software.
DSpace will look up a javax.mail.Session object in JNDI and, if found, will use that to send email. Otherwise it will create a Session using some of the properties detailed below.
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) |
To provide the database connection pool externally
Alternately, you may supply a configured connection pool out of JNDI. The object must be named jdbc/dspace
(the full path is java:comp/env/jdbc/dspace
). DSpace will always look up this name and, if found, will use the returned object as its database connection pool. If not found, the above db.*
properties will be used to create the pool.
If you are using Tomcat, then the object might be defined using a <Resource>
element, or connected to a <Resource>
child of <GlobalNamingResources>
using a <ResourceLink>
element. See your Servlet container's documentation for details of configuring the JNDI initial context. For example, Tomcat provides a useful JNDI Datasource How-to
Earlier releases of DSpace provided a configuration property db.jndi
to specify the name to be looked up, but that has been removed. The name is specified in config/spring/api/core-hibernate.xml
if you really need to change it.
DSpace Email Settings
The configuration of email is simple and provides a mechanism to alert the person(s) responsible for different features of the DSpace software.
DSpace will look up a javax.mail.Session object in JNDI and, if found, will use that to send email. Otherwise it will create a Session using some of the properties detailed below.
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. | ||
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: |
Code Block |
---|
mail.extraproperties = mail.smtp.socketFactory.port=465, \
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory, \
mail.smtp.socketFactory.fallback=false |
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:
mail.server.disabled
Example Value:
mail.server.disabled = false
Informational Note:
An option is added to disable the mailserver. By default, this property is set to 'false
'. By setting value to 'true
', DSpace will not send out emails. It will instead log the subject of the email which should have been sent. This is especially useful for development and test environments where production data is used when testing functionality. This property is optional.
Property:
mail.session.name
mail.session.name = myDSpace
Informational Note:
Specifies the name of a javax.mail.Session object stored in JNDI under java:comp/env/mail
. The default value is "Session".
Property:
default.language
Example Value:
default.language = en_US
Informational Note:
If no other language is explicitly stated in the submission-forms.xml, the default language will be attributed to the metadata values.
mail.message.headers = subject
mail.message.headers = charset
Wording of E-mail Messages
...
The CNRI Handle system is a 3rd party service for maintaining persistent URL's. For a nominal fee, you can register a handle prefix for your repository. As a result, your repository items will be also available under the links http://handle.net/<<handle prefix>>/<<item id>>. As the base url of your repository might change or evolve, the persistent handle.net URL's secure the consistency of links to your repository items. For complete information regarding the Handle server, the user should consult The Handle Server section of Installing DSpace Handle.Net Registry Support.
Property: |
|
Example Value |
|
Informational Note: | Canonical Handle URL prefix. By default, DSpace is configured to use http://hdl.handle.net/ as the canonical URL prefix when generating |
Property: |
|
Example Value |
|
Informational Note: | The default installed by DSpace is |
Property: |
|
Example Value: |
|
Informational Note: | The default files, as shown in the Example Value is where DSpace will install the files used for the Handle Server. |
Property | handle.additional.prefixes |
Example Value | handle.additional.prefixes = 1234.56789.0, 1234.56789.1, 987 |
Informational Note: | List any additional prefixes that need to be managed by this handle server. For example, any handle prefixes that came from an external repository whose items have now been added to this DSpace. Multiple additional prefixes may be added in a comma separated list. |
...
Community Administration: Subcommunities and Collections | |||||
Property: | core.authorization.community-admin.create-subelement | ||||
Example Value: | core.authorization.community-admin.create-subelement = true | ||||
Informational Note: | Authorization for a delegated community administrator to create subcommunities or collections. | ||||
Property: | core.authorization.community-admin.delete-subelement | ||||
Example Value: | core.authorization.community-admin.delete-subelement = true | ||||
Informational Note: | Authorization for a delegated community administrator to delete subcommunities or collections. | ||||
Community Administration: Policies and The group of administrators | |||||
Property: | core.authorization.community-admin.policies | ||||
Example Value: | core.authorization.community-admin.policies = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the community policies. | ||||
Property: | core.authorization.community-admin.admin-group | ||||
Example Value: | core.authorization.community-admin.admin-group = true | ||||
Informational Note: | Authorization for a delegated community administrator to edit the group of community admins. | ||||
Community Administration: Collections in the above Community | |||||
Property: | core.authorization.community-admin.collection.policies | ||||
Example Value: | core.authorization.community-admin.collection.policies = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the policies for underlying collections. | ||||
Property: | core.authorization.community-admin.collection.template-item | ||||
Example Value: | core.authorization.community-admin.collection.template-item = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the item template for underlying collections. | ||||
Property: | core.authorization.community-admin.collection.submitters | ||||
Example Value: | core.authorization.community-admin.collection.submitters = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the group of submitters for underlying collections. | ||||
Property: | core.authorization.community-admin.collection.workflows | ||||
Example Value: | core.authorization.community-admin.collection.workflows = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the workflows for underlying collections. | ||||
Property: | core.authorization.community-admin.collection.admin-group | ||||
Example Value: | core.authorization.community-admin.collection.admin-group = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate the group of administrators for underlying collections. | ||||
Community Administration: Items Owned by Collections in the Above Community | |||||
Property: | core.authorization.community-admin.item.delete | ||||
Example Value: | core.authorization.community-admin.item.delete = true | ||||
Informational Note: | Authorization for a delegated community administrator to delete items in underlying collections. | ||||
Property: | core.authorization.community-admin.item.withdraw | ||||
Example Value: | core.authorization.community-admin.item.withdraw = true | ||||
Informational Note: | Authorization for a delegated community administrator to withdraw items in underlying collections. | ||||
Property: | core.authorization.community-admin.item.reinstate | ||||
Example Value: | core.authorization.community-admin.item.reinstate = true | ||||
Informational Note: | Authorization for a delegated community administrator to reinstate items in underlying collections. | ||||
Property: | core.authorization.community-admin.item.policies | ||||
Example Value: | core.authorization.community-admin.item.policies = true | ||||
Informational Note: | Authorization for a delegated community administrator to administrate item policies in underlying collections. | ||||
Community Administration: Bundles of Bitstreams, related to items owned by collections in the above Community | |||||
Property: | core.authorization.community-admin.item.create-bitstream | ||||
Example Value: | core.authorization.community-admin.item.create-bitstream = true | ||||
Informational Note: | Authorization for a delegated community administrator to create additional bitstreams in items in underlying collections. | ||||
Property: | core.authorization.community-admin.item.delete-bitstream | ||||
Example Value: | core.authorization.community-admin.item.delete-bitstream = true | ||||
Informational Note: | Authorization for a delegated community administrator to delete bitstreams from items in underlying collections. | ||||
Property: | core.authorization.community-admin.item.cc-license | ||||
Example Value: | core.authorization.community-admin.item.cc-license = true | ||||
Informational Note: | Authorization for a delegated community administrator to administer licenses from items in underlying collections. | ||||
Collection Administration: |
| ||||
Collection Administration: |
| ||||
Collection Administration: |
| ||||
Item Administration. | core.authorization.item-admin.policies | ||||
Item Administration: | |||||
Code Block | to administration of bitstreams |
|
---|
Inheritance of collection default policy (since 7.1)
Property: | core.authorization.installitem.inheritance-read.append-mode |
Example Value: | core.authorization.installitem.inheritance-read.append-mode = false |
Informational Note: | Determine if the DEFAULT READ policies of the collection should be always appended to the policies of the new item (property set to true) or used only when no other READ policy has been defined in the submission process (property set to false). Please note that also in append mode an open access default policy will be NOT inherited if other policies have been defined in the submission (i.e. if the item was restricted) |
Login as feature
Property: |
|
Example Value: |
|
Informational Note: | Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running DSpace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user. |
...
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.. 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 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: |
|
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 Administrator:has WRITE permissions on the Item:
To designate a field as hidden, add a property here in the form: |
...
Property: |
|
Example Value: |
|
Informational Note: | Generally will never have to assign a different value - this is the base URL of the Creative Commons service API. |
Property: |
|
Example Value: |
|
Informational Note: | The field that holds the Creative Commons license URI. If you change from the default value (dc.rights.uri), you will have to reconfigure the XMLUI for proper display of license dataholds the Creative Commons license URI. |
Property: |
|
Example Value: |
|
Informational Note: | The field that holds the Creative Commons license Name. If you change from the default value (dc.rights), you will have to reconfigure the XMLUI for proper display of license data |
Property: |
|
Example Value: |
|
Informational Note: | If true, the license assignment will add the field configured with the "cc.license.name" with the name of the CC license; if false, only "cc.license.uri" field is added. |
Property: |
|
Example Value: |
|
Informational Note: | If true, the license assignment will add a bitstream with the CC license RDF; if false, only metadata field(s) are added. |
Property: |
|
Example Value: |
|
Informational Note: | This list defines the values that will be excluded from the license (class) selection list, as defined by the web service at the URL: http://api.creativecommons.org/rest/1.5/classes |
Property: |
|
Example Value: |
|
Informational Note: | Should a jurisdiction be used? If so, which one? See http://creativecommons.org/international/ for a list of possible codes (e.g. nz = New Zealand, uk = England and Wales, jp = Japan) Commenting out this field will cause DSpace to select the latest, unported CC license (currently version 4.0). However, as Creative Commons 4.0 does not provide jurisdiction specific licenses, if you specify this setting, your DSpace will continue to use older, Creative Commons 3.0 jurisdiction licenses. |
Property | cc.license.locale |
Example Value: | cc.license.locale = en |
Informational Note: | Locale to be used (in the form: language or language_country), e.g. "en" or "en_US" If no default locale is defined the Creative Commons default locale will be used. |
...
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 BrandedPreviewJPEGFilteris 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 "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 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 . |
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 either your Messages.properties (JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>.JSPUI Example (Messages.properties)the UI's language packs (e.g.
XMLUI Example (messages.xml):
|
| 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: |
Other Browse Options
We set other browse values in the following section.
...
Property:
...
plugin.named.org.dspace.sort.OrderFormatDelegate
...
Example Value:
Code Block |
---|
plugin.named.org.dspace.sort.OrderFormatDelegate = \
org.dspace.sort.OrderFormatTitleMarc21=title |
...
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:
Code Block |
---|
author = org.dspace.sort.OrderFormatAuthor
title = org.dspace.sort.OrderFormatTitle
text = org.dspace.sort.OrderFormatText |
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.
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: |
Tag cloud
Apart from the single (type=metadata) and full (type=item) browse pages, tag cloud is a new way to display the unique values of a metadata field.
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.To enable “tag cloud” browsing for a specific index you need to declare it in the dspace.cfg configuration file using the following option:
Property: | webui.browse. | indexmetadata. | tagcloud.<n> show-freq. | |
Example Value: | webui.browse. | indexmetadata. | tagcloudshow-freq.1 = | truefalse |
Informational Note: | Enable/Disable tag cloud in browsing for a specific index. ‘n’ is the index number of the specific index which needs to be of type ‘metadata’. Possible values: true, false Default value is false. If no option exists for a specific index, it is assumed to be false. You do not have to re-index discovery when you change this configuration UNSUPPORTED in DSpace 7.0 |
Tag cloud configuration
The appearance configuration for the tag cloud is located in the Discovery xml configuration file (dspace/config/spring/api/discovery.xml). Without configuring the appearance, the default one will be applied to the tag cloud
In this file, there must be a bean named “browseTagCloudConfiguration” of class “org.dspace.discovery.configuration.TagCloudConfiguration”. This bean can have any of the following properties. If some is missing, the default value will be applied.
displayScore | Should display the score of each tag next to it? Default: false |
shouldCenter | Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true |
totalTags | How many tags will be shown. Value -1 means all of them. Default: -1 |
cloudCase | The letter case of the tags. Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE Default: Case.PRESERVE_CASE |
randomColors | If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true |
fontFrom | The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 |
fontTo | The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 |
cuttingLevel | The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0 |
ordering | The ordering of the tags (based either on the name or the score of the tag) Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc Default: Tag.GreekNameComparatorAsc |
When tagCloud is rendered there are some CSS classes that you can change in order to change the tagcloud appearance.
Class | Note |
---|---|
tagcloud | General class for the whole tagcloud |
tagcloud_1 | Specific tag class for tag of type 1 (based on score) |
tagcloud_2 | Specific tag class for tag of type 2 (based on score) |
tagcloud_3 | Specific tag class for tag of type 3 (based on score) |
Links to Other Browse Contexts
We can define which fields link to other browse listings. This is useful, for example, to link an author's name to a list of just that author's items. The effect this has is to create links to browse views for the item clicked on. If it is a "single" type, it will link to a view of all the items which share that metadata element in common (i.e. all the papers by a single author). If it is a "full" type, it will link to a view of the standard full browse page, starting with the value of the link clicked on.
...
Property:
...
webui.browse.link.<n>
...
Example Value:
...
webui.browse.link.1 = author:dc.contributor.*
...
Informational Note:
...
This is used to configure which fields should link to other browse listings. This should be associated with the name of one of the browse indexes (webui.browse.index.n
) with a metadata field listed in webui.itemlist.columns
above. If this condition is not fulfilled, cross-linking will not work. Note also that crosslinking only works for metadata fields not tagged as title
in webui.itemlist.columns
.
The format of the property key is webui.browse.link.<n> = <index name>:<display column metadata> Please notice the punctuation used between the elements.
Element | Definition and Options (if available) |
---|---|
| {{n is an arbitrary number you choose |
| This need to match your entry for the index name from webui.browse.index property key. |
| Use the DC element (and qualifier) |
Examples of some browse links used in a real DSpace installation instance:
...
Column | ||
---|---|---|
| ||
|
Column | ||
---|---|---|
| ||
Creates a link for all types of contributors (authors, editors, illustrators, others, etc.) |
...
Column | ||
---|---|---|
| ||
|
Column | ||
---|---|---|
| ||
Creates a link to subjects that are Library of Congress only. In this case, you have a browse index that contains only LC Subject Headings |
...
Column | ||
---|---|---|
| ||
|
Column | ||
---|---|---|
| ||
Creates a link for the browse index "Series". Please note this is again, a customized browse index and not part of the DSpace distributed release. |
Submission License Substitution Variables
...
Property:
Code Block |
---|
plugin.named.org.dspace.content.license.
LicenseArgumentFormatter |
(property key broken up for display purposes only)
...
Example Value:
Code Block |
---|
plugin.named.org.dspace.content.license.LicenseArgumentFormatter = \
org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = collection, \
org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = item, \
org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = eperson |
...
Informational Note:
...
It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation.
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. |
Browse Index Authority Control Configuration
Property: |
|
Example Value: |
|
Informational Note: |
Tag cloud
Apart from the single (type=metadata) and full (type=item) browse pages, tag cloud is a new way to display the unique values of a metadata field.
To enable “tag cloud” browsing for a specific index you need to declare it in the dspace.cfg configuration file using the following option:
Property: | webui.browse.index.tagcloud.<n> |
Example Value: | webui.browse.index.tagcloud.1 = true |
Informational Note: | Enable/Disable tag cloud in browsing for a specific index. ‘n’ is the index number of the specific index which needs to be of type ‘metadata’. Possible values: true, false Default value is false. If no option exists for a specific index, it is assumed to be false. You do not have to re-index discovery when you change this configuration UNSUPPORTED in DSpace 7.0 |
Tag cloud configuration
The appearance configuration for the tag cloud is located in the Discovery xml configuration file (dspace/config/spring/api/discovery.xml). Without configuring the appearance, the default one will be applied to the tag cloud
In this file, there must be a bean named “browseTagCloudConfiguration” of class “org.dspace.discovery.configuration.TagCloudConfiguration”. This bean can have any of the following properties. If some is missing, the default value will be applied.
displayScore | Should display the score of each tag next to it? Default: false |
shouldCenter | Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true |
totalTags | How many tags will be shown. Value -1 means all of them. Default: -1 |
cloudCase | The letter case of the tags. Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE Default: Case.PRESERVE_CASE |
randomColors | If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true |
fontFrom | The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 |
fontTo | The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 |
cuttingLevel | The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0 |
ordering | The ordering of the tags (based either on the name or the score of the tag) Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc Default: Tag.GreekNameComparatorAsc |
When tagCloud is rendered there are some CSS classes that you can change in order to change the tagcloud appearance.
Class | Note |
---|---|
tagcloud | General class for the whole tagcloud |
tagcloud_1 | Specific tag class for tag of type 1 (based on score) |
tagcloud_2 | Specific tag class for tag of type 2 (based on score) |
tagcloud_3 | Specific tag class for tag of type 3 (based on score) |
Links to Other Browse Contexts
We can define which fields link to other browse listings. This is useful, for example, to link an author's name to a list of just that author's items. The effect this has is to create links to browse views for the item clicked on. If it is a "single" type, it will link to a view of all the items which share that metadata element in common (i.e. all the papers by a single author). If it is a "full" type, it will link to a view of the standard full browse page, starting with the value of the link clicked on.
Property: |
|
Example Value: |
|
Informational Note: | This is used to configure which fields should link to other browse listings. This should be associated with the name of one of the browse indexes ( |
The format of the property key is webui.browse.link.<n> = <index name>:<display column metadata> Please notice the punctuation used between the elements.
Element | Definition and Options (if available) |
---|---|
| {{n is an arbitrary number you choose |
| This need to match your entry for the index name from webui.browse.index property key. |
| Use the DC element (and qualifier) |
Examples of some browse links used in a real DSpace installation instance:
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Submission License Substitution Variables
Property: |
(property key broken up for display purposes only) | ||
Example Value: |
| ||
Informational Note: | It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation. |
Syndication Feed (RSS) Settings
Note |
---|
Supported as of 7.3 and above. |
Please note that Syndication (RSS/Atom) feeds require that OpenSearch is enabled to function. When enabled, a syndication feed will be available on the DSpace homepage (for entire site), and on each community/collection homepage (specific to that community/collection). Because Syndication Feeds use OpenSearch, all OpenSearch settings also apply to Syndication Feeds.
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 |
Syndication Feed (RSS) Settings
Note |
---|
UNSUPPORTED in 7.0. Will be added in a later release |
This will enable syndication feeds‚ links display on community and collection home pages. This setting is not used by the XMLUI, as you enable feeds in your theme.
Property: |
| ||
Example Value: |
| ||
Informational Note: | By default, RSS feeds are set to true (on) . Change key to "false" to disable. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Defines the number of DSpace items per feed (the most recent submissions) | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Defines the maximum number of feeds in memory cache. Value of " | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Defines the number of hours to keep cached feeds before checking currency. The value of "0" will force a check with each request. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Defines which syndication formats to offer. You can use more than one; use a comma-separated list. The following list are the available values: rss_0.90, rss_0.91, rss_0.92, rss_0.93, rss_0.94, rss_1.0, rss_2.0, atom_1.0. | ||
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.
for result data formatting, OpenSearch uses Syndication Feed Settings (RSS). So, even if Syndication Feeds are not enable, they must be configured to enable OpenSearch. OpenSearch uses all the configuration properties for DSpace RSS to determine the mapping of metadata fields to feed fields. Note that a new field for authors has been added (used in Atom format only).
Property: |
|
Example Value: |
|
Informational Note: | Whether or not OpenSearch is enabled. By default, the feature is disabled. Change the property key to "true" to enable.enabled to support RSS/Atom feeds. Change to "false" to disable. |
Property: | websvc.opensearch.svccontext |
Example Value: | websvc.opensearch.svccontext = opensearch |
Informational Note: | The URL path where OpenSearch is made available on the backend. For example, "opensearch" means it is available at ${dspace.server.url}/opensearch |
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
...
Property: |
|
Example Value: |
|
Informational Note: | When serving up composite HTML items in the JSP UI, how deep can the request be for us to serve up a file with the same name? For example, if one receives a request for "foo/bar/index.html" and one has a bitstream called just "index.html", DSpace will serve up the former bitstream (foo/bar/index.html) for the request if webui.html.max-depth-guess is 2 or greater. If webui.html.max-depth-guess is 1 or less, then DSpace would not serve that bitstream, as the depth of the file is greater. If webui.html.max-depth-guess is zero, the request filename and path must always exactly match the bitstream name. The default is set to 3. UNSUPPORTED IN DSpace 7.0 |
...
Configuring Multilingual Support
[i18n – Locales]See Multilingual Support for more details/examples.
Setting the Default Language for the Application
...
Property: |
|
Example Value: |
|
|
|
Informational Note: | All the locales that are supported by this instance of DSpace. Comma separated list. However, the DSpace 7 UI has a similar "languages" setting in environment.*.ts |
The table above, if needed and is used will result in:
...
Code Block |
---|
[dspace]/bin/dspace dsrun org.dspace.administer.MetadataImporterregistry-loader -fmetadata [xml file] |
The XML file should be structured as follows:
...
DSpace can often recognize that a given access request comes from a web spider that is indexing your repository. These accesses can be flagged for separate treatment (perhaps exclusion) in usage statistics. This requires patterns to match against incoming requests. These patterns exist in files that you will find in config/spiders
.In the spiders
directory itself, you will find a number of files provided by iplists.com. These files contain network address patterns which have been discovered to identify a number of known indexing services and other spiders. You can add your own files here if you wish to exclude more addresses that you know of. You will need to include your files' names in the list configured in config/modules/solr-statistics.cfg
. The iplists.com-*.txt
files can be updated using a tool provided by DSpace. See SOLR Statistics for detailsrequires patterns to match against incoming requests. These patterns exist in files that you will find in config/spiders
.
In the spiders
directory itself, you will also find two subdirectories. agents
contains files filled with regular expressions, one per line. An incoming request's User-Agent
header is tested with each expression found in any of these files until an expression matches. If there is a match, the request is marked as being from a spider, otherwise not. domains
similarly contains files filled with regular expressions which are used to test the domain name from which the request comes. You may add your own files of regular expressions to either directory if you wish to test requests with patterns of your own devising.
Many configuration names/keys have changed!
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 *.cfg
files MUST be uniquely named (otherwise accidental, unintended overriding may occur).
In order to compensate for this, all modules/*.cfg
files had their configurations renamed to be prepended with the module name. As a basic example, all the configuration settings within the modules/oai.cfg
configuration now start with "oai.
".
Additionally, while the local.cfg
may look similar to the old build.properties
, many of its configurations have slightly different names. So, simply copying your build.properties into a local.cfg will NOT work.
This means that DSpace 5.x (or below) configurations are NOT compatible with the Enhanced Configuration Scheme. 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 in the next section, you'll likely want to do that anyways in order to take full advantage of the new local.cfg
file.
find a number of files provided by iplists.com. These files contain network address patterns which have been discovered to identify a number of known indexing services and other spiders. You can add your own files here if you wish to exclude more addresses that you know of. You will need to include your files' names in the list configured in config/modules/solr-statistics.cfg
. The iplists.com-*.txt
files can be updated using a tool provided by DSpace. See SOLR Statistics for details.
In the spiders
directory you will also find two subdirectories. agents
contains files filled with regular expressions, one per line. An incoming request's User-Agent
header is tested with each expression found in any of these files until an expression matches. If there is a match, the request is marked as being from a spider, otherwise not. domains
similarly contains files filled with regular expressions which are used to test the domain name from which the request comes. You may add your own files of regular expressions to either directory if you wish to test requests with patterns of your own devising.[dspace]/config/config-definition.xml
Command-line Access to Configuration Properties
...