Versions Compared

Old Version 5

changes.mady.by.user Robin Taylor

Saved on

compared with

New Version 6

changes.mady.by.user Robin Taylor

Saved on

Key

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

In the notes below [dspace] refers to the install directory for your existing DSpace installation, and [dspace-source] to the source directory for DSpace 3.0. Whenever you see these path references, be sure to replace them with the actual path names on your local system. You should also check the DSpace Release 3.0 Notes to to see what changes are in this version.

...

Note
titleChanges to the DSpace 3.0 Upgrade / Configuration Process

In DSpace 3.0 there have been a few significant changes to how you upgrade and configure DSpace. Notably:

  • A build.properties file has been introduced: Many "module" configurations have now been moved out of the 'dspace.cfg' and into separate configuration files in the [dspace]/config/modules/directory.
    This file provides a convenient place to set the most commonly used configuration properties held in dspace.cfg. For a more detailed explanation please refer to the Installation and Configuration sections.

Backup your DSpace

Before you start your upgrade, it is strongly recommended that you create a backup of your DSpace instance. Backups are easy to recover from; a botched install/upgrade is very difficult if not impossible to recover from. The DSpace specific things to backup are: configs, source code modifications, database, and assetstore. On your server that runs DSpace, you might additionally consider checking on your cron/scheduled tasks, servlet container, and database.

...

  1. Download DSpace 3.0: Either download DSpace 3.0 from DSpace.org or check it out directly from the SVN code Github 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:
    • JSPUI modifications: [dspace-source]/dspace/modules/jspui/src/main/webapp/
    • XMLUI modifications: [dspace-source]/dspace/modules/xmlui/src/main/webapp/
    • Config modifications: [dspace]/config

  3. Build DSpace. Run the following commands to compile DSpace:

    No Format
    cd [dspace-source]/dspace/
mvn -U clean package

    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/shutdown.sh 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
    2. No database changes have been made in either 1.8.1 or 1.8.2. So there is no need to update your existing 1.8 database.
  6. Update your DSpace Configurations.
    1. There are no new configurations for the 1.8.1 or 1.8.2 releases. Your existing 1.8 configuration files should work fine

  7. Refresh Browse and Search Indexes. To do this, run the following command from your DSpace install directory (as the dspace user):

    Code Block
    [dspace]/bin/dspace index-init

  8. Deploy Web Applications. If necessary, copy the web applications files from your [dspace]/webappsdirectory 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.