Contents

Rebuild DSpace

The following directions are for DSpace versions from 1.5.x up to 1.8.x. For DSpace 3 and above, see the official docs for the appropriate version (3.x, 4.x).

Directories:

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)
  2. 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 package (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 targetdirectory)
  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.
  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 package (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 targetdirectory)
  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.
  7. 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
  9. Test your changes in DSpace

Exclude individual modules

It doesn't happen often that someone needs all of the DSpace modules. Most prominent example are the web interfaces - most people need either JSPUI or XMLUI, but not both. You may cut down on build time by excluding unneeded modules. But beware, some modules have hidden interdependencies, so it's not always possible to exclude all modules. If a build fails, it may be for this reason. In that case try the full build again.

To build dspace without the JSPUI and LNI modules ("profiles" in Maven terminology), add this option to the Maven command:

mvn package -P '!dspace-jspui,!dspace-lni'

The full list of DSpace modules that you may choose to exclude from the build include: