All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
Property | Ref. Sect. | ||
---|---|---|---|
Basic Information | |||
| 6.3.2 | ||
Database Settings | |||
| 4.2.3 or 6.3.3 | ||
Advanced Database Configuration | |||
| 6.3.3 | ||
Email Settings | |||
| 6.3.4 | ||
File Storage | |||
| 6.3.5 | ||
SRB File Storage | |||
| 6.3.6 | ||
Logging Configuration | |||
| 6.3.7 | ||
Search Settings | |||
| 6.3.8 | ||
Handle Settings | |||
| 6.3.9 | ||
Delegation Administration : Authorization System Configuration | |||
| 6.3.10 | ||
Stackable Authentication Methods | |||
| 6.3.11 | ||
Shibboleth Authentication Settings | |||
| 6.3.11.1 | ||
Password Authentication Options | |||
| 6.3.11.2 | ||
X.509 Certificate Authentication | |||
| 6.3.11.3 | ||
IP-based Authentication | |||
authentication.ip.GROUPNAME | 6.3.11.5 | ||
LDAP Authentication | |||
| 6.3.11.6 | ||
Hierarchical LDAP Settings:
| 6.3.11.6 | ||
Restricted Item Visibility Settings | |||
| 6.3.12 | ||
Proxy Settings | |||
| 6.3.13 | ||
Media Filter--Format Filter Plugin Settings | |||
| 6.3.14 | ||
Custom settings for PDFFilter | |||
| 6.3.14 | ||
Crosswalk and Packager Plugin Settings (MODS, QDC, XSLT, etc.) | |||
| 6.3.15.1 | ||
| 6.3.15 | ||
| 6.3.15.4 | ||
| 6.3.15.5 | ||
Event System Configuration | |||
| 6.3.16 | ||
Embargo Settings | |||
| 6.3.17 | ||
Checksum Checker | |||
| 6.3.18 | ||
Item Export and Download Settings | |||
| 6.3.19 | ||
Subscription Email Option | |||
| 6.3.20 | ||
Bulk (Batch) Metadata Editing | |||
| 6.3.21 | ||
Hide Item Metadata Fields Setting | |||
| 6.3.22 | ||
Submission Process | |||
| 6.3.23 | ||
| 6.3.24 | ||
Settings for Thumbnail Creation | |||
| 6.3.25 | ||
Settings for Item Preview | |||
| 6.3.25 | ||
Settings for Content Count/Strength Information | |||
| 6.3.25 | ||
Browse Configuration | |||
| 6.3.26 | ||
| 6.3.26 | ||
| 6.3.26.3 | ||
| 6.3.26.4 | ||
Multiple Metadata Value Display | |||
| 6.3.27 | ||
Other Browse Contexts | |||
| 6.3.28 | ||
Recent Submission | |||
| 6.3.29 | ||
Submission License Substitution Variables | |||
| 6.3.30 | ||
Syndication Feed (RSS) Settings | |||
| 6.3.31 | ||
OpenSearch Settings | |||
| 6.3.32 | ||
Content Inline Disposition Threshold | |||
| 6.3.33 | ||
Multifile HTML Settings | |||
| 6.3.34 | ||
Sitemap Settings | |||
| 6.3.35 | ||
Authority Control Settings | |||
| 6.3.36 | ||
JSPUI Upload File Settings | |||
| 6.3.37 | ||
JSP Web Interface Settings | |||
| 6.3.38 | ||
JSPUI i18n Locales / Languages |
| ||
| 6.3.39 | ||
JSPUI Additional Configuration for Item Mapper | |||
| 6.3.40 | ||
JSPUI MyDSpace Display of Group Membership |
| ||
| 6.3.41 | ||
JSPUI SFX Server Setting | |||
| 6.3.42 | ||
JSPUI Item Recommendation Settings | |||
| 6.3.43 | ||
JSPUI Controlled Vocabulary Settings | |||
| 6.3.44 | ||
JSPUI Session Invalidation | |||
| 6.3.45 | ||
XMLUI Settings (Manakin) | |||
| 6.3.46 | ||
OAI-PMH Specific Configurations | |||
| 5.2.47 | ||
SWORD Specific Configurations | |||
| 6.4.6 | ||
OAI-ORE Harvester Configurations | |||
| 6.3.48 | ||
SOLR Statistics Configurations | |||
| 6.3.49 |
...
Property: | | ||
Example Value: | | ||
Informational Note: | Root directory of DSpace installation. Omit the trailing '/'. Note that if you change this, there are several other parameters you will probably want to change to match, e.g. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Fully qualified hostname; do not include port number. | ||
Property: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c9b83e81f5808c5b-e2a4597a-418b44f9-b8c18414-b6d547d671a7c3168f77d9d0"><ac:plain-text-body><![CDATA[ | Example Value: | | ]]></ac:plain-text-body></ac:structured-macro> |
Informational Note: | Main URL at which DSpace Web UI webapp is deployed. Include any port number, but do not include the trailing ' | ||
Property: | | ||
Example Value: | | ||
Informational note | DSpace base URL. URL that determines whether JSPUI or XMLUI will be loaded by default. Include port number etc., but NOT trailing slash. Change to | ||
Property: | | ||
Example Value: | | ||
Informational note: | The base URL of the OAI webapp (do not include /request). | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Short and sweet site name, used throughout Web UI, e-mails and elsewhere (such as OAI protocol) |
...
Property: | | ||
Example Value: | | ||
Informational Note: | This is Asset (bitstream) store number 0 (Zero). You need not place your assetstore under the /dspace directory, but may want to place it on a different logical volume on the server that DSpace resides. So, you might have something like this: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property specifies extra asset stores like the one above, counting from one (1) upwards. This property is commented out (#) until it is needed. | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2a2865a5e1be5810-4f6112c8-4e8e47b8-906a9964-0203a0ea70361159e24ad8a2"><ac:plain-text-body><![CDATA[ | Informational Note: | Informational Note: Specify the number of the store to use for new bitstreams with this property. The default is 0 [zero] which corresponds to the 'assestore.dir' above. As the asset store number is stored in the item metadata (in the database), always keep the assetstore numbering consistent and don't change the asset store number in the item metadata. | ]]></ac:plain-text-body></ac:structured-macro> |
...
Standard LDAP Configuration | |||
Property: | | ||
Example Value: | | ||
Informational Note: | This setting will enable or disable LDAP authentication in DSpace. With the setting off, users will be required to register and login with their email address. With this setting on, users will be able to login and register with their LDAP user ids and passwords. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the url to your institution's LDAP server. You may or may not need the /o=myu.edu part at the end. Your server may also require the ldaps:// protocol. | ||
Property: | | ||
Example Value: | | ||
Explanation: | This is the unique identifier field in the LDAP directory where the username is stored. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the object context used when authenticating the user. It is appended to the ldap.id_field and username. For example | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="14517cd76914fbbb-810db77b-4f794ec1-8dfdbabf-d4933864f0f33c79add1039c"><ac:plain-text-body><![CDATA[ | Informational Note: | This is the search context used when looking up a user's LDAP object to retrieve their data for autoregistering. With ldap.autoregister turned on, when a user authenticates without an EPerson object we search the LDAP directory to get their name and email address so that we can create one for them. So after we have authenticated against uid=username,ou=people,o=byu.edu we now search in ou=people for filtering on [uid=username]. Often the | ]]></ac:plain-text-body></ac:structured-macro> |
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's email address is stored. "mail" is the default and the most common for LDAP servers. If the mail field is not found the username will be used as the email address when creating the eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's last name is stored. "sn" is the default and is the most common for LDAP servers. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's given names are stored. I'm not sure how common the givenName field is in different LDAP instances. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the field where the user's phone number is stored in the LDAP directory. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This will turn LDAP autoregistration on or off. With this on, a new EPerson object will be created for any user who successfully authenticates against the LDAP server when they first login. With this setting off, the user must first register to get an EPerson object by entering their ldap username and password and filling out the forms. | ||
LDAP Users Group | |||
Property: | | ||
Example Value: | | ||
Informational Note: | If required, a group name can be given here, and all users who log into LDAP will automatically become members of this group. This is useful if you want a group made up of all internal authenticated users. (Remember to log on as the administrator, add this to the "Groups" with read rights). |
...
Properties: | | ||
Example Values: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3e6c13430d57abc2-9847bada-451548e0-8cf8bde4-7c488aa251ecbeea80fde1a3"><ac:plain-text-body><![CDATA[ | Informational Note: | This defines a crosswalk named MODS whose configuration comes from the file | ]]></ac:plain-text-body></ac:structured-macro> |
...
Property: | webui.licence_bundle.show | ||
Example Value: | webui.licence_bundle.show = false | ||
Informational Note: | Sets whether to display the contents of the license bundle (often just the deposit license in the standard DSpace installation). | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Controls whether to display thumbnails on browse and search result pages. If you have customized the Browse columnlist, then you must also include a "thumbnail" column in your configuration. _(This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them)._ | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This property determines the maximum height of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This determines the maximum width of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This determines whether or not to display the thumbnail against each bitstream. (This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them). | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This determines where clicks on the thumbnail in browse and search screens should lead. The only values currently supported are "item" or "bitstream", which will either take the user to the item page, or directly download the bitstream. | ||
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: | Whether or not the user can "preview" the image. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This property sets the maximum width for the preview image. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This property sets the maximum height for the preview image. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the brand text that will appear with the image. | ||
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. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The height (in px) of the brand. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This property sets the font for your Brand text that appears with the image. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This property sets the font point (size) for your Brand text that appears with the image. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The Dublin Core field that will display along with the preview. This field is optional. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Determines if communities and collections should display item counts when listed. The default behavior if omitted, is true. (This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them). | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9e59fc75c45fc2b8-f302b391-43704c22-96e2b4cc-372cad2216cbaf938a4dcc30"><ac:plain-text-body><![CDATA[ | Informational Note: | When showing the strengths, should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the database contents every time a page with this feature is requested, which will not scale. If you set the property key is set to cache ("true") you must run the following command periodically to update the count: | ]]></ac:plain-text-body></ac:structured-macro> |
...
Property: | | ||
Example Value: |
| ||
Informational Note: | This is used to customize the DC metadata fields that display in the item display (the brief display) when pulling up a record. The format is: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | When using "resolver" in webui.itemdisplay to render identifiers as resolvable links, the base URL is take from <code>webui.resolver.<n>.baseurl<code> where <code>webui.resolver.<n>.baseurl<code> matches the urn specified in the metadata value. The value is appended to the "baseurl" as is, so the baseurl needs to end with the forward slash almost in any case. If no urn is specified in the value it will be displayed as simple text. For the doi and hdl urn defaults values are provided, respectively http://dc.doi.org and http://hdl.handle.net are used. If a metadata value with style "doi", "handle" or "resolver" matches a URL already, it is simply rendered as a link with no other manipulation. | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | Specify which strategy to use for select the style for an item. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Specify which collections use which views by Handle. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which metadata to use as name of the style | ||
Property: | | ||
Example Value: |
| ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1b5fc21977c4fb80-728001cb-4a5d4f25-a7318755-de305c9503f229e69f0e30ec"><ac:plain-text-body><![CDATA[ | Informational Note: | Customize the DC fields to use in the item listing page. Elements will be displayed left to right in the order they are specified here. The form is <schema prefix>.<element>[.<qualifier> | .*][(date)], ... | |
Property: | | ||
Example Value: | | ||
Informational Note: | You can customize the width of each column with the following line--you can have numbers (pixels) or percentages. For the 'thumbnail' column, a setting of '*' will use the max width specified for browse thumbnails (cf. | ||
Property: |
| ||
Example Value: | _}} | ||
Informational Note: | You can override the DC fields used on the listing page for a given browse index and/or sort option. As a sort option or index may be defined on a field that isn't normally included in the list, this allows you to display the fields that have been indexed/sorted on. There are a number of forms the configuration can take, and the order in which they are listed below is the priority in which they will be used (so a combination of an index name and sort name will take precedence over just the browse name).In the last case, a sort option name will always take precedence over a browse index name. Note also, that for any additional columns you list, you will need to ensure there is an itemlist.<field name> entry in the messages file. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This would display the date of the accession in place of the issue date whenever the dateaccessioned browsed index or sort option is selected. Just like webui.itemlist.columns, you will need to include a 'thumbnail' entry to display the thumbnails in the item list. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | As in the aforementioned property key, you can customize the width of the columns for each configured column list, substituting '.widths' for '.columns' in the property name. See the setting for webui.itemlist.widths for more information. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | You can also set the overall size of the item list table with the following setting. It can lead to faster table rendering when used with the column widths above, but not generally recommended. | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6009ee941aa90394-66edf5f2-45cb4c7b-b81da301-d782970386059aa38a2846f4"><ac:plain-text-body><![CDATA[ | Informational Note: | Enable or disable session invalidation upon login or logout. This feature is enabled by default to help prevent session hijacking but may cause problems for shibboleth, etc. If omitted, the default value is 'true'. [Only used for JSPUI authentication]. | ]]></ac:plain-text-body></ac:structured-macro> |
...
Property: | | ||
Example Value: | | ||
Informational Note: | Is used by the SolrLogger Client class to connect to the SOLR server over http and perform updates and queries. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Spiders file is utilized by the SolrLogger, this will be populated by running the following command: | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="94a1daa66a658813-f71bdb5b-426a4689-9383a753-1df6d60a8da276c91fecfb99"><ac:plain-text-body><![CDATA[ | Informational Note: | The following refers to the GeoLiteCity database file utilized by the LocationUtils to calculate the location of client requests based on IP address. During the Ant build process (both fresh_install and update) this file will be downloaded from [http://www.maxmind.com/app/geolitecity] if a new version has been published or it is absent from your | ]]></ac:plain-text-body></ac:structured-macro> |
Property: | | ||
Example Value: | | ||
Informational Note: | Timeout for the resolver in the DNS lookup time in milliseconds, defaults to 200 for backward compatibility; your system's default is usually set in | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Enables access control restriction on DSpace Statistics pages, Restrictions are based on access rights to Community, Collection and Item Pages. This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. | ||
Property: | | ||
Example Value: | {{solr.statistics.logBots = true }} | ||
Informational Note: | Enable/disable logging of spiders in solr statistics. If false, and IP matches an address in solr.spiderips.urls, event is not logged. If true, event will be logged with the 'isBot' field set to true (see | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Controls solr statistics querying to filter out spider IPs. False by default. | ||
Property: | {{solr.statistics.query.filter.isBot }} | ||
Example Value: | | ||
Informational Note: | Controls solr statistics querying to look at "isBot" field to determine if record is a bot. True by default. | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | URLs to download IP addresses of search engine spiders from |
...