A complete DSpace installation consists of three separate directory trees:
- The source directory:: This is where (surprise!) the source code lives. Note that the config files here are used only during the initial install process. After the install, config files should be changed in the install directory. It is referred to in this document as [dspace-source].
- The install directory:: This directory is populated during the install process and also by DSpace as it runs. It contains config files, command-line tools (and the libraries necessary to run them), and usually -- although not necessarily -- the contents of the DSpace archive (depending on how DSpace is configured). After the initial build and install, changes to config files should be made in this directory. It is referred to in this document as [dspace].
- The web deployment directory:: This directory is generated by the web server the first time it finds a dspace.war file in its webapps directory. It contains the unpacked contents of dspace.war, i.e. the JSPs and java classes and libraries necessary to run DSpace. Files in this directory should never be edited directly; if you wish to modify your DSpace installation, you should edit files in the source directory and then rebuild. The contents of this directory aren't listed here since its creation is completely automatic. It is usually referred to in this document as [tomcat]/webapps/dspace.
Source Directory Layout
- LICENSE - DSpace source code license.
- README - Obligatory basic information file.
- local.cfg.EXAMPLE - an example "local.cfg" file, which can be used to store all your local configuration overrides. See Configuration Reference.
- 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
- 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 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 JSPUI.
- 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 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.
- 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-jspui/ - JSP-UI source module
- dspace-oai - OAI-PMH source module
- dspace-rdf - RDF source module
- dspace-rest - REST API source module
- dspace-services - Common Services module
- dspace-sword - SWORD (Simple Web-serve Offering Repository Deposit) deposit service source module
- dspace-swordv2 - SWORDv2 source module
- dspace-xmlui - XML-UI (Manakin) source module
- dspace-xmlui-mirage2 - Mirage 2 theme for the XMLUI
- pom.xml - DSpace Parent Project definition
Installed Directory Layout
Below is the basic layout of a DSpace installation using the default configuration. These paths can be configured if necessary.
- assetstore/ - assetstore files. This is where all the files uploaded into DSpace are stored by default. See Storage Layer.
- bin/ - shell scripts for DSpace command-line tasks. Primary among them is the 'dspace' commandline utility
- config/ - configuration, with sub-directories as above
- etc/ - Administrative and database management files
- exports/ - temporary storage for any export packages
- handle-server/ - Handles server files and configuration
- imports/ - temporary storage for any import packages
- lib/ - JARs, including dspace-api.jar, containing the DSpace classes
- log/ - Log files
- reports/ - Reports generated by statistical report generator
- solr/ - Solr search/browse indexes
- triplestore/ - RDF triple store index files (when enabled)
- upload/ - temporary directory used during file uploads etc.
- webapps/ - location where DSpace installs all Web Applications
Contents of JSPUI Web Application
DSpace's Ant build file creates a dspace-jspui-webapp/ directory with the following structure:
- (top level dir)
- The JSPs
- web.xml - DSpace JSPUI Web Application configuration and Servlet mappings
- dspace-tags.tld - DSpace custom tag descriptor
- fmt.tld - JSTL message format tag descriptor, for internationalization
- lib/ - All the third-party JARs and pre-compiled DSpace API JARs needed to run JSPUI
- classes/ - Any additional necessary class files
Contents of XMLUI Web Application (aka Manakin)
DSpace's Ant build file creates a dspace-xmlui-webapp/ directory with the following structure:
- (top level dir)
- aspects/ - Contains overarching Aspect Generator config and Prototype DRI (Digital Repository Interface) document for Manakin.
- i18n/ - Internationalization / Multilingual support. Contains the messages.xml English language pack by default.
- themes/ - Contains all out-of-the-box Manakin themes
- Classic/ - The classic theme, which makes the XMLUI look like classic DSpace
- Kubrick/ - The Kubrick theme
- Mirage/ - The Mirage theme (see Mirage Configuration and Customization)
- Reference/ - The default reference theme for XMLUI
- dri2xhtml/ - The base theme template, which converts XMLUI DRI (Digital Repository Interface) format into XHTML for display. See XMLUI Base Theme Templates (dri2xhtml) for more details.
- dri2xhtml-alt/ - The alternative theme template (used by Mirage Theme), which also converts XMLUI DRI (Digital Repository Interface) format into XHTML for display. See XMLUI Base Theme Templates (dri2xhtml) for more details.
- template/ - An empty theme template...useful as a starting point for your own custom theme(s)
- dri2xhtml.xsl - The DRI-to-XHTML XSL Stylesheet. Uses the above 'dri2xhtml' theme to generate XHTML
- themes.xmap - The Theme configuration file. It determines which theme(s) are used by XMLUI
- lib/ - All the third-party JARs and pre-compiled DSpace JARs needed to run XMLUI
- classes/ - Any additional necessary class files
- cocoon.xconf - XMLUI's Apache Cocoon configuration
- logkit.xconf - XMLUI's Apache Cocoon Logging configuration
- web.xml - XMLUI Web Application configuration and Servlet mappings
The first source of potential confusion is the log files. Since DSpace uses a number of third-party tools, problems can occur in a variety of places. Below is a table listing the main log files used in a typical DSpace setup. The locations given are defaults, and might be different for your system depending on where you installed DSpace and the third-party tools. The ordering of the list is roughly the recommended order for searching them for the details about a particular problem or error.
What's In It
Main DSpace log file. This is where the DSpace code writes a simple log of events and errors that occur within the DSpace code. You can control the verbosity of this by editing the [dspace-source]/config/templates/log4j.properties file and then running "ant init_configs".
Apache Cocoon log file for the XMLUI. This is where the DSpace XMLUI logs all of its events and errors.
This is where Tomcat's standard output is written. Many errors that occur within the Tomcat code are logged here. For example, if Tomcat can't find the DSpace code (dspace.jar), it would be logged in catalina.out.
If you're running Tomcat stand-alone (without Apache), it logs some information and errors for specific Web applications to this log file. hostname will be your host name (e.g. dspace.myu.edu) and yyyy-mm-dd will be the date.
If you're using Apache, Tomcat logs information about Web applications running through Apache (mod_webapp) in this log file (yyyy-mm-dd being the date.)
Apache logs to this file. If there is a problem with getting mod_webapp working, this is a good place to look for clues. Apache also writes to several other log files, though error_log tends to contain the most useful information for tracking down problems.
The Handle server runs as a separate process from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation of log4j's 'rolling file appenders', the DSpace code running in the Handle server's JVM must use a separate log file. The DSpace code that is run as part of a Handle resolution request writes log information to this file. You can control the verbosity of this by editing [dspace-source]/config/templates/log4j-handle-plugin.properties.
This is the log file for CNRI's Handle server code. If a problem occurs within the Handle server code, before DSpace's plug-in is invoked, this is where it may be logged.
On the other hand, a problem with CNRI's Handle server code might be logged here.
PostgreSQL also writes a log file. This one doesn't seem to have a default location, you probably had to specify it yourself at some point during installation. In general, this log file rarely contains pertinent information--PostgreSQL is pretty stable, you're more likely to encounter problems with connecting via JDBC, and these problems will be logged in dspace.log.
the file [dspace]/config/log4j.properties controls how and where log files are created. There are three sets of configurations in that file, called A1, A2, and A3. These are used to control the logs for DSpace, the checksum checker, and the XMLUI respectively. The important settings in this file are:
These lines control what level of logging takes place. Normally they should be set to INFO, but if you need to see more information in the logs, set them to DEBUG and restart your web server
This is the name of the log file creation method used. The DailyFileAppender creates a new date-stamped file every day or month.
This sets the filename and location of where the log file will be stored. It iwll have a date stamp appended to the file name.
This defines the format for the date stamp that is appended to the log file names. If you wish to have log files created monthly instead of daily, change this to yyyy-MM
This defines how many log files will be created. You may wish to define a retention period for log files. If you set this to 365, logs older than a year will be deleted. By default this is set to 0 so that no logs are ever deleted. Ensure that you monitor the disk space used by the logs to make sure that you have enough space for them. It is often important to keep the log files for a long time in case you want to rebuild your statistics.