Licensed under a Creative Commons Attribution 3.0 United States License
Table of Contents
This section describes how to update a DSpace installation from one version to the next. Details of the differences between the functionality of each version are given in the Version History section.
This section needs review
The changes in DSpace 1.5.2 do not include any database schema upgrades, and the upgrade should be straightforward.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-source] to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Backup your DSpace First and foremost, make a complete backup of your system, including:
A snapshot of the database
The asset store ([dspace]/assetstore by default)
Your configuration files and customizations to DSpace
Your statistics scripts ([dspace]/bin/stat*) which contain customizable dates
Download DSpace 1.5.2 Get the new DSpace 1.5.2 source code either as a download from SourceForge or check it out directly from the SVN code repository. If you downloaded DSpace do not unpack it on top of your existing installation.
Build DSpace Run the following commands to compile DSpace.
cd [dspace-source]/dspace/ mvn package
You will find the result in [dspace-source]/dspace/target/dspace-1.5.2-build.dir/; inside this directory is the compiled binary distribution of DSpace.
Stop Tomcat Take down your servlet container, for Tomcat use the bin/shutdown.sh script.
Apply any customizations If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the [dspace 1.4.2]/jsp/local directory. These should be moved [dspace-source]/dspace/modules/jspui/src/main/webapp/ in the new build structure. See Customizing the JSP Pages for more information.
Update DSpace Update the DSpace installed directory with new code and libraries. Inside the [dspace-source]/dspace/target/dspace-1.5-build.dir/ directory run:
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/ ant -Dconfig=[dspace]/config/dspace.cfg update
Update configuration files This ant target preserves existing files in [dspace]/config and will copy any new configuration files in place. If an existing file prevents copying the new file in place, the new file will have the suffix .new, for example [dspace]/local/dspace.cfg.new. Note: there is also a configuration option -Doverwrite=true which will instead copy the conflicting target files to *.old suffixes and overwrite target file then with the new file (essentially the opposite) this is beneficial for developers and those who use the [dspace-source]/dspace/config to maintain their changes.
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/ ant -Dconfig=[dspace]/config/dspace.cfg update_configs
You must then verify that you've merged and differenced in the [dspace]/config/**/*.new files into your configuration.
Some of the new parameters you should look out for in dspace.cfg include:
New option to restrict the expose of private items. The following needs to be added to dspace.cfg:
#### Restricted item visibility settings ### # By default RSS feeds, OAI-PMH and subscription emails will include ALL items # regardless of permissions set on them. # # If you wish to only expose items through these channels where the ANONYMOUS # user is granted READ permission, then set the following options to false #harvest.includerestricted.rss = true #harvest.includerestricted.oai = true #harvest.includerestricted.subscription = true
Special groups for LDAP and password authentication.
##### Password users group ##### # If required, a group name can be given here, and all users who log in # using the DSpace password system will automatically become members of # this group. This is useful if you want a group made up of all internal # authenticated users. #password.login.specialgroup = group-name ##### LDAP users group ##### # If required, a group name can be given here, and all users who log in # to LDAP will automatically become members of this group. This is useful # if you want a group made up of all internal authenticated users. #ldap.login.specialgroup = group-name
new option for case insensitivity in browse tables.
# By default, the display of metadata in the browse indexes is case sensitive # So, you will get separate entries for the terms # # Olive oil # olive oil # # However, clicking through from either of these will result in the same set of items # (ie. any item that contains either representation in the correct field). # # Uncommenting the option below will make the metadata items case-insensitive. This will # result in a single entry in the example above. However the value displayed may be either 'Olive oil' # or 'olive oil' - depending on what representation was present in the first item indexed. # # If you care about the display of the metadata in the browse index - well, you'll have to go and # fix the metadata in your items. # # webui.browse.metadata.case-insensitive = true
New usage event handler for collecting statistics:
### Usage event settings ### # The usage event handler to call. The default is the "passive" handler, which ignores events. # plugin.single.org.dspace.app.statistics.AbstractUsageEvent = \ # org.dspace.app.statistics.PassiveUsageEvent
The location where sitemaps are stored is now configurable.
#### Sitemap settings #####
# the directory where the generated sitemaps are stored
sitemap.dir = ${dspace.dir}/sitemaps
MARC 21 ordering should now be used as default. Unless you have it set already, or you have it set to a different value, the following should be set:
plugin.named.org.dspace.sort.OrderFormatDelegate = org.dspace.sort.OrderFormatTitleMarc21=title
Hierarchical LDAP support.
##### Hierarchical LDAP Settings ##### # If your users are spread out across a hierarchical tree on your # LDAP server, you will need to use the following stackable authentication # class: # plugin.sequence.org.dspace.authenticate.AuthenticationMethod = \ # org.dspace.authenticate.LDAPHierarchicalAuthentication # # You can optionally specify the search scope. If anonymous access is not # enabled on your LDAP server, you will need to specify the full DN and # password of a user that is allowed to bind in order to search for the # users. # This is the search scope value for the LDAP search during # autoregistering. This will depend on your LDAP server setup. # This value must be one of the following integers corresponding # to the following values: # object scope : 0 # one level scope : 1 # subtree scope : 2 #ldap.search_scope = 2 # The full DN and password of a user allowed to connect to the LDAP server # and search for the DN of the user trying to log in. If these are not specified, # the initial bind will be performed anonymously. #ldap.search.user = cn=admin,ou=people,o=myu.edu #ldap.search.password = password # If your LDAP server does not hold an email address for a user, you can use # the following field to specify your email domain. This value is appended # to the netid in order to make an email address. E.g. a netid of 'user' and # ldap.netid_email_domain as '@example.com' would set the email of the user # to be '[email protected] #ldap.netid_email_domain = @example.com
Shibboleth authentication support.
#### Shibboleth Authentication Configuration Settings #### # Check https://mams.melcoe.mq.edu.au/zope/mams/pubs/Installation/dspace15/view # for installation detail. # # org.dspace.authenticate.ShibAuthentication # # DSpace requires email as user's credential. There are 2 ways of providing # email to DSpace: # 1) by explicitly specifying to the user which attribute (header) # carries the email address. # 2) by turning on the user-email-using-tomcat=true which means # the software will try to acquire the user's email from Tomcat # The first option takes PRECEDENCE when specified. Both options can # be enabled to allow fallback. # this option below specifies that the email comes from the mentioned header. # The value is CASE-Sensitive. authentication.shib.email-header = MAIL # optional. Specify the header that carries user's first name # this is going to be used for creation of new-user authentication.shib.firstname-header = SHIB-EP-GIVENNAME # optional. Specify the header that carries user's last name # this is used for creation of new user authentication.shib.lastname-header = SHIB-EP-SURNAME # this option below forces the software to acquire the email from Tomcat. authentication.shib.email-use-tomcat-remote-user = true # should we allow new users to be registered automtically # if the IdP provides sufficient info (and user not exists in DSpace) authentication.shib.autoregister = true # this header here specifies which attribute that is responsible # for providing user's roles to DSpace. When not specified, it is # defaulted to 'Shib-EP-UnscopedAffiliation'. The value is specified # in AAP.xml (Shib 1.3.x) or attribute-filter.xml (Shib 2.x). # The value is CASE-Sensitive. The values provided in this # header are separated by semi-colon or comma. # authentication.shib.role-header = Shib-EP-UnscopedAffiliation # when user is fully authN on IdP but would not like to release # his/her roles to DSpace (for privacy reason?), what should be # the default roles be given to such users? # The values are separated by semi-colon or comma # authentication.shib.default-roles = Staff, Walk-ins # The following mappings specify role mapping between IdP and Dspace. # the left side of the entry is IdP's role (prefixed with # "authentication.shib.role.") which will be mapped to # the right entry from DSpace. DSpace's group as indicated on the # right entry has to EXIST in DSpace, otherwise user will be identified # as 'anonymous'. Multiple values on the right entry should be separated # by comma. The values are CASE-Sensitive. Heuristic one-to-one mapping # will be done when the IdP groups entry are not listed below (i.e. # if "X" group in IdP is not specified here, then it will be mapped # to "X" group in DSpace if it exists, otherwise it will be mapped # to simply 'anonymous') # # Given sufficient demand, future release could support regex for the mapping # special characters need to be escaped by \ authentication.shib.role.Senior\ Researcher = Researcher, Staff authentication.shib.role.Librarian = Administrator
DOI and handle identifiers can now be rendered in the JSPUI.
# When using "resolver" in webui.itemdisplay to render identifiers as resolvable # links, the base URL is taken 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 need to end with slash almost in any case. # If no urn is specified in the value it will be displayed as simple text. # #webui.resolver.1.urn = doi #webui.resolver.1.baseurl = http://dx.doi.org/ #webui.resolver.2.urn = hdl #webui.resolver.2.baseurl = http://hdl.handle.net/ # # For the doi and hdl urn defaults values are provided, respectively http://dx.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.
In configuration sections such as webui.itemdisplay.default, values can be changed from (e.g.) metadata.dc.identifier.doi to metadata.doi.dc.identifer.doi
The whole of the SWORD configuration has changed. The SWORD section must be removed and replaced with
#---------------------------------------------------------------#
#--------------SWORD SPECIFIC CONFIGURATIONS--------------------#
#---------------------------------------------------------------#
# These configs are only used by the SWORD interface #
#---------------------------------------------------------------#
# tell the SWORD METS implementation which package ingester to use
# to install deposited content. This should refer to one of the
# classes configured for:
#
# plugin.named.org.dspace.content.packager.PackageIngester
#
# The value of sword.mets-ingester.package-ingester tells the
# system which named plugin for this interface should be used
# to ingest SWORD METS packages
#
# The default is METS
#
# sword.mets-ingester.package-ingester = METS
# Define the metadata type EPDCX (EPrints DC XML)
# to be handled by the SWORD crosswalk configuration
#
mets.submission.crosswalk.EPDCX = SWORD
# define the stylesheet which will be used by the self-named
# XSLTIngestionCrosswalk class when asked to load the SWORD
# configuration (as specified above). This will use the
# specified stylesheet to crosswalk the incoming SWAP metadata
# to the DIM format for ingestion
#
crosswalk.submission.SWORD.stylesheet = crosswalks/sword-swap-ingest.xsl
# The base URL of the SWORD deposit. This is the URL from
# which DSpace will construct the deposit location urls for
# collections.
#
# The default is {dspace.url}/sword/deposit
#
# In the event that you are not deploying DSpace as the ROOT
# application in the servlet container, this will generate
# incorrect URLs, and you should override the functionality
# by specifying in full as below:
#
# sword.deposit.url = http://www.myu.ac.uk/sword/deposit
# The base URL of the SWORD service document. This is the
# URL from which DSpace will construct the service document
# location urls for the site, and for individual collections
#
# The default is {dspace.url}/sword/servicedocument
#
# In the event that you are not deploying DSpace as the ROOT
# application in the servlet container, this will generate
# incorrect URLs, and you should override the functionality
# by specifying in full as below:
#
# sword.servicedocument.url = http://www.myu.ac.uk/sword/servicedocument
# The base URL of the SWORD media links. This is the URL
# which DSpace will use to construct the media link urls
# for items which are deposited via sword
#
# The default is {dspace.url}/sword/media-link
#
# In the event that you are not deploying DSpace as the ROOT
# application in the servlet container, this will generate
# incorrect URLs, and you should override the functionality
# by specifying in full as below:
#
# sword.media-link.url = http://www.myu.ac.uk/sword/media-link
# The URL which identifies the sword software which provides
# the sword interface. This is the URL which DSpace will use
# to fill out the atom:generator element of its atom documents.
#
# The default is:
#
# http://www.dspace.org/ns/sword/1.3.1
#
# If you have modified your sword software, you should change
# this URI to identify your own version. If you are using the
# standard dspace-sword module you will not, in general, need
# to change this setting
#
# sword.generator.url = http://www.dspace.org/ns/sword/1.3.1
# The metadata field in which to store the updated date for
# items deposited via SWORD.
#
sword.updated.field = dc.date.updated
# The metadata field in which to store the value of the slug
# header if it is supplied
#
sword.slug.field = dc.identifier.slug
# the accept packaging properties, along with their associated
# quality values where appropriate.
#
# Global settings; these will be used on all DSpace collections
#
sword.accept-packaging.METSDSpaceSIP.identifier =
http://purl.org/net/sword-types/METSDSpaceSIP
sword.accept-packaging.METSDSpaceSIP.q = 1.0
# Collection Specific settings: these will be used on the collections
# with the given handles
#
# sword.accept-packaging.[handle].METSDSpaceSIP.identifier =
http://purl.org/net/sword-types/METSDSpaceSIP
# sword.accept-packaging.[handle].METSDSpaceSIP.q = 1.0
# Should the server offer up items in collections as sword deposit
# targets. This will be effected by placing a URI in the collection
# description which will list all the allowed items for the depositing
# user in that collection on request
#
# NOTE: this will require an implementation of deposit onto items, which
# will not be forthcoming for a short while
#
sword.expose-items = false
# Should the server offer as the default the list of all Communities
# to a Service Document request. If false, the server will offer
# the list of all collections, which is the default and recommended
# behaviour at this stage.
#
# NOTE: a service document for Communities will not offer any viable
# deposit targets, and the client will need to request the list of
# Collections in the target before deposit can continue
#
sword.expose-communities = false
# The maximum upload size of a package through the sword interface,
# in bytes
#
# This will be the combined size of all the files, the metadata and
# any manifest data. It is NOT the same as the maximum size set
# for an individual file upload through the user interface. If not
# set, or set to 0, the sword service will default to no limit.
#
sword.max-upload-size = 0
# Should DSpace store a copy of the original sword deposit package?
#
# NOTE: this will cause the deposit process to run slightly slower,
# and will accelerate the rate at which the repository consumes disk
# space. BUT, it will also mean that the deposited packages are
# recoverable in their original form. It is strongly recommended,
# therefore, to leave this option turned on
#
# When set to "true", this requires that the configuration option
# "upload.temp.dir" above is set to a valid location
#
sword.keep-original-package = true
# The bundle name that SWORD should store incoming packages under if
# sword.keep-original-package is set to true. The default is "SWORD"
# if not value is set
#
# sword.bundle.name = SWORD
# Should the server identify the sword version in deposit response?
#
# It is recommended to leave this enabled.
#
sword.identify-version = true
# Should we support mediated deposit via sword? Enabled, this will
# allow users to deposit content packages on behalf of other users.
#
# See the SWORD specification for a detailed explanation of deposit
# On-Behalf-Of another user
#
sword.on-behalf-of.enable = true
# Configure the plugins to process incoming packages. The form of this
# configuration is as per the Plugin Manager's Named Plugin documentation:
#
# plugin.named.[interface] = [implementation] = [package format identifier] \
#
# Package ingesters should implement the SWORDIngester interface, and
# will be loaded when a package of the format specified above in:
#
# sword.accept-packaging.[package format].identifier = [package format identifier]
#
# is received.
#
# In the event that this is a simple file deposit, with no package
# format, then the class named by "SimpleFileIngester" will be loaded
# and executed where appropriate. This case will only occur when a single
# file is being deposited into an existing DSpace Item
#
plugin.named.org.dspace.sword.SWORDIngester = \
org.dspace.sword.SWORDMETSIngester =
http://purl.org/net/sword-types/METSDSpaceSIP \
org.dspace.sword.SimpleFileIngester = SimpleFileIngester
Restart Tomcat Restart your servlet container, for Tomcat use the bin/startup.sh script.
The changes in DSpace 1.5 are significant and wide spread involving database schema upgrades, code restructuring, completely new user and programatic interfaces, and new build system.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-source] to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Backup your DSpace First and foremost, make a complete backup of your system, including:
A snapshot of the database
The asset store ([dspace]/assetstore by default)
Your configuration files and customizations to DSpace
Your statistics scripts ([dspace]/bin/stat*) which contain customizable dates
Download DSpace 1.5 Get the new DSpace 1.5 source code either as a download from SourceForge or check it out directly from the SVN code repository. If you downloaded DSpace do not unpack it on top of your existing installation.
Build DSpace The build process has radically changed for DSpace 1.5. With this new release the build system has moved to a maven-based system enabling the various projects (JSPUI, XMLUI, OAI, and Core API) into separate projects. See the Installation section for more information on building DSpace using the new maven-based build system. Run the following commands to compile DSpace.
cd [dspace-source]/dspace/; mvn package
You will find the result in [dspace-source]/dspace/target/dspace-1.5-build.dir/; inside this directory is the compiled binary distribution of DSpace.
Stop Tomcat Take down your servlet container, for Tomcat use the bin/shutdown.sh script.
Update dspace.cfg Serveral new parameters need to be added to your [dspace]/config/dspace.cfg. While it is advisable to start with a fresh DSpace 1.5 dspace.cfg configuration file here are the minimum set of parameters that need to be added to an old DSpace 1.4.2 configuration.
#### Stackable Authentication Methods #####
#
# Stack of authentication methods
# (See org.dspace.authenticate.AuthenticationManager)
# Note when upgrading you should remove the parameter:
# plugin.sequence.org.dspace.eperson.AuthenticationMethod
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = \
org.dspace.authenticate.PasswordAuthentication
###### JSPUI item sytle plugin #####
#
# Specify which strategy use for select the style for an item
plugin.single.org.dspace.app.webui.util.StyleSelection = \
org.dspace.app.webui.util.CollectionStyleSelection
###### Browse Configuration ######
#
# The following configuration will mimic the previous
# behavior exhibited by DSpace 1.4.2. For alternative
# configurations see the manual.
# Browse indexes
webui.browse.index.1 = dateissued:item:dateissued
webui.browse.index.2 = author:metadata:dc.contributor.*:text
webui.browse.index.3 = title:item:title
webui.browse.index.4 = subject:metadata:dc.subject.*:text
# Sorting options
webui.itemlist.sort-option.1 = title:dc.title:title
webui.itemlist.sort-option.2 = dateissued:dc.date.issued:date
webui.itemlist.sort-option.3 =
dateaccessioned:dc.date.accessioned:date
# Recent submissions
recent.submissions.count = 5
# Itemmapper browse index
itemmap.author.index = author
# Recent submission processor plugins
plugin.sequence.org.dspace.plugin.CommunityHomeProcessor = \
org.dspace.app.webui.components.RecentCommunitySubmissions
plugin.sequence.org.dspace.plugin.CollectionHomeProcessor = \
org.dspace.app.webui.components.RecentCollectionSubmissions
#### Content Inline Disposition Threshold ####
#
# Set the max size of a bitstream that can be served inline
# Use -1 to force all bitstream to be served inline
# webui.content_disposition_threshold = -1
webui.content_disposition_threshold = 8388608
#### Event System Configuration ####
#
# default synchronous dispatcher (same behavior as traditional
DSpace)
event.dispatcher.default.class = org.dspace.event.BasicDispatcher
event.dispatcher.default.consumers = search, browse, eperson
# consumer to maintain the search index
event.consumer.search.class = org.dspace.search.SearchConsumer
event.consumer.search.filters =
Item|Collection|Community|Bundle+Create|Modify|Modify_Metadata|Delete:
Bundle+Add|Remove
# consumer to maintain the browse index
event.consumer.browse.class = org.dspace.browse.BrowseConsumer
event.consumer.browse.filters =
Item+Create|Modify|Modify_Metadata:Collection+Add|Remove
# consumer related to EPerson changes
event.consumer.eperson.class = org.dspace.eperson.EPersonConsumer
event.consumer.eperson.filters = EPerson+Create
Add xmlui.xconf Manakin configuration The new Manakin user interface available with DSpace 1.5 requires an extra configuration file that you will need to manually copy it over to your configuration directory.
cp [dspace-source]/dspace/config/xmlui.xconf [dspace]/config/xmlui.xconf
Add item-submission.xml and item-submission.dtd configurable submission configuration The new configurable submission system that enables an administrator to re-arrange, or add/remove item submission steps requires this configuration file. You need to manually copy it over to your configuration directory.
cp [dspace-source]/dspace/config/item-submission.xml [dspace]/config/item-submission.xml cp [dspace-source]/dspace/config/item-submission.dtd [dspace]/config/item-submission.dtd
Add new input-forms.xml and input-forms.dtd configurable submission configuration The input-forms.xml now has an included dtd reference to support validation. You'll need to merge in your changes to both file/and or copy them into place.
cp [dspace-source]/dspace/config/input-forms.xml [dspace]/config/input-forms.xml cp [dspace-source]/dspace/config/input-forms.dtd [dspace]/config/inputforms.dtd
Add sword-swap-ingest.xsl and xhtml-head-item.properties crosswalk files New crosswalk files are required to support SWORD and the inclusion of metadata into the head of items.
cp [dspace-source]/dspace/config/crosswalks/sword-swap-ingest.xsl [dspace]/config/crosswalks/sword-swap-ingest.xsl cp [dspace-source]/dspace/config/crosswalks/xhtml-head-item.properties [dspace]/config/crosswalks/xhtml-head-item.properties
Add registration_notify email files A new configuration option (registration.notify = [email protected]) can be set to send a notification email whenever a new user registers to use your DSpace. The email template for this email needs to be copied.
cp [dspace-source]/dspace/config/emails/registration_notify [dspace]/config/emails/registration_notify
Update the database The database schema needs updating. SQL files contain the relevant updates are provided, note if you have made any local customizations to the database schema you should consult these updates and make sure they will work for you.
For PostgreSQL
psql -U [dspace-user] -f [dspace-source]/dspace/etc/database_schema_14-15.sql [database-name]
For Oracle
[dspace-source]/dspace/etc/oracle/database_schema_142-15.sql contains the commands necessary to upgrade your database schema on oracle.
Apply any customizations If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the [dspace 1.4.2]/jsp/local directory. These should be moved [dspace-source]/dspace/modules/jspui/src/main/webapp/ in the new build structure. See Customizing the JSP Pages for more information.
Update DSpace Update the DSpace installed directory with new code and libraries. Inside the [dspace-source]/dspace/target/dspace-1.5-build.dir/ directory run:
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/; ant -Dconfig=[dspace]/config/dspace.cfg update
Update the Metadata Registry New Metadata Registry updates are required to support SWORD.
cp [dspace-source]/dspace/config/registries/sword-metadata.xml [dspace]/config/registries/sword-metadata.xml; [dspace]/bin/dsrun org.dspace.administer.MetadataImporter -f [dspace]/config/registries/sword-metadata.xml
Rebuild browse and search indexes One of the major new features of DSpace 1.5 is the browse system which necessitates that the indexes be recreated. To do this run the following command from your DSpace installed directory:
[dspace]/bin/index-init
Update statistics scripts The statistics scripts have been rewritten for DSpace 1.5. Prior to 1.5 they were written in Perl, but have been rewritten in Java to avoid having to install Perl. First, make a note of the dates you have specified in your statistics scripts for the statistics to run from. You will find these in [dspace]/bin/stat-initial, as $start_year and $start_month. Note down these values.
Copy the new stats scripts:
cp [dspace-source]/dspace/bin/stat* [dspace]/bin/
Then edit your statistics configuration file with the start details. Add the follwing to [dspace]/conf/dstat.cfg
# the year and month to start creating reports from
# - year as four digits (e.g. 2005)
# - month as a number (e.g. January is 1, December is 12)
start.year = 2005
start.month = 1
Replace '2005' and '1' as with the values you noted down.
dstat.cfg also used to contain the hostname and service name as displayed at the top of the statistics. These values are now taken from dspace.cfg so you can remove host.name and host.url from dstat.cfg if you wish. The values now used are dspace.hostname and dspace.name from dspace.cfg
Deploy webapplications Copy the webapplications files from your [dspace]/webapps directory to the subdirectory of your servlet container (e.g. Tomcat):
cp [dspace]/webapps/* [tomcat]/webapps/
Restart Tomcat Restart your servlet container, for Tomcat use the bin/startup.sh script.
See Updating From 1.4 to 1.4.x; the same instructions apply.
The changes in 1.4.x releases are only code and configuration changes so the update is simply a matter of rebuilding the wars and slight changes to your config file.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.4.x-source] to the source directory for DSpace 1.4.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Get the new DSpace 1.4.x source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib cp postgresql.jar [dspace-1.4.x-source]/lib
Note: Licensing conditions for the handle.jar file have changed. As a result, the latest version of the handle.jar file is not included in this distribution. It is recommended you read the new license conditions and decide whether you wish to update your installation's handle.jar. If you decide to update, you should replace the existing handle.jar in [dspace-1.4.x-source]/lib with the new version.
Take down Tomcat (or whichever servlet container you're using).
A new configuration item webui.html.max-depth-guess has been added to avoid infinite URL spaces. Add the following to the dspace.cfg file:
#### Multi-file HTML document/site settings ##### # # When serving up composite HTML items, how deep can the request be for us to # serve up a file with the same name? # # e.g. if we receive a request for "foo/bar/index.html" # and we have a bitstream called just "index.html" # we will serve up that bitstream for the request if webui.html.max-depth-guess # is 2 or greater. If webui.html.max-depth-guess is 1 or less, we 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. Default value is 3. # webui.html.max-depth-guess = 3
If webui.html.max-depth-guess is not present in dspace.cfg the default value is used. If archiving entire web sites or deeply nested HTML documents it is advisable to change the default to a higher value more suitable for these types of materials.
Your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. If you have locally modified JSPs in your [dspace]/jsp/local directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the diff command to compare your JSPs against the 1.4.x versions to do this. You can also check against the DSpace CVS.
In [dspace-1.4.x-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
Copy the .war Web application files in [dspace-1.4.x-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.4.x-source]/build/*.war [tomcat]/webapps
If you're using Tomcat, you need to delete the directories corresponding to the old .war files. For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete the [tomcat]/webapps/dspace directory. Otherwise, Tomcat will continue to use the old code in that directory.
Restart Tomcat.
First and foremost, make a complete backup of your system, including:
A snapshot of the database
The asset store ([dspace]/assetstore by default)
Your configuration files and localized JSPs
Download the latest DSpace 1.4.x source bundle and unpack it in a suitable location (not over your existing DSpace installation or source tree!)
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib cp postgresql.jar [dspace-1.4.x-source]/lib
Note: Licensing conditions for the handle.jar file have changed. As a result, the latest version of the handle.jar file is not included in this distribution. It is recommended you read the new license conditions and decide whether you wish to update your installation's handle.jar. If you decide to update, you should replace the existing handle.jar in [dspace-1.4.x-source]/lib with the new version.
Take down Tomcat (or whichever servlet container you're using).
Your DSpace configuration will need some updating:
In dspace.cfg, paste in the following lines for the new stackable authentication feature, the new method for managing Media Filters, and the Checksum Checker.
#### Stackable Authentication Methods #####
# Stack of authentication methods
# (See org.dspace.eperson.AuthenticationManager)
plugin.sequence.org.dspace.eperson.AuthenticationMethod = \
org.dspace.eperson.PasswordAuthentication
#### Example of configuring X.509 authentication
#### (to use it, add org.dspace.eperson.X509Authentication to stack)
## method 1, using keystore
#authentication.x509.keystore.path = /var/local/tomcat/conf/keystore
#authentication.x509.keystore.password = changeit
## method 2, using CA certificate
#authentication.x509.ca.cert = ${dspace.dir}/config/mitClientCA.der
## Create e-persons for unknown names in valid certificates?
#authentication.x509.autoregister = true
#### Media Filter plugins (through PluginManager) ####
plugin.sequence.org.dspace.app.mediafilter.MediaFilter = \
org.dspace.app.mediafilter.PDFFilter,
org.dspace.app.mediafilter.HTMLFilter, \
org.dspace.app.mediafilter.WordFilter,
org.dspace.app.mediafilter.JPEGFilter
# to enable branded preview: remove last line above, and uncomment 2
lines below
# org.dspace.app.mediafilter.WordFilter,
org.dspace.app.mediafilter.JPEGFilter, \
# org.dspace.app.mediafilter.BrandedPreviewJPEGFilter
filter.org.dspace.app.mediafilter.PDFFilter.inputFormats = Adobe PDF
filter.org.dspace.app.mediafilter.HTMLFilter.inputFormats = HTML,
Text
filter.org.dspace.app.mediafilter.WordFilter.inputFormats = Microsoft
Word
filter.org.dspace.app.mediafilter.JPEGFilter.inputFormats = GIF,
JPEG, image/png
filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormat
s = GIF, JPEG, image/png
#### Settings for Item Preview ####
webui.preview.enabled = false
# max dimensions of the preview image
webui.preview.maxwidth = 600
webui.preview.maxheight = 600
# the brand text
webui.preview.brand = My Institution Name
# an abbreviated form of the above text, this will be used
# when the preview image cannot fit the normal text
webui.preview.brand.abbrev = MyOrg
# the height of the brand
webui.preview.brand.height = 20
# font settings for the brand text
webui.preview.brand.font = SansSerif
webui.preview.brand.fontpoint = 12
#webui.preview.dc = rights
#### Checksum Checker Settings ####
# Default dispatcher in case none specified
plugin.single.org.dspace.checker.BitstreamDispatcher=org.dspace.checke
r.SimpleDispatcher
# Standard interface implementations. You shouldn't need to tinker
with these.
plugin.single.org.dspace.checker.ReporterDAO=org.dspace.checker.Report
erDAOImpl
# check history retention
checker.retention.default=10y
checker.retention.CHECKSUM_MATCH=8w
If you have customised advanced search fields (search.index.n fields, note that you now need to include the schema in the values. Dublin Core is specifed as dc. So for example, if in 1.3.2 you had:
search.index.1 = title:title.alternative
That needs to be changed to:
search.index.1 = title:dc.title.alternative
If you use LDAP or X509 authentication, you'll need to add org.dspace.eperson.LDAPAuthentication or org.dspace.eperson.X509Authentication respectively. See also configuring custom authentication code.
If you have custom Media Filters, note that these are now configured through dspace.cfg (instead of mediafilter.cfg which is obsolete.)
Also, take a look through the default dspace.cfg file supplied with DSpace 1.4.x, as this contains configuration options for various new features you might like to use. In general, these new features default to 'off' and you'll need to add configuration properties as described in the default 1.4.x dspace.cfg to activate them.
Your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. If you have locally modified JSPs in your [dspace]/jsp/local directory, you will need to merge the changes in the new 1.4.x versions into your locally modified ones. You can use the diff command to compare your JSPs against the 1.4.x versions to do this. You can also check against the DSpace CVS.
In [dspace-1.4.x-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
The database schema needs updating. SQL files containing the relevant file are provided. If you've modified the schema locally, you may need to check over this and make alterations.
[dspace-1.4.x-source]/etc/database_schema_13-14.sql contains the SQL commands to achieve this for PostgreSQL. To apply the changes, go to the source directory, and run:
psql -f etc/database_schema_13-14.sql [DSpace database name] -h localhost
[dspace-1.4.x-source]/etc/oracle/database_schema_13-14.sql should be run on the DSpace database to update the schema.
Rebuild the search indices:
[dspace]/bin/index-all
Copy the .war Web application files in [dspace-1.4-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.4-source]/build/*.war [tomcat]/webapps
If you're using Tomcat, you need to delete the directories corresponding to the old .war files. For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete the [tomcat]/webapps/dspace directory. Otherwise, Tomcat will continue to use the old code in that directory.
Restart Tomcat.
The changes in 1.3.2 are only code changes so the update is simply a matter of rebuilding the wars.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.3.2-source] to the source directory for DSpace 1.3.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Get the new DSpace 1.3.2 source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib cp postgresql.jar [dspace-1.3.2-source]/lib
Take down Tomcat (or whichever servlet container you're using).
Your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. If you have locally modified JSPs in your [dspace]/jsp/local directory, you will need to merge the changes in the new 1.3.2 versions into your locally modified ones. You can use the diff command to compare the 1.3.1 and 1.3.2 versions to do this.
In [dspace-1.3.2-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
Copy the .war Web application files in [dspace-1.3.2-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.3.2-source]/build/*.war [tomcat]/webapps
If you're using Tomcat, you need to delete the directories corresponding to the old .war files. For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete the [tomcat]/webapps/dspace directory. Otherwise, Tomcat will continue to use the old code in that directory.
Restart Tomcat.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.3.x-source] to the source directory for DSpace 1.3.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Step one is, of course, to back up all your data before proceeding!! Include all of the contents of [dspace] and the PostgreSQL database in your backup.
Get the new DSpace 1.3.x source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib
cp postgresql.jar [dspace-1.2.2-source]/lib
Take down Tomcat (or whichever servlet container you're using).
Remove the old version of xerces.jar from your installation, so it is not inadvertently later used:
rm [dspace]/lib/xerces.jar
Install the new config files by moving dstat.cfg and dstat.map from [dspace-1.3.x-source]/config/ to [dspace]/config
You need to add new parameters to your [dspace]/dspace.cfg:
###### Statistical Report Configuration Settings ######
# should the stats be publicly available? should be set to false if
you only
# want administrators to access the stats, or you do not intend to
generate
# any
report.public = false
# directory where live reports are stored
report.dir = /dspace/reports/
Build and install the updated DSpace 1.3.x code. Go to the [dspace-1.3.x-source] directory, and run:
ant -Dconfig=[dspace]/config/dspace.cfg update
You'll need to make some changes to the database schema in your PostgreSQL database. [dspace-1.3.x-source]/etc/database_schema_12-13.sql contains the SQL commands to achieve this. If you've modified the schema locally, you may need to check over this and make alterations.
To apply the changes, go to the source directory, and run:
psql -f etc/database_schema_12-13.sql [DSpace database name] -h localhost
Customise the stat generating statistics as per the instructions in System Statistical Reports
Initialise the statistics using:
[dspace]/bin/stat-initial
[dspace]/bin/stat-general
[dspace]/bin/stat-report-initial
[dspace]/bin/stat-report-general
Rebuild the search indices:
[dspace]/bin/index-all
Copy the .war Web application files in [dspace-1.3.x-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.3.x-source]/build/*.war [tomcat]/webapps
Restart Tomcat.
The changes in 1.2.2 are only code and config changes so the update should be fairly simple.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.2.2-source] to the source directory for DSpace 1.2.2. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Get the new DSpace 1.2.2 source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib cp postgresql.jar [dspace-1.2.2-source]/lib
Take down Tomcat (or whichever servlet container you're using).
Your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. If you have locally modified JSPs in your [dspace]/jsp/local directory, you might like to merge the changes in the new 1.2.2 versions into your locally modified ones. You can use the diff command to compare the 1.2.1 and 1.2.2 versions to do this. Also see the version history for a list of modified JSPs.
You need to add a new parameter to your [dspace]/dspace.cfg for configurable fulltext indexing
##### Fulltext Indexing settings ##### # Maximum number of terms indexed for a single field in Lucene. # Default is 10,000 words - often not enough for full-text indexing. # If you change this, you'll need to re-index for the change # to take effect on previously added items. # -1 = unlimited (Integer.MAX_VALUE) search.maxfieldlength = 10000
In [dspace-1.2.2-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
Copy the .war Web application files in [dspace-1.2.2-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.2.2-source]/build/*.war [tomcat]/webapps
If you're using Tomcat, you need to delete the directories corresponding to the old .war files. For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete the [tomcat]/webapps/dspace directory. Otherwise, Tomcat will continue to use the old code in that directory.
To finialise the install of the new configurable submission forms you need to copy the file [dspace-1.2.2-source]/config/input-forms.xml into [dspace]/config.
Restart Tomcat.
The changes in 1.2.1 are only code changes so the update should be fairly simple.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.2.1-source] to the source directory for DSpace 1.2.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Get the new DSpace 1.2.1 source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the PostgreSQL driver JAR to the source tree. For example:
cd [dspace]/lib cp postgresql.jar [dspace-1.2.1-source]/lib
Take down Tomcat (or whichever servlet container you're using).
Your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. If you have locally modified JSPs in your [dspace]/jsp/local directory, you might like to merge the changes in the new 1.2.1 versions into your locally modified ones. You can use the diff command to compare the 1.2 and 1.2.1 versions to do this. Also see the version history for a list of modified JSPs.
You need to add a few new parameters to your [dspace]/dspace.cfg for browse/search and item thumbnails display, and for configurable DC metadata fields to be indexed.
# whether to display thumbnails on browse and search results pages (1.2+) webui.browse.thumbnail.show = false # max dimensions of the browse/search thumbs. Must be <= thumbnail.maxwidth # and thumbnail.maxheight. Only need to be set if required to be smaller than # dimension of thumbnails generated by mediafilter (1.2+) #webui.browse.thumbnail.maxheight = 80 #webui.browse.thumbnail.maxwidth = 80 # whether to display the thumb against each bitstream (1.2+) webui.item.thumbnail.show = true # where should clicking on a thumbnail from browse/search take the user # Only values currently supported are "item" and "bitstream" #webui.browse.thumbnail.linkbehaviour = item ##### Fields to Index for Search ##### # DC metadata elements.qualifiers to be indexed for search # format: - search.index.[number] = [search field]:element.qualifier # - * used as wildcard ### changing these will change your search results, ### ### but will NOT automatically change your search displays ### search.index.1 = author:contributor.* search.index.2 = author:creator.* search.index.3 = title:title.* search.index.4 = keyword:subject.* search.index.5 = abstract:description.abstract search.index.6 = author:description.statementofresponsibility search.index.7 = series:relation.ispartofseries search.index.8 = abstract:description.tableofcontents search.index.9 = mime:format.mimetype search.index.10 = sponsor:description.sponsorship search.index.11 = id:identifier.*
In [dspace-1.2.1-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
Copy the .war Web application files in [dspace-1.2.1-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.2.1-source]/build/*.war [tomcat]/webapps
If you're using Tomcat, you need to delete the directories corresponding to the old .war files. For example, if dspace.war is installed in [tomcat]/webapps/dspace.war, you should delete the [tomcat]/webapps/dspace directory. Otherwise, Tomcat will continue to use the old code in that directory.
Restart Tomcat.
The process for upgrading to 1.2 from either 1.1 or 1.1.1 is the same. If you are running DSpace 1.0 or 1.0.1, you need to follow the instructions for upgrading from 1.0.1 to 1.1 to before following these instructions.
Note also that if you've substantially modified DSpace, these instructions apply to an unmodified 1.1.1 DSpace instance, and you'll need to adapt the process to any modifications you've made.
This document refers to the install directory for your existing DSpace installation as [dspace], and to the source directory for DSpace 1.2 as [dspace-1.2-source]. Whenever you see these path references below, be sure to replace them with the actual path names on your local system.
Step one is, of course, to back up all your data before proceeding!! Include all of the contents of [dspace] and the PostgreSQL database in your backup.
Get the new DSpace 1.2 source code from the DSpace page on SourceForge and unpack it somewhere. Do not unpack it on top of your existing installation!!
Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example:
cd [dspace]/lib cp activation.jar servlet.jar mail.jar [dspace-1.2-source]/lib
Stop Tomcat (or other servlet container.)
It's a good idea to upgrade all of the various third-party tools that DSpace uses to their latest versions:
Java (note that now version 1.4.0 or later is required)
Tomcat (Any version after 4.0 will work; symbolic links are no longer an issue)
PostgreSQL (don't forget to build/download an updated JDBC driver .jar file! Also, back up the database first.)
Ant
You need to add the following new parameters to your [dspace]/dspace.cfg:
##### Media Filter settings ##### # maximum width and height of generated thumbnails thumbnail.maxwidth 80 thumbnail.maxheight 80
There are one or two other, optional extra parameters (for controlling the pool of database connections). See the version history for details. If you leave them out, defaults will be used.
Also, to avoid future confusion, you might like to remove the following property, which is no longer required:
config.template.oai-web.xml =
[dspace]/oai/WEB-INF/web.xml
The layout of the installation directory (i.e. the structure of the contents of [dspace]) has changed somewhat since 1.1.1. First up, your 'localized' JSPs (those in jsp/local) now need to be maintained in the source directory. So make a copy of them now!
Once you've done that, you can remove [dspace]/jsp and [dspace]/oai, these are no longer used. (.war Web application archive files are used instead).
Also, if you're using the same version of Tomcat as before, you need to remove the lines from Tomcat's conf/server.xml file that enable symbolic links for DSpace. These are the <Context> elements you added to get DSpace 1.1.1 working, looking something like this:
<Context path="/dspace" docBase="dspace" debug="0" reloadable="true" crossContext="true"> <Resources className="org.apache.naming.resources.FileDirContext" allowLinking="true" /> </Context>
Be sure to remove the <Context> elements for both the Web UI and the OAI Web applications.
Build and install the updated DSpace 1.2 code. Go to the DSpace 1.2 source directory, and run:
ant -Dconfig= [dspace]/config/dspace.cfg update
Copy the new config files in config to your installation, e.g.:
cp [dspace-1.2-source]/config/news-* [dspace-1.2-source]/config/mediafilter.cfg [dspace-1.2-source]/config/dc2mods.cfg [dspace]/config
You'll need to make some changes to the database schema in your PostgreSQL database. [dspace-1.2-source]/etc/database_schema_11-12.sql contains the SQL commands to achieve this. If you've modified the schema locally, you may need to check over this and make alterations.
To apply the changes, go to the source directory, and run:
psql -f etc/database_schema_11-12.sql [DSpace database name] -h localhost
A tool supplied with the DSpace 1.2 codebase will then update the actual data in the relational database. Run it using:
[dspace]/bin/dsrun
org.dspace.administer.Upgrade11To12
Then rebuild the search indices:
[dspace]/bin/index-all
Delete the existing symlinks from your servlet container's (e.g. Tomcat's) webapp sub-directory.
Copy the .war Web application files in [dspace-1.2-source]/build to the webapps sub-directory of your servlet container (e.g. Tomcat). e.g.:
cp [dspace-1.2-source]/build/*.war [tomcat]/webapps
Restart Tomcat.
To get image thumbnails generated and full-text extracted for indexing automatically, you need to set up a 'cron' job, for example one like this:
# Run the media filter at 02:00 every day
0 2 * * * [dspace]/bin/filter-media
You might also wish to run it now to generate thumbnails and index full text for the content already in your system.
Note 1: This update process has effectively 'touched' all of your items. Although the dates in the Dublin Core metadata won't have changed (accession date and so forth), the 'last modified' date in the database for each will have been changed.
This means the e-mail subscription tool may be confused, thinking that all items in the archive have been deposited that day, and could thus send a rather long email to lots of subscribers. So, it is recommended that you turn off the e-mail subscription feature for the next day, by commenting out the relevant line in DSpace's cron job, and then re-activating it the next day.
Say you performed the update on 08-June-2004 (UTC), and your e-mail subscription cron job runs at 4am (UTC). When the subscription tool runs at 4am on 09-June-2004, it will find that everything in the system has a modification date in 08-June-2004, and accordingly send out huge emails. So, immediately after the update, you would edit DSpace's 'crontab' and comment out the /dspace/bin/subs-daily line. Then, after 4am on 09-June-2004 you'd 'un-comment' it out, so that things proceed normally.
Of course this means, any real new deposits on 08-June-2004 won't get e-mailed, however if you're updating the system it's likely to be down for some time so this shouldn't be a big problem.
Note 2: After consulation with the OAI community, various OAI-PMH changes have occurred:
The OAI-PMH identifiers have changed (they're now of the form oai:hostname:handle as opposed to just Handles)
The set structure has changed, due to the new sub-communities feature.
The default base URL has changed
As noted in note 1, every item has been 'touched' and will need re-harvesting.
The above means that, if already registered and harvested, you will need to re-register your repository, effectively as a 'new' OAI-PMH data provider. You should also consider posting an announcement to the OAI implementers e-mail list so that harvesters know to update their systems.
Also note that your site may, over the next few days, take quite a big hit from OAI-PMH harvesters. The resumption token support should alleviate this a little, but you might want to temporarily whack up the database connection pool parameters in [dspace]/config/dspace.cfg. See the dspace.cfg distributed with the source code to see what these parameters are and how to use them. (You need to stop and restart Tomcat after changing them.)
I realize this is not ideal; for discussion as to the reasons behind this please see relevant posts to the OAI community: post one, post two, as well as this post to the dspace-tech mailing list.
If you really can't live with updating the base URL like this, you can fairly easily have thing proceed more-or-less as they are, by doing the following:
Change the value of OAI_ID_PREFIX at the top of the org.dspace.app.oai.DSpaceOAICatalog class to hdl:
Change the servlet mapping for the OAIHandler servlet back to / (from /request)
Rebuild and deploy oai.war
However, note that in this case, all the records will be re-harvested by harvesters anyway, so you still need to brace for the associated DB activity; also note that the set spec changes may not be picked up by some harvesters. It's recommended you read the above-linked mailing list posts to understand why the change was made.
Now, you should be finished!
Fortunately the changes in 1.1.1 are only code changes so the update is fairly simple.
In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.1.1-source] to the source directory for DSpace 1.1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Take down Tomcat.
It would be a good idea to update any of the third-party tools used by DSpace at this point (e.g. PostgreSQL), following the instructions provided with the relevant tools.
In [dspace-1.1.1-source] run:
ant -Dconfig= [dspace]/config/dspace.cfg update
If you have locally modified JSPs of the following JSPs in your [dspace]/jsp/local directory, you might like to merge the changes in the new 1.1.1 versions into your locally modified ones. You can use the diff command to compare the 1.1 and 1.1.1 versions to do this. The changes are quite minor.
collection-home.jsp admin/authorize-collection-edit.jsp admin/authorize-community-edit.jsp admin/authorize-item-edit.jsp admin/eperson-edit.jsp
Restart Tomcat.
To upgrade from DSpace 1.0.1 to 1.1, follow the steps below. Your dspace.cfg does not need to be changed. In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-1.1-source] to the source directory for DSpace 1.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
Take down Tomcat (or whichever servlet container you're using).
We recommend that you upgrage to the latest version of PostgreSQL (7.3.2). Included are some notes to help you do this. Note you will also have to upgrade Ant to version 1.5 if you do this.
Make the necessary changes to the DSpace database. These include a couple of minor schema changes, and some new indices which should improve performance. Also, the names of a couple of database views have been changed since the old names were so long they were causing problems. First run psql to access your database (e.g. psql -U dspace -W and then enter the password), and enter these SQL commands:
ALTER TABLE bitstream ADD store_number INTEGER; UPDATE bitstream SET store_number = 0; ALTER TABLE item ADD last_modified TIMESTAMP; CREATE INDEX last_modified_idx ON Item(last_modified); CREATE INDEX eperson_email_idx ON EPerson(email); CREATE INDEX item2bundle_item_idx on Item2Bundle(item_id); REATE INDEX bundle2bitstream_bundle_idx ON Bundle2Bitstream(bundle_id); CREATE INDEX dcvalue_item_idx on DCValue(item_id); CREATE INDEX collection2item_collection_idx ON Collection2Item(collection_id); CREATE INDEX resourcepolicy_type_id_idx ON ResourcePolicy (resource_type_id,resource_id); CREATE INDEX epersongroup2eperson_group_idx on EPersonGroup2EPerson(eperson_group_id); CREATE INDEX handle_handle_idx ON Handle(handle); CREATE INDEX sort_author_idx on ItemsByAuthor(sort_author); CREATE INDEX sort_title_idx on ItemsByTitle(sort_title); CREATE INDEX date_issued_idx on ItemsByDate(date_issued); DROP VIEW CollectionItemsByDateAccessioned; DROP VIEW CommunityItemsByDateAccessioned; CREATE VIEW CommunityItemsByDateAccession as SELECT Community2Item.community_id, ItemsByDateAccessioned.* FROM ItemsByDateAccessioned, Community2Item WHERE ItemsByDateAccessioned.item_id = Community2Item.item_id; CREATE VIEW CollectionItemsByDateAccession AS SELECT collection2item.collection_id, itemsbydateaccessioned.items_by_date_accessioned_id, itemsbydateaccessioned.item_id, itemsbydateaccessioned.date_accessioned FROM itemsbydateaccessioned, collection2item WHERE (itemsbydateaccessioned.item_id = collection2item.item_id);
Fix your JSPs for Unicode. If you've modified the site 'skin' (jsp/local/layout/header-default.jsp) you'll need to add the Unicode header, i.e.:
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
to the <HEAD> element. If you have any locally-edited JSPs, you need to add this page directive to the top of all of them:
<%@ page contentType="text/html;charset=UTF-8" %>
(If you haven't modified any JSPs, you don't have to do anything.)
Copy the required Java libraries that we couldn't include in the bundle to the source tree. For example:
cd [dspace]/lib cp *.policy activation.jar servlet.jar mail.jar [dspace-1.1-source]/lib
Compile up the new DSpace code, replacing [dspace]/config/dspace.cfg with the path to your current, LIVE configuration. (The second line, touch `find .`, is a precaution, which ensures that the new code has a current datestamp and will overwrite the old code. Note that those are back quotes.)
cd [dspace-1.1-source] touch `find .` ant ant -Dconfig= [dspace]/config/dspace.cfg update
Update the database tables using the upgrader tool, which sets up the new >last_modified date in the item table:
Run [dspace]/bin/dsrun
org.dspace.administer.Upgrade101To11
Run the collection default authorisation policy tool:
[dspace]/bin/dsrun
org.dspace.authorize.FixDefaultPolicies
Fix the OAICat properties file. Edit [dspace]/config/templates/oaicat.properties. Change the line that says
Identify.deletedRecord=yes
To:
Identify.deletedRecord=persistent
This is needed to fix the OAI-PMH 'Identity' verb response. Then run [dspace]/bin/install-configs.
Re-run the indexing to index abstracts and fill out the renamed database views:
[dspace]/bin/index-all
Restart Tomcat. Tomcat should be run with the following environment variable set, to ensure that Unicode is handled properly. Also, the default JVM memory heap sizes are rather small. Adjust -Xmx512M (512Mb maximum heap size) and -Xms64M (64Mb Java thread stack size) to suit your hardware.
JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
Copyright © 2002-2009 The DSpace Foundation