All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Old Release
This documentation relates to an old version of DSpace, version 3.x. Looking for another version? See all documentation.
This DSpace release is end-of-life and is no longer supported.
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.8. 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 1.8.0 Notes to see what changes are in this version.
Changes to the DSpace 1.8 Upgrade / Configuration Process
In DSpace 1.8.0, there have been a few significant changes to how you upgrade and configure DSpace. Notably:
[dspace]/config/modules/
directory.
[dspace]/config/modules/authentication*.cfg
files[dspace]/config/modules/bulkedit.cfg
file[dspace]/config/modules/discovery.cfg
file[dspace]/config/modules/oai.cfg
file[dspace]/config/modules/solr-statistics.cfg
file[dspace]/config/modules/sword*.cfg
filesdspace.cfg
configuration file.ant update
upgrade command now defaults to replacing any existing configuration files (though the existing configuration files will first be backed up to a file with the suffix *.old
).
ant update
command would leave existing configuration files intact (and you would have to manually merge in new configuration settings, which would be in a file with the suffix *.new
). If you prefer this previous behavior, you can still achieve the same result by running:
ant -Doverwrite=false update
ant -Doverwrite=false update
please be aware that this will not auto-upgrade any of your configuration files. This means you must closely watch the output of this command, and ensure you manually upgrade all configuration files in the [dspace]/config/
directory as well as all Solr configurations/schemas in the [dspace]/solr/search/conf/
and [dspace]/solr/statistics/conf/
directories.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:
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
cd [dspace-source]/dspace/ mvn -U clean package
[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.)cd [dspace-source]/dspace/target/dspace-[version]-build.dir ant -Dconfig=[dspace]/config/dspace.cfg update
Changes to the behavior of the 'ant update' script
The ant update
script has changed slightly as of DSpace 1.8. It now defaults to replacing your existing configuration files (after backing them up first). See the Changes to the DSpace 1.8 Upgrade / Configuration Process note at the top of this page for more details.
[dspace]/bin/dspace index-init
[dspace]/webapps
directory to the subdirectory of your servlet container (e.g. tomcat):
cp -R [dspace]/webapps/* [tomcat]/webapps/