Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: reordering upgrade steps for 1.7.1 to minimize downtime

...

Warning
titleTest Your Upgrade Process

It is always recommended that when performing an upgrade that the user should use a Development or Test instance or server in order to minimize downtime. You should note any problems you have encountered (and also how to resolve them) before attempting to upgrade your production instance or server. It also gives you a chance to "practice" at the upgrade. (And practice Practice makes perfect.) , and minimizes problems and downtime. Additionally, if you are using a version control system, such as subversion or git, you can manage locally developed features or modifications you can do all of your upgrades in your local version control system on your development server and commit the changes, so that your production server can just checkout your well tested and upgraded code.

Info
titleIf 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. For example, when upgrading from 1.5.x to 1.7.x, you need to perform the configuration & database upgrade steps detailed in #Upgrading from 1.5.x to 1.6.x followed by those detailed in #Upgrading from 1.6.x to 1.7.x.

...

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.1. Whenever you see these path references, be sure to replace them with the actual path names on your local system.

...

Wiki Markup
The asset store ({{\[dspace\]/assetstore}} by default)

...

 Additionally, be sure to backup your configs, source code modifications, and database before doing a step that could destroy your instance.

  1. Download DSpace 1.7.1 Retrieve the new DSpace 1.7.1 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 Unix-based installations will have a startup/shutdown script in the /etc/init.d or /etc/rc.d directories)
  2. 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/}}
    • Wiki Markup
      Config modifications: \[dspace\]/config
  3. 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 ('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.
  4. Stop Tomcat. Take down your servlet container. For Tomcat, use the  $CATALINA/shutdown.sh  script. (Many Unix-based installations will have a startup/shutdown script in the /etc/init.d or /etc/rc.d directories)
  5. Backup Your DSpace. Make a complete backup of your system, including:
    • A snapshot of the database. To have a "snapshot" of the PostgreSQL database use Postgres' pg_dump command.
    • Wiki Markup
      The asset store ({{\[dspace\]/assetstore}} by default, and any other assetstores configured in \[dspace\]/config/dspace.cfg "assetstore.dir" and "assetstore.dir.#")
    • Your configuration files and customizations to DSpace (including any customized scripts).
  6. 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
  7. 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):
    Code Block
    [dspace]/bin/dspace index-init
  8. 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): 
    Code Block
    cp -R [dspace]/webapps/* [tomcat]/webapps/
  9. Restart servlet container. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.

...