Rebuild+DSpace

The following directions are for DSpace 1.5.x and above!

Directories:

• dspace - The DSpace Installation directory
• dspace-source

  /dspace/

  - The DSpace Assembly project within the DSpace source code
• dspace-source

  /dspace/target/dspace-[version]-build.dir/

  - The directory where the DSpace Assembly project builds a new installation package for DSpace.
• Tomcat

  /webapps/

  (Mac OSX Server:

  /library/jboss/3.2/deploy

  )
  • Note: JBOSS comes pre-installed with Mac OS X server. However, for both server and desktop editions Tomcat may be used as with other platforms.

Quick Restart (Just restarts the web server after configuration changes*)

(*Exception - Changes to Messages.properties always requires a rebuild!)

1. Stop Tomcat (WARNING: this will bring down the website)
   • (Linux / OS X / Solaris) Tomcat/bin/shutdown.sh
   • (Mac OS X Server) Use Server Admin to stop Tomcat ("Application Server")
   • (Windows) Use Tomcat Service Monitor (in Notification Area) to stop Tomcat

1. Start Tomcat
   • (Linux / OS X / Solaris) Tomcat/bin/startup.sh
   • (Mac OS X Server) Use Server Admin to start Tomcat ("Application Server")
   • (Windows) Use Tomcat Service Monitor (in Notification Area) to start Tomcat

Quick Build: (Quick build after smaller, usually JSP based or XMLUI-Theme based, changes)

1. Log on to the server DSpace is running on (e.g. ssh). Make sure to login as the user who initially installed DSpace!
2. Open a command prompt (if you don't have one already), and

   cd

   dspace-source

   /dspace/

3. mvn build

   (recompiles all DSpace code and rebuilds the DSpace installation package)

4. cd

   dspace-source

   /dspace/target/dspace-[version]-build.dir/

   (move into the target directory where DSpace has been rebuilt)

5. ant update

   (updates your DSpace install based on the newly built content in your target directory)
   • Alternatively, if you do not need to reinstall JAR files, you could instead run

     ant update_webapps

     (which just copies over web application changes to your [dspace)
6. If you do not have Tomcat pointing at your dspace

   /webapps/

   directory, you will also need to copy your final web application(s) into your Tomcat

   /webapps/

   directory.

   • cp -R [dspace]/webapps/

     Tomcat

     /webapps/

   • (For Mac OS X Server)

     cp build/*.war /library/jboss/3.2/deploy

7. Test your changes in DSpace

Full Refresh/Rebuild: (Completely refresh all of DSpace)

1. Log on to the server DSpace is running on (e.g. ssh). Make sure to log in as the user who initially installed DSpace!
2. Open a command prompt (if you don't have one already), and

   cd

   dspace-source

   /dspace/

3. mvn clean build

   (removes all old compiled code and recompiles all DSpace code and rebuilds the DSpace installation package)

4. cd

   dspace-source

   /dspace/target/dspace-[version]-build.dir/

   (move into the target directory where DSpace has been rebuilt)

5. ant update

   (updates your DSpace install based on the newly built content in your target directory)
   • Alternatively, if you do not need to reinstall JAR files, you could instead run

     ant update_webapps

     (which just copies over web application changes to your [dspace)
6. If you do not have Tomcat pointing at your dspace

   /webapps/

   directory, you will also need to copy your final web application(s) into your Tomcat

   /webapps/

   directory.

   • cp -R [dspace]/webapps/

     Tomcat

     /webapps/

   • (For Mac OS X Server)

     cp build/*.war /library/jboss/3.2/deploy

7. Test changes in DSpace
   • To force Tomcat to recompile everything, you may also wish to remove any DSpace related web application directories created in Tomcat

     /work/Catalina/localhost

8. Start Tomcat
   • (Linux / OS X / Solaris) Tomcat/bin/startup.sh
   • (Mac OS X Server) Use Server Admin to start Tomcat ("Application Server")
   • (Windows) Use Tomcat Service Monitor (in Notification Area) to start Tomcat
9. Test your changes in DSpace