Page History

Overview

A complete DSpace installation consists of three separate directory trees:

...

Source Directory Layout

• [dspace-source]
  • dspace/ - Directory which contains all build and configuration information for DSpace
  • CHANGES - Detailed list of code changes between versions.
  • KNOWN_BUGS - Known bugs in the current version.
  LICENSE LICENSE - DSpace source code license.
  • README - Obligatory basic information file.
  • build.properties - The basic settings necessary to actually build/install DSpace for the first time
  • dspace/ - Directory which contains all build and configuration information for DSpace
    • bin/ - Some shell and Perl scripts for running DSpace command-line tasks. Primary among them is the 'dspace' commandline utility
    • config/ - Configuration files:
      • controlled-vocabularies/ - Fixed, limited vocabularies used in metadata entry
      • crosswalks/ - Metadata crosswalks - property files or XSL stylesheets
      • emails/ - Text and layout templates for emails sent out by the system.
      • modules/ - Configurations for modules / individual features within DSpace
      • registries/ - Initial contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.
      • dspace.cfg - The Main DSpace configuration file (You will need to edit this).
      • dc2mods.cfg - Mappings from Dublin Core metadata to MODS for the METS export.
      • default.license - The default license that users must grant when submitting items.
      • dstat.cfg , dstat.map - Configuration for statistical reports.
      • input-forms.xml , item-submission.xml - Submission UI metadata field configuration .files
      • news-side.html - Text of the front-page news in the sidebar, only used in JSPUI.
      • news-top.html - Text of the front-page news in the top box, only used in teh JSPUI.
      • emails/ - Text and layout templates for emails sent out by the system.
      • registries/ - Initial contents of the bitstream format registry and Dublin Core element/qualifier registry. These are only used on initial system setup, after which they are maintained in the database.
    • docs/ - DSpace system documentation. The technical documentation for functionality, installation, configuration, etc.
    • • news-xmlui.xml - Text of the front-page news, only used in XMLUI
    • etc/ - This directory contains administrative files.
      
      • postgres/ - Administrative scripts for PostgreSQL
      • oracle/ - Administrative
      etc/ -
      This directory contains administrative files needed for the install process and by developers, mostly database initialization and upgrade scripts. Any .xml files in etc/ are common to all supported database systems.
      • postgres/ - Versions of the database schema and updater SQL scripts for PostgreSQL.
      • oracle/ - Versions of the database schema and updater SQL scripts for Oracle.
    • modules/ - The Web UI modules "overlay" directory. DSpace uses Maven to automatically look here for any customizations you wish to make to DSpace Web interfaces.
      • jspui - Contains all customizations for the JSP User Interface.
        • src/main/resources/ - The overlay for JSPUI Resources. This is the location to place any custom Messages.properties files. (Previously this file had been stored at: _[dspace-source]/config/language-packs/Messages.properties_
        • src/main/webapp/ - The overlay for JSPUI Web Application. This is the location to place any custom JSPs to be used by DSpace.
      • lni - Contains all customizations for the Lightweight Network Interface.
      • oai - Contains all customizations for the OAI-PMH Interface.
      • sword - Contains all customizations for the SWORD (Simple Web-service Offering Repository Deposit) Interface.
      • xmlui - Contains all customizations for the XML User Interface (aka Manakin).
        • src/main/webapp/ - The overlay for XMLUI Web Application. This is the location to place custom Themes or Configurations.
          • i18n/ - The location to place a custom version of the XMLUI's messages.xml (You have to manually create this folder)
          • themes/ - The location to place custom Themes for the XMLUI (You have to manually create this folder).
    • solr/ - Solr configuration files for all Solr indexes used by DSpace.
    • src/ - Maven configurations for DSpace System. This directory contains the Maven and Ant build files for DSpace.
    • target/ - (Only exists after building DSpace) This is the location Maven uses to build your DSpace installation package.
      • dspace-[version].dir - The location of the DSpace Installation Package (which can then be installed by running ant update)

• The Source Release contains the following additional directories :-
  • dspace-api/ - Java API source module
  • dspace-discovery - Discovery jspui/ - JSP-UI source module
  • dspace-jspui/ - JSP-UI source modulelni - Lightweight Network Interface source module (deprecated as of 5.0)
  • dspace-oai - OAI-PMH source module
  • dspace-xmlui - XML-UI (Manakin) rdf - RDF source module
  • dspace-lni - Lightweight Network Interface rest - REST API source module
  • dspace-stats - Statistics source services -  Common Services module
  • dspace-sword - SWORD (Simple Web-serve Offering Repository Deposit) deposit service source module
  • dspace-swordv2 - SWORDv2 source module
  • dspace-swordxmlui - client - XMLUI client for SWORD source module XML-UI (Manakin) source module
  • dspace-xmlui-mirage2 - Mirage 2 theme for the XMLUI
  • pom.xml - DSpace Parent Project definition

...

• [dspace]
  • assetstore/ - asset store files
  • bin/ - shell and Perl scripts
  • config/ - configuration, with sub-directories as above
  • handle-server/ - Handles server fileshistory/ - stored history files (generally RDF/XML)
  • lib/ - JARs, including dspace.jar, containing the DSpace classes
  • log/ - Log files
  • reports/ - Reports generated by statistical report generator
  • search/ - Lucene search index files
  • upload/ - temporary directory used during file uploads etc.
  • webapps/ - location where DSpace installs all Web Applications

...