Versions Compared

Key

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

...

  • Binary Release (dspace-<version>-release.zip)
    • This distribution will be adequate for most cases of running a DSpace instance. It is intended to be the quickest way to get DSpace installed and running while still allowing for customization of the themes and branding of your DSpace instance.
    • This method allows you to customize DSpace configurations (in dspace.cfg) or user interfaces, using basic pre-built interface "overlays".
    • It downloads "precompiled" libraries for the core dspace-api, supporting servlets, taglibraries, aspects and themes for the dspace-xmlui, dspace-xmlui and other webservice/applications.
    • This approach only exposes selected parts of the application for customization. All other modules are downloaded from the 'Maven Central Repository' The directory structure for this release is the following:
      • Wiki Markup
        _\[dspace-source\]_
        • dspace/ - DSpace 'build' and configuration module
        • pom.xml - DSpace Parent Project definition
  • Source Release (dspace-<version>-src-release.zip)
    • This method is recommended for those who wish to develop DSpace further or alter its underlying capabilities to a greater degree.
    • It contains all dspace code for the core dspace-api, supporting servlets, taglibraries, aspects and themes for Manakin (dspace-xmlui), and other webservice/applications.
    • Provides all the same capabilities as the binary release. The directory structure for this release is more detailed:
      • Wiki Markup
        _\[dspace-source\]_
        • dspace/ - DSpace 'build' and configuration module
        • dspace-api/ - Java API source module
        • dspace-discovery - Discovery source module
        • dspace-jspui/ - JSP-UI source module
        • dspace-oai - OAI-PMH source module
        • dspace-xmlui - XML-UI (Manakin) source module
        • dspace-lni - Lightweight Network Interface source module
        • dspace-stats - Statistics source module
        • dspace-sword - SWORD (Simple Web-serve Offering Repository Deposit) deposit service source module
        • dspace-swordv2 - SWORDv2 source module
        • dspace-sword-client - XMLUI client for SWORD
        • pom.xml - DSpace Parent Project definition

...

  1. Wiki Markup
    *The installation directory*, referred to as {{\[dspace\]}}. This is the location where DSpace is installed and running off of it is the location that gets defined in the {{dspace.cfg}} as "dspace.dir". It is where all the DSpace configuration files, command line scripts, documentation and webapps will be installed to.
  2. Wiki Markup
    *The source directory*, referred to as {{\[dspace-source\]}} . This is the location where the DSpace release distribution has been unzipped into. It usually has the name of the archive that you expanded such as {{dspace}}\-{{<version>}}\-{{release}} or {{dspace}}\-{{<version>}}\-{{src}}\-{{release}}. In the case of the source distribution It is the directory where all of your "build" commands will be run. In the case of the binary distribution all "build" commands will be run from the subdirectory {{\[dspace-source\]/dspace}}.
  3. Wiki Markup
    *The web deployment directory*. This is the directory that contains your DSpace web application(s). In DSpace 1.5.x and above, this corresponds to {{\[dspace\]/webapps}} by default. However, if you are using Tomcat, you may decide to copy your DSpace web applications from {{\[dspace\]/webapps/}} to {{\[tomcat\]/webapps/}} (with {{\[tomcat\]}} being wherever you installed Tomcat‚ also known as {{$CATALINA_HOME}}).
    For details on the contents of these separate directory trees, refer to directories.html. _Note that the_ {{\[dspace-source\]}} _and_ {{\[dspace\]}} _directories are always separate\!_

...