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.6. Whenever you see these path references, be sure to replace them with the actual path names on your local system.

Upgrade Steps

  1. Backup Your DSpace. First, and foremost, make a complete backup of your system, including:
  2. Download DSpace 1.6.x Retrieve the new DSpace 1.6.x source code either as a download 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.
  3. Stop Tomcat. Take down your servlet container. For Tomcat, use the $CATALINA/ script. (Many installations will have a startup/shutdown script in the /etc/init.d or /etc/rc.d directories.
  4. 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. These are housed in one of the following places:
  5. Update Configuration Files. Some of the parameters have change and some are new. Changes will be noted below:
  6. Build DSpace. Run the following commands to compile DSpace.:
    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, 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.
  7. Update the database. The database schema needs to be updated to accommodate changes to the database. SQL files contain the relevant updates are provided. Please note that if you have made any local customizations to the database schema, you should consult these updates and make sure they will work for you.
  8. Update DSpace. Update the DSpace installed directory with the new code and libraries. Issue the following commands:
    cd [dspace-source]/dspace/target/dspace-[version]-build.dir
    ant -Dconfig=[dspace]/config/dspace.cfg update
  9. Update Registry for the CC License. If you use the CC License, an incorrect mime-type type is being assigned. You will need to run the following step: _dspace]/bin/dspace registry-loader -bitstream [dspace]/etc/upgrades/15-16/new-bitstream-formats.xml _
  10. Generate Browse and Search Indexes. It makes good policy to rebuild your search and browse indexes when upgrading to a new release. Almost every release has database changes and indexes can be affected by this. In the DSpace 1.6 release there is Authority Control features and those will need the indexes to be regenerated. To do this, run the following command from your DSpace install directory (as the dspace user):[dspace]/bin/dspace index-init
  11. Deploy Web Applications. Copy the web applications files from your [dspace]/webapps directory to the subdirectory of your servlet container (e.g. tomcat):cp -R [dspace]/webapps/* [tomcat]/webapps/
  12. Restart servlet. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.
  13. Rolling Log Appender Upgrade. You will want to upgrade your logs to the new format to use the SOLR Statistics now included with DSpace. While the commands for this are found in Chapter 8, here are the steps needed to be performed.
    [dspace]/bin/dspace stats-log-converter -i input file name -o output file name -m (if you have more than one dspace.log file)
    [dspace]/bin/dspace stats-log-importer -i input file name (probably the output name from above) -m
    The user is highly recommended to see the System Administration : DSpace Log Converter documentation.