Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleChanges 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:

  • Wiki Markup
    *The dspace.cfg has been "split up":* Many "module" configurations have now been moved out of the 'dspace.cfg' and into separate configuration files in the {{\[dspace\]/config/modules/}} directory.
    • Wiki Markup
      [Authentication Configurations|Authentication Plugins] are now in {{\[dspace\]/config/modules/authenticate*.cfg}} files
    • Wiki Markup
      [Batch Metadata Editing Configurations|Batch Metadata Editing Configuration] are now in the {{\[dspace\]/config/modules/bulkedit.cfg}} file
    • Wiki Markup
      [Discovery Configurations|Discovery] are now in the {{\[dspace\]/config/modules/discovery.cfg}} file
    • Wiki Markup
      [OAI-PMH / OAI-ORE Configurations|OAI] are now in the {{\[dspace\]/config/modules/oai.cfg}} file
    • Wiki Markup
      [Solr Statistics Configurations|DSpace Statistics] are now in the {{\[dspace\]/config/modules/solr-statistics.cfg}} file
    • Wiki Markup
      [SWORD Configurations|SWORDv1 Server] are now in {{\[dspace\]/config/modules/sword*.cfg}} files
    • All other DSpace configurations are still in the dspace.cfg configuration file.
  • Behavior of 'ant update' has changed: The 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).
    • In prior versions of DSpace (before 1.8.0), this 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
    • Wiki Markup
      *WARNING:* If you choose to run {{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.

...

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.12. Whenever you see these path references, be sure to replace them with the actual path names on your local system. 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.12 Either download DSpace 1.7.1 2 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.
  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:
    No Format
    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 the {{\[dspace\]/config/dspace.cfg}} "assetstore.dir" and "assetstore.dir.#" settings)
    • 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.

...