These instructions are valid for any of the following upgrade paths:
For more information about specific fixes released in each 3.x version, please refer to the appropriate release notes: |
In the notes below |
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:
pg_dump -U [database-user] -f [backup-file-location] [database-name] |
[dspace]/assetstore
by default, and any other assetstores configured in the [dspace]/config/dspace.cfg
"assetstore.dir" and "assetstore.dir.#" settings)[dspace]/config
.[dspace-source]/dspace/modules/jspui/src/main/webapp/
[dspace-source]/dspace/modules/xmlui/src/main/webapp/
[dspace]/config
[dspace-source]/build.properties
). As this is a minor upgrade, your previous 3.x build.properties file should work fine. However, you may want to double check your settings. Any settings changed in this build.properties
file are automatically copied over to the final dspace.cfg
file 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 documentation.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 ('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.
$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.)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 update |
[dspace]/config/modules/oai.cfg
file. They have been reinstated in DSpace 3.1 or above. Please see DS-1461 for more info.[dspace]/config/modules/oai.cfg
file. Please see DS-1479 for more info.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):
[dspace]/bin/dspace index-init |
Refresh Discovery: If you are using Discovery (Solr) for search/browse, you will also need to refresh Discovery indexes by running the following command:
[dspace]/bin/dspace update-discovery-index -f |
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):
cp -R [dspace]/webapps/* [tomcat]/webapps/ |
See the installation guide for full details.