DSpace System Documentation: Updating a DSpace Installation

Back to 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.

Updating From 1.4.2 to 1.5

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.

  1. Backup your DSpace

    First and foremost, make a complete backup of your system, including:


  2. 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.

  3. 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.

  4. Stop Tomcat

    Take down your servlet container, for Tomcat use the bin/shutdown.sh script.

  5. 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
  6. 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
  7. 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
  8. 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

  9. 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

  10. 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.

  11. 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.

  12. 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
  13. 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
  14. 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/target/dspace-1.5-build.dir/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

  15. 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/
  16. Restart Tomcat

    Restart your servlet container, for Tomcat use the bin/startup.sh script.

Updating From 1.4.1 to 1.4.2

See Updating From 1.4 to 1.4.x; the same instructions apply.

Updating From 1.4 to 1.4.x

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.

  1. 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!!

  2. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib
cp postgresql.jar [dspace-1.4.x-source]/lib
  3. 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.

  4. Take down Tomcat (or whichever servlet container you're using).

  5. 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.

  6. 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.

  7. In [dspace-1.4.x-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  8. 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.

  9. Restart Tomcat.

Updating From 1.3.2 to 1.4.x

  1. First and foremost, make a complete backup of your system, including:

  2. 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!)

  3. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib
cp postgresql.jar [dspace-1.4.x-source]/lib
  4. 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.

  5. Take down Tomcat (or whichever servlet container you're using).

  6. Your DSpace configuration will need some updating:

  7. 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.

  8. In [dspace-1.4.x-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  9. 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.

    For PostgreSQL

    [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

    For Oracle

    [dspace-1.4.x-source]/etc/oracle/database_schema_13-14.sql should be run on the DSpace database to update the schema.

  10. Rebuild the search indices:

    [dspace]/bin/index-all

  11. 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.

  12. Restart Tomcat.

Updating From 1.3.1 to 1.3.2

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.

  1. 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!!

  2. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib
cp postgresql.jar [dspace-1.3.2-source]/lib

  3. Take down Tomcat (or whichever servlet container you're using).

  4. 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.

  5. In [dspace-1.3.2-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  6. 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.

  7. Restart Tomcat.

Updating From 1.2.x to 1.3.x

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.

  1. 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.

  2. 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!!

  3. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib

    cp postgresql.jar [dspace-1.2.2-source]/lib

  4. Take down Tomcat (or whichever servlet container you're using).

  5. Remove the old version of xerces.jar from your installation, so it is not inadvertently later used:

    rm [dspace]/lib/xerces.jar

  6. Install the new config files by moving dstat.cfg and dstat.map from [dspace-1.3.x-source]/config/ to [dspace]/config

  7. 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/

  8. 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

  9. 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

  10. Customise the stat generating statistics as per the instructions in System Statistical Reports

  11. Initialise the statistics using:

    [dspace]/bin/stat-initial

    [dspace]/bin/stat-general

    [dspace]/bin/stat-report-initial

    [dspace]/bin/stat-report-general

  12. Rebuild the search indices:

    [dspace]/bin/index-all

  13. 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

  14. Restart Tomcat.

Updating From 1.2.1 to 1.2.2

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.

  1. 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!!

  2. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib
cp postgresql.jar [dspace-1.2.2-source]/lib

  3. Take down Tomcat (or whichever servlet container you're using).

  4. 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.

  5. 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

  6. In [dspace-1.2.2-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  7. 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.

  8. 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.

  9. Restart Tomcat.

Updating From 1.2 to 1.2.1

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.

  1. 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!!

  2. Copy the PostgreSQL driver JAR to the source tree. For example:

    cd [dspace]/lib
cp postgresql.jar [dspace-1.2.1-source]/lib

  3. Take down Tomcat (or whichever servlet container you're using).

  4. 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.

  5. 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.*

  6. In [dspace-1.2.1-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  7. 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.

  8. Restart Tomcat.

Updating From 1.1 (or 1.1.1) to 1.2

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.

  1. 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.

  2. 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!!

  3. 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

  4. Stop Tomcat (or other servlet container.)

  5. It's a good idea to upgrade all of the various third-party tools that DSpace uses to their latest versions:

  6. 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

  7. 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.

  8. 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

  9. 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

  10. 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

  11. 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

  12. Then rebuild the search indices:

    [dspace]/bin/index-all

  13. 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

  14. Restart Tomcat.

  15. 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.

  16. 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.

  17. Note 2: After consulation with the OAI community, various OAI-PMH changes have occurred:

    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:

    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!

Updating From 1.1 to 1.1.1

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.

  1. Take down Tomcat.

  2. 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.

  3. In [dspace-1.1.1-source] run:

    ant -Dconfig=[dspace]/config/dspace.cfg update

  4. 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

  5. Restart Tomcat.

Updating From 1.0.1 to 1.1

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.

  1. Take down Tomcat (or whichever servlet container you're using).

  2. 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.

  3. 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);

  4. 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.)

  5. 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

  6. 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

  7. 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

  8. Run the collection default authorisation policy tool:

    [dspace]/bin/dsrun org.dspace.authorize.FixDefaultPolicies

  9. 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.

  10. Re-run the indexing to index abstracts and fill out the renamed database views:

    [dspace]/bin/index-all

  11. 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-2008 The DSpace Foundation