...
If you are upgrading across multiple versions: You should perform all of the steps of each upgrade between the version from which you are starting and the version to which you are upgrading. You do not need to install each intervening version, but you do need to carry out all of the configuration changes and additions, and all of the database updates, for each one.
Upgrading from 1.7 to 1.7.x
In the notes below Wiki Markup |
---|
{{\[dspace\]}} |
refers to the install directory for your existing DSpace installation, and Wiki Markup |
---|
{{\[dspace-source\]}} |
to the source directory for DSpace 1.7.1. 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).
Wiki Markup |
---|
The asset store (_\[dspace\]/assetstore_ by default) |
- Your configuration files and customizations to DSpace (including any customized scripts).
- Download DSpace 1.7.1 Retrieve the new DSpace 1.7.1 source code either as a download from [DSpace.org|http://www.dspace.org/latest-release/] or check it out directly from the [SVN code repository|http://scm.dspace.org/svn/repo/dspace/tags/dspace-1.7.1/]. If you downloaded DSpace do not unpack it on top of your existing installation. Refer to Chapter 3.3.3 Installation, 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:
Wiki Markup |
---|
JSPUI modifications: _\[dspace-source\]/dspace/modules/jspui/src/main/webapp/_ |
Wiki Markup |
---|
XMLUI modifications: _\[dspace-source\]/dspace/modules/xmlui/src/main/webapp_ |
- Build DSpace. Run the following commands to compile DSpace.:
Code Block |
---|
cd /[dspace-source]/dspace/
mvn -U clean package |
You will find the result in Wiki Markup |
---|
_\[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 DSpace. Update the DSpace installed directory with the new code and libraries. Issue the following commands:
Code Block |
---|
cd [dspace-source]/dspace/target/dspace-[version]-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update |
Wiki Markup |
---|
*Generate Browse and Search Indexes*. Though there are not any database changes between 1.7 and 1.7.1 release, it makes 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_ |
Wiki Markup |
---|
*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.
Upgrading from 1.6.x to 1.7
Wiki Markup |
---|
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.7.0. 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).
Wiki Markup |
---|
The asset store (_\[dspace\]/assetstore_ by default) |
- Your configuration files and customizations to DSpace (including any customized scripts).
- Download DSpace 1.6.1 Retrieve 2 Retrieve the new DSpace 1.6.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. Refer to Chapter 3.3.3 Installation, 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.
Wiki Markup |
---|
*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: _\[dspace-source\]/dspace/modules/jspui/src/main/webapp/_XMLUI modifications: \_\[dspace-source\]/dspace/modules/xmlui/src/main/webapp_ |
- Update Configuration Files. There are no additions to this release. So you do not have to update the configuration files.
- Build DSpace. Run the following commands to compile DSpace.:
Code Block |
---|
cd /[dspace-source]/dspace/
mvn -U clean package |
Wiki Markup |
---|
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 DSpace. Update the DSpace installed directory with the new code and libraries. Issue the following commands:
Code Block |
---|
cd [dspace-source]/dspace/target/dspace-[version]-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update |
Wiki Markup |
---|
*Run Registry Format Update for CC License.* Creative Commons licenses have been assigned the wrong mime-type in past versions of DSpace. Even if you are not currently using CC Licenses, you should update your Bitstream Format Registry to include a new entry with the proper mime-type. To update your registry, run the following command: _dspace\]/bin/dspace registry-loader \-bitstream \[dspace\]/etc/upgrades/15-16/new-bitstream-formats.xml_ |
- Update the Database. If you are using Creative Commons Licenses in your DSpace submission process, you will need to run the 1.5.x to 1.6.x database upgrade script again. In 1.6.0 the improper mime-type was being assigned to all CC Licenses. This has now been resolved, and rerunning the upgrade script will now assign the proper mime-type to all existing CC Licenses in your DSpace installation. NOTE: You will receive messages that most of the script additions already exist. This is normal, and nothing to be worried about.
Wiki Markup |
---|
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: |
Code Block |
---|
psql -U dspace -f
/dspace-1.6-1-src-release/dspace/etc/postgres/database_schema_15-16.sql dspace |
(The line break above is cosmetic. Please place your command in one line.- For Oracle: Execute the upgrade script, e.g. with sqlplus, recording the output:
Wiki Markup |
---|
Start SQL*Plus with "_sqlplus \[connect args\]_" |
- Record the output: SQL> spool 'upgrade.lst'
Wiki Markup |
---|
Run the upgrade script _SQL> @\[dspace-source\]/dspace/etc/oracle/database_schema_15-16.sql{_}{_}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:
Code Block |
---|
"--You need to remove the already in place constraints"
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. |
Wiki Markup |
---|
*Generate Browse and Search Indexes*. Though there are not any database changes in the 1.6 to 1.6.1 release, it makes 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_ |
Wiki Markup |
---|
*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.
...