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.
The changes in DSpace 1.5.2 do not include any database schema upgrades, and the upgrade should be straightforward.
- 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 DSpace.org 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. 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:
- 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.
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:
- Special groups for LDAP and password authentication.
- new option for case insensitivity in browse tables.
- New usage event handler for collecting statistics:
- The location where sitemaps are stored is now configurable.
- 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:
- Hierarchical LDAP support.
- Shibboleth authentication support.
- DOI and handle identifiers can now be rendered in the JSPUI. In configuration sections such as webui.itemdisplay.default, values can be changed from (e.g.) metadata.dc.identifier.doi to metadata.doi.dc.identifier.doi
- The whole of the SWORD configuration has changed. The SWORD section must be removed and replaced with
- Restart Tomcat Restart your servlet container, for Tomcat use the bin/startup.sh script.