Page History

...

1. Download DSpace 3.0: Either download DSpace 3.0 from DSpace.org or check it out directly from the Github 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. Merge any customizations. If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Customizations are typically 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/
   • Config modifications: [dspace]/config
3. Edit build.properties file ([dspace-source]/build.properties).  This new configuration file allows for an easier way to quickly configure your primary DSpace settings before building DSpace.  It provides a subset of the most important configurations you may wish to make for your DSpace installation.  Any settings changed in this build.properties file are automatically copied over to the final dspace.cfg file during the "Build DSpace" process (in the next step).  For more information on the build.properties file, see "The build.properties Configuration Properties File" section of the Configuration documentation.

4. Build DSpace. Run the following commands to compile DSpace:

   No Formatcode
   cd [dspace-source]/dspace/ mvn -U clean package

   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.

5. Stop Tomcat. Take down your servlet container. For Tomcat, use the $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.)
6. Update DSpace.
   

   1. 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 update

   2. Please run one of the following scripts to update your database:-
• • • PostgreSQL: [dspace-source]/dspace/etc/postgres/database_schema_18-3.sql
    • Oracle: [dspace-source]/dspace/etc/oracle/database_schema_18-3.sql
7. Update your DSpace Configurations.

8. Refresh Browse and Search Indexes. To do this, run the following command from your DSpace install directory (as the dspace user):

   Code Block
   [dspace]/bin/dspace index-init

   1. Refresh Discovery: If you are using Discovery (Solr) for search/browse, you will also need to refresh Discovery indexes by running the following command:

      Code Block
      [dspace]/bin/dspace update-discovery-index -f

9. Update OAI-PMH indexes. DSpace 3.0 comes with a brand new OAI 2.0 Server which uses a Solr backend by default.  As such, it needs to have its indexes updated on a regular basis.  To update the OAI 2.0 indexes, you should run the following command:

   Code Block
   [dspace]/bin/dspace oai import

   Note
   title Enable an OAI-PMH index cron job
   This same 'dspace oai import' command should also be run on a regular basis (e.g. via cron) to keep the OAI 2.0 indexes in sync. For more information, see the Scheduled Tasks section of the OAI 2.0 documentation.

   Info
   title Using OAI-PMH but not SOLR?
   If you are using OAI-PMH, but do not yet have the Solr webapp ([dspace]/webapps/solr/) installed, you will need to: (1) EITHER Modify the default OAI 2.0 config file ([dspace]/config/modules/oai.cfg) to use a database backend. See: (2) OR install/enable Tomcat to use the DSpace Solr webapp ([dspace]/webapps/solr/), and optionally configure the OAI settings in [dspace]/config/modules/oai.cfg

10. Deploy Web Applications. If necessary, 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/

    See the installation guide for full details.

11. Restart servlet container. Now restart your Tomcat/Jetty/Resin server program and test out the upgrade.