This documentation relates to an old version of DSpace, version 3.x. Looking for another version? See all documentation.
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.
- Backup Your DSpace. First, and foremost, make a complete backup of your system, including:
- A snapshot of the database. _To have a "snapshot" of the PostgreSQL database, you need to shut it down during the backup. You should also have your regular PostgreSQL Backup output (using pg_dump commands). _
- The asset store ([dspace]/assetstore by default)
- Your configuration files and customizations to DSpace (including any customized scripts).
- Download DSpace 1.6.x Retrieve the new DSpace 1.6.x 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. Refer to Installation Instructions, Step 3 for unpacking directives.
- Stop Tomcat. Take down your servlet container. For Tomcat, use the $CATALINA/shutdown.sh script. (Many installations will have a startup/shutdown script in the /etc/init.d or /etc/rc.d directories.
- 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:
- JSPUI modifications:
- XMLUI modifications:
- JSPUI modifications:
- Update Configuration Files. Some of the parameters have change and some are new. Changes will be noted below:
- **CHANGE** The base url and oai urls property keys are set differently
- **NEW** New email options (Add these at the end of the "Email Settings" sub-section):
- **NEW**New Authorization levels and parameters. See the Configuration documentation, "Delegation Administration" section for further information.
- **CHANGE** METS ingester has been revised. (Modify In "Crosswalk and Packager Plugin Settings")
- **CHANGE** Event Settings have had the following revision with the addition of 'harvester' (modify in "Event System Configuration"): also:
- **NEW** New option for the Embargo of Thesis and Dissertations.
- **NEW** New option for using the Batch Editing capabilities. See Batch Metadata Editing Configuration and also System Administration : Batch Metadata Editing
- **NEW** Ability to hide metadata fields is now available. (Look for "JSPUI & XMLUI Configurations" Section)
- **NEW**Choice Control and Authority Control options are available (Look for "JSPUI & XMLUI Configurations" Section): And also:
- **REPLACE** RSS Feeds now support Atom 1.0. Replace its previous configuration with the one below:
- **NEW** Opensearch Feature is new to DSpace
- **NEW* *Exposure of METS metadata can be now hidden. (See "OAI-PMH SPECIFIC CONFIGURATIONS" in the dspace.cfg file)
- **NEW* *SWORD has added the following to accept MIME/types. (See "SWORD Specific Configurations" Section)
- **NEW* *New OAI Harvesting Configuration settings are now available. (See "OAI Harvesting Configurations"
- **NEW** SOLR Statistics Configurations. For a little more detailed information regarding the configuration, please refer to DSpace SOLR Statistics Configuration ; or, for installation procedures, refer to Advanced Installation: Dspace Statistics.
- 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, 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.
- 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.
- For PostgreSQL:
psql -U [dspace-user] -f [dspace-source]/dspace/etc/postgres/database_schema_15-16.sql [database name](Your database name is by default 'dspace'). Example:
psql -U dspace -f /dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15-16.sql dspace
- For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output:
- Start SQL*Plus with
sqlplus [connect args]
- Record the output:
SQL> spool 'upgrade.lst'
- Run the upgrade script
- Turn off recording of output:
SQL> spool off
- Please note: The final few statements WILL FAIL. That is because you have run some queries and use the results to construct the statements to remove the constraints, manually; Oracle doesn't have any easy way to automate this (unless you know PL/SQL). So, look for the comment line beginning: and follow the instructions in the actual SQL file. Refer to the contents of the spool file "upgrade.lst" for the output of the queries you'll need.
- Start SQL*Plus with
- For PostgreSQL:
- Update DSpace. Update the DSpace installed directory with the new code and libraries. Issue the following commands:
- 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 _
- 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
- 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/
- Restart servlet. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.
- 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. System Administration : DSpace Log Converter documentation. The user is highly recommended to see the