Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Download DSpace 1.8 Either download DSpace 1.8 from or check it out directly from the SVN code repository. If you downloaded DSpace do not unpack it on top of your existing installation. Refer to Installation Instructions, Step 3 for unpacking directives.
  2. Merge any customizations. If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Customizations are typically housed in one of the following places:
    • Wiki Markup
      JSPUI modifications: {{\[dspace-source\]/dspace/modules/jspui/src/main/webapp/}}
    • Wiki Markup
      XMLUI modifications: {{\[dspace-source\]/dspace/modules/xmlui/src/main/webapp/}}
    • Wiki Markup
      Config modifications: {{\[dspace\]/config}}
  3. Build DSpace. Run the following commands to compile DSpace:
    No Format
    cd [dspace-source]/dspace/
    mvn -U clean package
    Wiki Markup
    You will find the result in {{\[dspace-source\]/dspace/target/dspace-\[version\]-build.dir}} . Inside this directory is the compiled binary distribution of DSpace. Before rebuilding DSpace ('package'), the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven repository.
  4. Stop Tomcat. Take down your servlet container. For Tomcat, use the $CATALINA_HOME/ script. (Many Unix-based installations will have a startup/shutdown script in the /etc/init.d or /etc/rc.d directories.)
  5. Update DSpace.
    1. Update the DSpace installed directory with the new code and libraries. Issue the following commands:
      Code Block
      cd [dspace-source]/dspace/target/dspace-[version]-build.dir
      ant -Dconfig=[dspace]/config/dspace.cfg update
      titleChanges to the behavior of the 'ant update' script

      The ant update script has changed slightly as of DSpace 1.8.0. It now defaults to replacing your existing configuration files (after backing them up first). See the Changes to the DSpace 1.8 Upgrade / Configuration Process note at the top of this page for more details.

    2. Apply database changes to your database by running one of the following database schema upgrade scripts.
      titleBackup Your Database First

      Applying a database change will alter your database! The database upgrade scripts have been tested, however, there is always a chance something could go wrong. So, do yourself a favor and create a backup of your database before you run a script that will alter your database.

      1. Wiki Markup
        PostgreSQL: \[dspace-source\]/dspace/etc/postgres/database_schema_17-18.sql
      2. Wiki Markup
        Oracle: \[dspace-source\]/dspace/etc/oracle/database_schema_17-18.sql
  6. Update your DSpace Configurations.
    1. Wiki Markup
      Merge existing configurations: After updating DSpace, you may notice a series of {{\*.old}} files in your newly updated {{\[dspace\]/config/}} directory (and all sub-directories). During the update process, if there is a difference between your old 1.7-compatible configuration file and the new 1.8-compatible configuration file, your previous settings will be moved to a {{\*.old}} file. You may want to review the differences between the {{\*.old}} file and the new version of that file, and ensure your previous configurations/settings are merged into the new configuration file. One way to compare these files is by using a comparison-utility like {{diff}} or a text editor that supports file comparison.
    2. Set New Configurations: There are new configuration settings in the new release that add or change functionality. You should review these new settings and ensure that they are set according to your needs.
      1. New settings for Creative Commons licensing in dspace.cfg
      2. New settings for RSS feeds (see "webui.feed.podcast.*") in dspace.cfg which now support richer features, such as iTunes podcast and publishing to iTunesU
      3. Several major configuration sections have now been removed from the dspace.cfg and separated into their own config files. Configuration sections which have been moved include Authentication settings, Batch Metadata Editing settings, Discovery settings, OAI-PMH/OAI-ORE settings, Statistics settings and SWORD settings. So, any configurations from these sections should be removed from your existing dspace.cfg file, as they will be ignored. For more information, see the Changes to the DSpace 1.8 Upgrade / Configuration Process note at the top of this page.
      4. Wiki Markup
        Several new configurations files have been created in the {{\[dspace\]/config/modules/}} directory,. eachEach of these correspondingcorresponds to a new featuresfeature in 1.8.0 (or a configuration section which has now been moved out of the dspace.cfg file):
      5. Wiki Markup
        Finally, there is a new {{\[dspace\]/config/spring/}} directory which holds [Spring Framework|] configuration files. _The vast majority of users should never need to modify these settings, but they are available for hardcore developers who wish to add new features via the [DSpace Services Framework] (based on Spring Framework)._
  7. Generate Browse and Search Indexes. The search mechanism has been updated in 1.8, so you must perform a full reindex of your site for searching and browsing to work. To do this, run the following command from your DSpace install directory (as the dspace user):
    Code Block
    [dspace]/bin/dspace index-init
  8. Wiki Markup
    *Deploy Web Applications*. If necessary, copy the web applications files from your {{\[dspace\]/webapps}} directory to the subdirectory of your servlet container (e.g. tomcat):
    Code Block
    cp -R [dspace]/webapps/* [tomcat]/webapps/
    See the installation guide for full details.
  9. Restart servlet container. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.