This documentation relates to an old version of DSpace, version 4.x. Looking for another version? See all documentation.
These instructions are valid for any of the following upgrade paths:
- Upgrading 4.0 or 4.1 to 4.2
For more information about specific fixes released in each 4.x version, please refer to the Release Notes.
In the notes below
[dspace] refers to the install directory for your existing DSpace installation, and
[dspace-source] to the source directory for DSpace 4.x. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
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.
Make a complete backup of your system, including:
Database: Make a snapshot/dump of the database. For the PostgreSQL database use Postgres' pg_dump command. For example:
- Assetstore: Backup the directory (
[dspace]/assetstoreby default, and any other assetstores configured in the
[dspace]/config/dspace.cfg"assetstore.dir" and "assetstore.dir.#" settings)
- Configuration: Backup the entire directory content of
- Customizations: If you have custom code, such as themes, modifications, or custom scripts, you will want to back them up to a safe location.
- Download DSpace 4.x: Either download DSpace 4.x from DSpace.org or check it out directly from the 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.
- Merge any customizations (if needed). If you have made any local customizations to your DSpace installation they may need to be migrated over to the new DSpace. For minor upgrades, there are often fewer changes, but it is still worth checking to see if any effect your customizations. Customizations are typically housed in one of the following places:
- JSPUI modifications:
- XMLUI modifications:
- Config modifications:
- JSPUI modifications:
- Edit the build.properties file (if needed) (
[dspace-source]/build.properties). As this is a minor upgrade, your previous 4.x build.properties file should work fine. However, you may want to double check your settings. Any settings changed in this
build.propertiesfile are automatically copied over to the final
dspace.cfgfile during the "Build DSpace" process (in the next step). For more information on the build.properties file, see "The build.properties Configuration Properties File" section of the Configuration Reference documentation.
Build DSpace. Run the following commands to compile DSpace:
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.
- Stop Tomcat. Take down your servlet container. For Tomcat, use the
$CATALINA_HOME/shutdown.shscript. (Many Unix-based installations will have a startup/shutdown script in the
- Update DSpace.
Update the DSpace installed directory with the new code and libraries. Issue the following commands:
- No database changes have been made in DSpace 4.1. So, there is no need to update your existing DSpace 4.x database.
- Check whether your DSpace instance is affected by either of the below bugs. There were a few database level bugs resolved in DSpace 4.1 and 4.2, which may require some institutions to run a script on their database content to resolve them. These do NOT affect all institutions, but you should be aware of them:
- Fixing the effects of DS-1536 - If your institution uses a Handle prefix which contains a period (e.g. 123.456/x), then you should run the recommended scripts (see below) on your database.
- Fixing the effects of DS-2036 - If your institution uses an Oracle database backend with Discovery (for search/browse), then you should run the recommended script (see below) on your database.
- Update your DSpace Configurations (if needed). There are no new required configurations in DSpace 4.1 or 4.2. So, your existing DSpace 4.x configurations should work fine.
Refresh Browse and Search Indexes. Though there are not any database changes, it is a good policy to rebuild your search and browse indexes when upgrading to a new release. To do this, run the following command from your DSpace install directory (as the dspace user):
If you're still using Lucene (you disabled Discovery): If you are using Lucene for search/browse, you will also need to refresh Lucene indexes by running the following command:
Deploy Web Applications. If necessary, copy the web applications files from your
[dspace]/webappsdirectory to the subdirectory of your servlet container (e.g. Tomcat):
See the installation guide for full details.
- Restart servlet container. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.
Fixing the effects of DS-1536
If you're affected by - DS-1536Getting issue details... STATUS , DSpace 4.1 fixes it, but you still need to fix the incorrect metadata generated by DSpace 4.0. To do so, execute the following SQL against the DSpace database. PLEASE ensure you test these scripts on a non-Production server, and also you have backed up your database PRIOR to running the scripts. Replace XXXXX with your handle prefix before the dot; e.g. if your prefix is "10123.1", replace "XXXXX" with "10123".
The following code is tested to work with Postgres. The Oracle code is believed to work, but hasn't been tested on an affected instance. Make sure to have a proper database backup before trying either version and to verify whether it fixed the problem before moving on.
Instructions for Postgres
Instructions for Oracle
Fixing the effects of DS-2036
If you previously upgraded DSpace from 1.8.x to 3.0 and you use Oracle as your DBMS, you may be affected by - DS-2036Getting issue details... STATUS . The following SQL statement should correct the problem. PLEASE ensure you test these scripts on a non-Production server, and that you have backed up your database PRIOR to running the scripts.