Page History

{code}{warning}


h2. Prerequisite Software

The list below describes the third-party components and tools you'll need to run a DSpace server. These are just guidelines. Since DSpace is built on open source, standards-based tools, there are numerous other possibilities and setups.

Also, please note that the configuration and installation guidelines relating to a particular tool below are here for convenience. You should refer to the documentation for each individual component for complete and up-to-date details. Many of the tools are updated on a frequent basis, and the guidelines below may become out of date.

h3. UNIX-like OS or Microsoft Windows

* UNIX-like OS (Linux, HP/UX etc) : Many distributions of Linux/Unix come with some of the dependencies below pre installed or easily installed via updates, you should consult your particular distributions documentation to determine what is already available. 

* Microsoft Windows: (see full Windows Instructions for full set of prerequisites)

h3. Oracle Java JDK 6 or later (standard SDK is fine, you don't need J2EE)

DSpace now requires *Oracle* Java 6 or greater because of usage of new language capabilities introduced in 5 and 6 that make coding easier and cleaner.

Java can be downloaded from the following location: [http://java.sun.com/javase/downloads/index.jsp

|http://java.sun.com/javase/downloads/index.jsp|http://java.sun.com/javase/downloads/index.jsp]







Only Oracle's Java has been tested with each release and is known to work correctly. Other flavors of Java may pose problems.

h3. Apache Maven 2.0.8 or later (Java build tool)

Maven is necessary in the first stage of the build process to assemble the installation package for your DSpace instance. It gives you the flexibility to customize DSpace using the exisitng Maven projects found in the _\[dspace-source\]/dspace/modules_ directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes.

Maven can be downloaded from the following location: [http://maven.apache.org/download.html|http://maven.apache.org/download.html

|http://maven.apache.org/download.html]







h4. Configuring a Proxy

You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and password are only required if your proxy requires basic authentication (note that later releases may support storing your passwords in a secured keystore—in the mean time, please ensure your _settings.xml_ file (usually _$\{user.home\}/.m2/settings.xml_) is secured with permissions appropriate for your operating system).

Example:

{code

}<settings>
  .
  .
  <proxies>
   <proxy>
      <active>true</active>
      <protocol>http</protocol>
      <host>proxy.somewhere.com</host>
      <port>8080</port>
      <username>proxyuser</username>
      <password>somepassword</password>
      <nonProxyHosts>www.google.com|*.somewhere.com</nonProxyHosts>
    </proxy>
  </proxies>
  .
  .
</settings> 

 {code}


h3. Apache Ant 1.7 or later (Java build tool)

Apache Ant is still required for the second stage of the build process. It is used once the installation package has been constructed in _\[dspace-source\]/dspace/target/dspace-<version>-build.dir_ and still uses some of the familiar ant build targets found in the 1.4.x build process.

Ant can be downloaded from the following location: [http://ant.apache.org

|http://ant.apache.org/|http://ant.apache.org]








h3. Relational Database: (PostgreSQL or Oracle).

* *PostgreSQL 8.1 to 8.4* PostgreSQL can be downloaded from the following location: [http://www.postgresql.org/ |http://

www.postgresql.org/|http://www.postgresql.org/]. It is highly recommended that you try to work with Postgres 8.4 or greater, however, 8.1 or greater should still work. Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+.  Once installed, you need to enable TCP/IP connections (DSpace uses JDBC).  In _postgresql.conf_: uncomment the line starting: _listen_addresses = 'localhost'_. Then tighten up security a bit by editing _pg_hba.conf_ and adding this line: _host dspace dspace 127.0.0.1 255.255.255.255 md5_.  Then restart PostgreSQL.

* *Oracle 10g or greater* Details on acquiring Oracle can be downloaded from the following location: [http://www.oracle.com/database/

|http://www.oracle.com/database/|http://www.oracle.com/database/]. You will need to create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use the same character set. You will also need to create a user account for DSpace (e.g. _dspace_) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.
** *NOTE:* DSpace uses sequences to generate unique object IDs --- beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script _etc/update-sequences.sql_.

** For people interested in switching from Postgres to Oracle, I know of no tools that would do this automatically. You will need to recreate the community, collection, and eperson structure in the Oracle system, and then use the item export and import tools to move your content over.

h3. Servlet Engine: (Apache Tomcat 5.5 or 6, Jetty, Caucho Resin or equivalent).

* *Apache Tomcat 5.5 or later.* Tomcat can be downloaded from the following location: [http://tomcat.apache.org|http://tomcat.apache.org

/whichversion.html|http://tomcat.apache.org].
** Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called '_dspace_'. Set the environment variable _TOMCAT_USER_ appropriately.
** You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its default file encoding for international character support. So ensure in your startup scripts (etc) that the following environment variable is set: _JAVA_OPTS="-Xmx512M \-Xms64M \-Dfile.encoding=UTF-8"

_
** *Modifications in* *_\[tomcat\]/conf/server.xml{_}*:  You also need to alter Tomcat's default configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a configuration option to the _<Connector>_ element in _\[tomcat\]/config/server.xml_: _URIEncoding="UTF-8"_ e.g. if you're using the default Tomcat config, it should read:

{code

}
<!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
<Connector port="8080"
              maxThreads="150"
              minSpareThreads="25"
	          maxSpareThreads="75"
              enableLookups="false"
              redirectPort="8443"
	          acceptCount="100"
              connectionTimeout="20000"
	          disableUploadTimeout="true"
              URIEncoding="UTF-8"/>
{code}

You may change the port from 8080 by editing it in the file above, and by setting the variable _CONNECTOR_PORT_ in _server.xml_.

* *Jetty or Caucho Resin* DSpace will also run on an equivalent servlet Engine, such as Jetty ([http://www.mortbay.org/jetty/index.html|http://www.mortbay.org/jetty/index.html|http://www.mortbay.org/jetty/index.html]) or Caucho Resin ([http://www.caucho.com/)|http://www.caucho.com/|http://www.caucho.com/)].  Jetty and Resin are configured for correct handling of UTF-8 by default

.

h3. Perl (required for \[dspace\]/bin/dspace-info.pl)

h2. Installation Options

h3. Overview of Install Options

With the advent of a new Apache [Maven 2|http://maven.apache.org/|Maven 2] based build architecture in DSpace 1.5.x, you now have two options in how you may wish to install and manage your local installation of DSpace. If you've used DSpace 1.4.x, please recognize that the initial build procedure has changed to allow for more customization. You will find the later 'Ant based' stages of the installation procedure familiar. Maven is used to resolve the dependencies of DSpace online from the 'Maven Central Repository' server.

It is important to note that the strategies are identical in terms of the list of procedures required to complete the build process, the only difference being that the Source Release includes "more modules" that will be built given their presence in the distribution package.

* Default 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 exposes the parts of the application that the DSpace committers would prefer to see customized. All other modules are downloaded from the 'Maven Central Repository' The directory structure for this release is the following:

*** _\[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 normal release. The directory structure for this release is more detailed:

*** _\[dspace-source\]_

**** _dspace/_ \- DSpace 'build' and configuration

 module
**** _dspace-api/_ \- Java API 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-sword_ -- SWORD (Simple Web-serve Offering Repository Deposit) deposit service source module
**** _dspace-test_ -- DSpace Tests (Unit and Integration Tests)
**** _pom.xml_ \- DSpace Parent Project definition

h3. Overview of DSpace Directories

Before beginning an installation, it is important to get a general understanding of the DSpace directories and the names by which they are generally referred. (Please attempt to use these below directory names when asking for help on the DSpace Mailing Lists, as it will help everyone better understand what directory you may be referring to.)

DSpace uses three separate directory trees. Although you don't need to know all the details of them in order to install DSpace, you do need to know they exist and also know how they're referred to in this document:

# *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.

# *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_. It is the directory where all of your "build" commands will be run.

# *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\!\_

h3. Installation

This method gets you up and running with DSpace quickly and easily. It is identical in both the Default Release and Source Release distributions.

# *Create the DSpace user*. This needs to be the same user that Tomcat (or Jetty etc.) will run as. e.g. as *{_}root{_}* run:{code}useradd -m dspace

{code}
# *Download* the [latest DSpace release|http://sourceforge.net/projects/dspace/|latest DSpace release] There are two version available with each release of DSpace: (_dspace-1.x-release._ and _dspace-1.x-src-release.xxx_); you only need to choose one. If you want a copy of all underlying Java source code, you should download the _dspace-1.x-src-release.xxx_ Within each version, you have a choice of compressed file format. Choose the one that best fits your environment.

# *Unpack the DSpace software*. After downloading the software, based on the compression file format, choose one of the following methods to unpack your software:

## *Zip file*. If you downloaded _dspace-1.6-release.zip_ do the following:

{code

}unzip dspace-1.7-release.zip

{code}
## *.gz file*. If you downloaded _dspace-1.6-release.tar.gz_ do the following:

{code

}gunzip -c dspace-1.7-release.tar.gz | tar -xf -

{code}
## *.bz2 file*. If you downloaded \_dspace-1.6-release.tar.bz2_do the following:

{code

}bunzip2 dspace-1.7-release.tar.bz | tar -xf -

{code}For ease of reference, we will refer to the location of this unzipped version of the DSpace release as _\[dspace-source\]_ in the remainder of these instructions.After unpacking the file, the user may which to change the ownership of the _dspace-1.6-release_ to the 'dspace' user. (And you may need to change the group).

# *Database

 Setup*
\\
_PostgreSQL:

_
## A PostgreSQL 8.1-404 jdbc3 driver is configured as part of the default DSpace build. You no longer need to copy any PostgreSQL jars to get PostgreSQL installed.

## Create a _dspace_ database, owned by the _dspace_ PostgreSQL user _(you are still logged in at 'root')_:

{code

}createuser -U postgres -d -A -P dspace ; createdb -U dspace -E UNICODE dspace

{code}You will be prompted for a password for the DSpace database. (This isn't the same as the _dspace_ user's UNIX password.)

\\
*{_}Oracle{_}{*}_:_
## Setting up oracle is a bit different now. You will need still need to get a Copy of the oracle JDBC driver, but instead of copying it into a lib directory you will need to install it into your local Maven repository. You'll need to download it first from this location: [http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html

|http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html|http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html]_$ mvn install:install-file \-Dfile=ojdbc14.jar \-DgroupId=com.oracle \ \-DartifactId=ojdbc14 \-Dversion=10.2.0.2.0 \-Dpackaging=jar \-DgeneratePom=true

_
## Create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is suggested that the Oracle database use the same character set. Create a user account for DSpace (e.g. _dspace_,) and ensure that it has permissions to add and remove tables in the database.

## Edit the _\[dspace-source\]/dspace/config/dspace.cfg_ database settings:

{code

}
db.name   = oracle
db.url    = jdbc:oracle:thin:@//host:port/dspace
db.driver = oracle.jdbc.OracleDriver
							

{code}
# *Initial Configuration*Edit_\[dspace-source\]/dspace/config/dspace.cfg_, in particular you'll need to set these properties:*{*}{_}dspace.dir{_}* *\-\- must be set to the* *_\[dspace\]_* *(installation) directory.*{*}{_}dspace.url{_}* *\-\- complete URL of this server's DSpace home page.*{*}{_}dspace.hostname{_}* *\-\- fully-qualified domain name of web server.*{*}{_}dspace.name{_}* *\-\- "Proper" name of your server, e.g. "My Digital Library".*{*}{_}db.password{_}* *\-\- the database password you entered in the previous step.*{*}{_}mail.server{_}* *\-\- fully-qualified domain name of your outgoing mail server.*{*}{_}mail.from.address{_}* *\-\- the "From:" address to put on email sent by DSpace.*{*}{_}feedback.recipient{_}* *\-\- mailbox for feedback mail.*{*}{_}mail.admin{_}* *\-\- mailbox for DSpace site administrator.*{*}{_}alert.recipient{_}* *\-\- mailbox for server errors/alerts (not essential but very useful\!)*{*}{_}registration.notify{_}* *\-\- mailbox for emails when new users register (optional) \*NOTE:* You can interpolate the value of one configuration variable in the value of another one. For example, to set _feedback.recipient_ to the same value as _mail.admin_, the line would look like:

{code

}     feedback.recipient = ${mail.admin}

{code}Refer to _5.2. General Configuration_ for details and examples of the above.

# \*DSpace Directory*Create the directory for the DSpace installation (i.e. _\[dspace\]_). As _root_ (or a user with appropriate permissions), run: 

{code

}mkdir [dspace]
chown dspace [dspace]

{code}(Assuming the _dspace_ UNIX username.)

# \*Installation Package*As the _dspace_ UNIX user, generate the DSpace installation package in the _\[dspace-source\]/dspace_ directory:

{code

}cd [dspace-source]/dspace/
mvn package

{code}Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. _If you want to use Oracle instead, you should build the DSpace installation package as follows:

_{code

}mvn -Ddb.name=oracle package

{code}
# \*Build DSpace and Initialize Database*As the _dspace_ UNIX user, initialize the DSpace database and install DSpace to _\[dspace\]_:

{code

}cd [dspace-source]/dspace/target/dspace-[version]-build.dir

ant fresh_install

{code}To see a complete list of build targets, run:

 *ant help* _The most likely thing to go wrong here is the database connection. See the \_3.7 Common Problems Section_.

# *Deploy Web Applications.

*
You have two choices or techniques for having Tomcat/Jetty/Resin serve up your web applications.

*Technique A.* Simple and complete. You copy only (or all) of the DSpace Web application(s) you wish to use from the {{*\[dspace\]/webapps{*}}} directory to the appropriate directory in your Tomcat/Jetty/Resin installation. For example:

* {{{*}cp \-R \[dspace\]/webapps/\* \[tomcat\]/webapps{*}}} (This will copy all the web applications to Tomcat). 

* {{{*}cp \-R \[dspace\]/webapps/jspui \[tomcat\]/webapps{*}}} (This will copy only the jspui web application to Tomcat.)

*Technique B.* Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the <Host> section of your \_\[tomcat\]/conf/server.xml\_ you could add lines similar to the following (but replace _\[dspace\]_ with your installation location:

{code

}<!-- Define the default virtual host
	Note:  XML Schema validation will not work with Xerces 2.2.
	-->
	<Host name="localhost"  appBase="[dspace]/webapps"
	....

{code}
# \*Administrator Account  *Create an initial administrator account:{code}[dspace]/bin/dspace create-administrator

{code}
# *Initial Startup\!*  Now the moment of truth\! Start up (or restart) Tomcat/Jetty/Resin. Visit the base URL(s) of your server, depending on which DSpace web applications you want to use. You should see the DSpace home page. Congratulations\! Base URLs of DSpace Web Applications:

#* _JSP User Interface_ _\- (e.g.)_ _[http://dspace.myu.edu:8080/jspui

]_
#* _XML User Interface (aka. Manakin)_ _\- (e.g.)_ _[http://dspace.myu.edu:8080/xmlui

]_
#* _OAI-PMH Interface_ _\- (e.g.)_ _[http://dspace.myu.edu:8080/oai/request?verb=Identify]_ _(Should return an XML-based response)

_

In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which you created with {{create-administrator}} above) and access the administration UI in either the JSP or XML user interface

PostgreSQL also benefits from regular 'vacuuming', which optimizes the indexes and clears out any deleted data. Become the _postgres_ UNIX user, run _crontab \-e_ and add (for example):

{code

}# Clean up the database nightly at 4.20am
20 4 * * * vacuumdb --analyze dspace > /dev/null 2>&1{code}
In order that statistical reports are generated regularly and thus kept up to date you should set up the following cron jobs:

{code

}# Run stat analysis
0 1 * * * [dspace]/bin/dspace stat-general
0 1 * * * [dspace]/bin/dspace stat-monthly
0 2 * * * [dspace]/bin/dspace stat-report-general
0 2 * * * [dspace]/bin/dspace stat-report-monthly{code}
Obviously, you should choose execution times which are most useful to you, and you should ensure that the _{-}report{-}_ scripts run a short while after the analysis scripts to give them time to complete (a run of around 8 months worth of logs can take around 25 seconds to complete); the resulting reports will let you know how long analysis took and you can adjust your cron times accordingly.


h3.

 Multilingual

 Installation

In order to deploy a multilingual version of DSpace you have to configure two parameters in _\[dspace-source\]/config/dspace.cfg:_

_

default.locale_, e. g. default.locale = en

_webui.supported locales_, e. g. webui.supported.locales = en, de

The Locales might have the form country, country_language, country_language_variant.

According to the languages you wish to support, you have to make sure, that all the i18n related files are available see the Multilingual User Interface Configuring MultiLingual Support section for the JSPUI or the Multilingual Support for XMLUI in the configuration documentation.

h3. DSpace over HTTPS

If your DSpace is configured to have users login with a username and password (as opposed to, say, client Web certificates), then you should consider using HTTPS. Whenever a user logs in with the Web form (e.g. _dspace.myuni.edu/dspace/password-login_) their DSpace password is exposed in plain text on the network. This is a very serious security risk since network traffic monitoring is very common, especially at universities. If the risk seems minor, then consider that your DSpace administrators also login this way and they have ultimate control over the archive.

The solution is to use _HTTPS_ (HTTP over SSL, i.e. Secure Socket Layer, an encrypted transport), which protects your passwords against being captured. You can configure DSpace to require SSL on all "authenticated" transactions so it only accepts passwords on SSL connections.

The following sections show how to set up the most commonly-used Java Servlet containers to support HTTP over SSL.

h4.

 To enable the HTTPS support in Tomcat 5.0:

# *For Production use:* Follow this procedure to set up SSL on your server. Using a "real" server certificate ensures your users' browsers will accept it without complaints. In the examples below, _$CATALINA_BASE_ is the directory under which your Tomcat is installed.

## Create a Java keystore for your server with the password _changeit_, and install your server certificate under the alias _"tomcat"_. This assumes the certificate was put in the file _server.pem_:

{code

}$JAVA_HOME/bin/keytool -import -noprompt -v -storepass changeit
	-keystore $CATALINA_BASE/conf/keystore -alias tomcat -file
	myserver.pem

{code}
## Install the CA (Certifying Authority) certificate for the CA that granted your server cert, if necessary. This assumes the server CA certificate is in _ca.pem_:

{code

} $JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA
	-file ca.pem

{code}
## Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the configuration section for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in _client1.pem_:{code}$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore  -alias client1
	-file client1.pem

{code}
## Now add another Connector tag to your _server.xml_ Tomcat configuration file, like the example below. The parts affecting or specific to SSL are shown in bold. (You may wish to change some details such as the port, pathnames, and keystore password)

{code

}     <Connector port="8443"
               maxThreads="150" minSpareThreads="25"
	           maxSpareThreads="75"
               enableLookups="false"
	           disableUploadTimeout="true"
               acceptCount="100" debug="0"
              scheme="https" secure="true" sslProtocol="TLS"
	keystoreFile="conf/keystore" keystorePass="changeit" clientAuth="true" - ONLY if using client X.509 certs for authentication!
	truststoreFile="conf/keystore" trustedstorePass="changeit" />

{code}Also, check that the default Connector is set up to redirect "secure" requests to the same port as your SSL connector, e.g.:  

{code

}<Connector port="8080"
                 maxThreads="150" minSpareThreads="25"
	             maxSpareThreads="75"
                 enableLookups="false"
	             redirectPort="8443"
                 acceptCount="100" debug="0"  	/>

{code}
# *Quick-and-dirty Procedure for Testing:* If you are just setting up a DSpace server for testing, or to experiment with HTTPS, then you don't need to get a real server certificate. You can create a "self-signed" certificate for testing; web browsers will issue warnings before accepting it but they will function exactly the same after that as with a "real" certificate.  In the examples below, _$CATALINA_BASE_ is the directory under which your Tomcat is installed.

## Optional -- ONLY if you don't already have a server certificate. Follow this sub-procedure to request a new, signed server certificate from your Certifying Authority (CA): 

##* Create a new key pair under the alias name _"tomcat"_. When generating your key, give the Distinguished Name fields the appropriate values for your server and institution. CN should be the fully-qualified domain name of your server host. Here is an example:

{code

}
$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize
	1024 \
  -keystore $CATALINA_BASE/conf/keystore -storepass changeit
	-validity 365 \
  -dname 'CN=dspace.myuni.edu, OU=MIT Libraries, O=Massachusetts
	Institute of Technology, L=Cambridge, S=MA, C=US'

{code}
##* Then, create a _CSR_ (Certificate Signing Request) and send it to your Certifying Authority. They will send you back a signed Server Certificate. This example command creates a CSR in the file _tomcat.csr

{_}{code}
 $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
	-storepass changeit \
   -certreq -alias tomcat -v -file tomcat.csr

{code}
##* Before importing the signed certificate, you must have the CA's certificate in your keystore as a _trusted certificate_. Get their certificate, and import it with a command like this (for the example _mitCA.pem_):

{code

}
 $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
	-storepass changeit \
     -import -alias mitCA -trustcacerts -file mitCA.pem

{code}
##* Finally, when you get the signed certificate from your CA, import it into the keystore with a command like the following example: (cert is in the file _signed-cert.pem_)

{code

}
 $JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
	-storepass changeit \
     -import -alias tomcat -trustcacerts -file signed-cert.pem

{code} Since you now have a signed server certificate in your keystore, you can, obviously, skip the next steps of installing a signed server certificate and the server CA's certificate. 

## Create a Java keystore for your server with the password _changeit_, and install your server certificate under the alias _"tomcat"_. This assumes the certificate was put in the file _server.pem_:

{code

}
 $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore
	$CATALINA_BASE/conf/keystore -storepass changeit

{code}When answering the questions to identify the certificate, be sure to respond to "First and last name" with the fully-qualified domain name of your server (e.g. _test-dspace.myuni.edu_). The other questions are not important.

## Optional -- ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the configuration section for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in _client1.pem_:

{code

}
 $JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore  -alias client1
	-file client1.pem

*To use SSL on Apache HTTPD with mod_webapp* consult the DSpace 1.3.2 documentation. Apache have deprecated the _mod_webapp_ connector and recommend using _mod_jk_.

*To use Jetty's HTTPS support* consult the documentation for the relevant tool

.



h3. The Handle Server

First a few facts to clear up some common misconceptions:

* You don't *have* to use CNRI's Handle system. At the moment, you need to change the code a little to use something else (e.g PURLs) but that should change soon.
* You'll notice that while you've been playing around with a test server, DSpace has apparently been creating handles for you looking like _hdl:123456789/24_ and so forth. These aren't really Handles, since the global Handle system doesn't actually know about them, and lots of other DSpace test installs will have created the same IDs.They're only really Handles once you've registered a prefix with CNRI (see below) and have correctly set up the Handle server included in the DSpace distribution. This Handle server communicates with the rest of the global Handle infrastructure so that anyone that understands Handles can find the Handles your DSpace has created. 
If you want to use the Handle system, you'll need to set up a Handle server. This is included with DSpace. Note that this is not required in order to evaluate DSpace; you only need one if you are running a production service. You'll need to obtain a Handle prefix from [the central CNRI Handle site|http://www.handle.net/|the central CNRI Handle site].

A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues resolution requests to a global server or servers if a Handle entered locally does not correspond to some local content. The Handle protocol is based on TCP, so it will need to be installed on a server that can broadcast and receive TCP on port 2641.

# To configure your DSpace installation to run the handle server, run the following command: _\[dspace\]/bin/dspace make-handle-config_Ensure that \_\[dspace\]/handle-server_ matches whatever you have in _dspace.cfg_ for the _handle.dir_ property.

# Edit the resulting _\[dspace\]/handle-server/config.dct_ file to include the following lines in the _"server_config"_ clause: 

{code

}"storage_type" = "CUSTOM"
"storage_class" = "org.dspace.handle.HandlePlugin"

{code}This tells the Handle server to get information about individual Handles from the DSpace code. 

# Once the configuration file has been generated, you will need to go to [http://hdl.handle.net/4263537/5014|http://hdl.handle.net/4263537/5014|http://hdl.handle.net/4263537/5014] to upload the generated sitebndl.zip file. The upload page will ask you for your contact information. An administrator will then create the naming authority/prefix on the root service (known as the Global Handle Registry), and notify you when this has been completed. You will not be able to continue the handle server installation until you receive further information concerning your naming authority.

# When CNRI has sent you your naming authority prefix, you will need to edit the _config.dct_ file. The file will be found in _/\[dspace\]/handle-server_. Look for _"300:0.NA/YOUR_NAMING_AUTHORITY"_Replace \_YOUR_NAMING_AUTHORITY_ with the assigned naming authority prefix sent to you.

# Now start your handle server (as the dspace user): 

{code

}[dspace]/bin/start-handle-server

{code}
Note that since the DSpace code manages individual Handles, administrative operations such as Handle creation and modification aren't supported by DSpace's Handle server.

h4.

 Updating Existing Handle

 Prefixes

If you need to update the handle prefix on items created before the CNRI registration process you can run the _\[dspace\]/bin/dspace update-handle-prefix script_. You may need to do this if you loaded items prior to CNRI registration (e.g. setting up a demonstration system prior to migrating it to production). The script takes the current and new prefix as parameters. For example:

{code

}[dspace]/bin/dspace update-handle-prefix 123456789 1303
                {code}
This script will change any handles currently assigned prefix 123456789 to prefix 1303, so for example handle 123456789/23 will be updated to 1303/23 in the database

.



h3. Google and HTML sitemaps

To aid web crawlers index the content within your repository, you can make use of sitemaps. There are currently two forms of sitemaps included in DSpace; Google sitemaps and HTML sitemaps.

Sitemaps allow DSpace to expose it's content without the crawlers having to index every page. HTML sitemaps provide a list of all items, collections and communities in HTML format, whilst Google sitemaps provide the same information in gzipped XML format.

To generate the sitemaps, you need to run _\[dspace\]/bin/generate-sitemaps_ This creates the sitemaps in _\[dspace\]/sitemaps/_

The sitemaps can be accessed from the following URLs:

* [http://dspace.example.com/dspace/sitemap] \- Index sitemap 

* [http://dspace.example.com/dspace/sitemap?map=0] \- First list of items (up to 50,000) 

* [http://dspace.example.com/dspace/sitemap?map=n] \- Subsequent lists of items (e.g. 50,0001 to 100,000) etc... 

HTML sitemaps follow the same procedure:

* [http://dspace.example.com/dspace/htmlmap] \- Index sitemap 

* etc... 

When running _\[dspace\]/bin/generate-sitemaps_ the script informs Google that the sitemaps have been updated. For this update to register correctly, you must first register your Google sitemap index page (_/dspace/sitemap_) with Google at [http://www.google.com/webmasters/sitemaps/|http://www.google.com/webmasters/sitemaps/|http://www.google.com/webmasters/sitemaps/]. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set _http.proxy.host_ and _http.proxy.port_ in _\[dspace\]/config/dspace.cfg_

The URL for pinging Google, and in future, other search engines, is configured in _\[dspace-space\]/config/dspace.cfg_ using the _sitemap.engineurls_ setting where you can provide a comma-separated list of URLs to 'ping'.

You can generate the sitemaps automatically every day using an additional cron job:

{code

}
# Generate sitemaps


0 6 * * * [dspace]/bin/generate-sitemaps

{code}

h3. DSpace Statistics

DSpace uses the Apache Solr application underlaying the statistics. There is no need to download any separate software. All the necessary software is included. To understand all of the configuration property keys, the user should refer to 5.2.35 DSpace Statistic Configuration for detailed information.

# *DSpace Configuration for Accessing Solr.* In the _dspace.cfg_ file review the following fields to make sure they are uncommented:

{code

}solr.log.server = ${dspace.baseUrl}/solr/statistics
solr.dbfile = ${dspace.dir}/config/GeoLiteCity.dat
solr.spiderips.urls = http://iplists.com/google.txt, \
                      http://iplists.com/inktomi.txt, \
                      http://iplists.com/lycos.txt, \
                      http://iplists.com/infoseek.txt, \
                      http://iplists.com/altavista.txt, \
                      http://iplists.com/excite.txt, \
                      http://iplists.com/misc.txt, \
                      http://iplists.com/non_engines.txt

{code}
# *DSpace logging configuration for Solr.* If your DSpace instance is protected by a proxy server, in order for Solr to log the correct IP address of the user rather than of the proxy, it must be configured to look for the X-Forwarded-For header.

  This feature can be enabled by ensuring the following setting is uncommented in the logging section of _dspace.cfg_:

{code

}useProxies = true

{code}
# *DSpace configuration for fields indexed into Solr Event records for search.* In the _dspace.cfg_ file, review the following property keys to make sure they are uncommented:{code}statistics.items.dc.1=dc.identifier
statistics.items.dc.2=dc.date.accessioned
statistics.items.type.1=dcinput
statistics.items.type.2=date
statistics.default.start.datepick = 01/01/1977

{code}
# *Configuration Control.* In the _dspace.cfg_ set the following property key:_statistics.item.authorization.admin=true_This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. 

# Final steps. 

#* Perform the following step: 

{code

}
cd [dspace-source]/dspace
mvn package
cd [dspace-source]/dspace/target/dspace-<version>-build.dir
ant -Dconfig=[dspace]/config/dspace.cfg update
cp -R [dspace]/webapps/* [TOMCAT]/webapps

{code}If you only need to build the statistics, and don't make any changes to other web applications, you can replace the copy step above with: _cp \-R \[dspace\]/webapps/solr \[TOMCAT\]/webapps_

#* Restart your webapps (Tomcat/Jetty/Resin) 

h2. Windows Installation

h3. Pre-requisite Software

You'll need to install this pre-requisite software

:

* [Java SDK 1.5|http://java.sun.com/|Java SDK 1.5] or later (standard SDK is fine, you don't need J2EE)

* [PostgreSQL 8.x for Windows|http://www.postgresql.org/ftp/|PostgreSQL 8.x for Windows] OR [Oracle 9 or later

|http://www.oracle.com/database/|Oracle 9 or later].
** If you install PostgreSQL, it's recommended to select to install the pgAdmin III

 tool
* [Apache Ant 1.6.2 or later|http://ant.apache.org/|Apache Ant 1.6.2 or later]. Unzip the package in _C: and add C:\apache-ant-1.6.2\bin_ to the _PATH_ environment variable. For Ant to work properly, you should ensure that _JAVA_HOME

_ is set.
* [Jakarta Tomcat 5.x or later|http://tomcat.apache.org/|Jakarta Tomcat 5.x or later]
* [Apache Maven 2.0.8 or later|http://maven.apache.org/|Apache Maven 2.0.8 or

 later]

h3. Installation Steps

# Download the DSpace source from [SourceForge|http://sourceforge.net/projects/dspace|SourceForge] and untar it ([WinZip|http://www.winzip.com/|WinZip] will do this)
# Ensure the PostgreSQL service is running, and then run pgAdmin III (Start \-> PostgreSQL 8.0 \-> pgAdmin III). Connect to the local database as the postgres user and:
#* Create a 'Login Role' (user) called _dspace_ with the password _dspace_
#* Create a database called _dspace_ owned by the user _dspace_, with UTF-8 encoding
# Update paths in _\[dspace-source\]\dspace\config\dspace.cfg_. *Note:* Use forward slashes / for path separators, though you can still use drive letters, e.g.:_dspace.dir = C:/DSpace_Make sure you change all of the parameters with file paths to suit, specifically: 

{code

}
        dspace.dir
        config.template.log4j.properties
        config.template.log4j-handle-plugin.properties
        config.template.oaicat.properties
        assetstore.dir
        log.dir
        upload.temp.dir
        report.dir
        handle.dir

{code}
# Create the directory for the DSpace installation (e.g. _C:\DSpace

_)
# Generate the DSpace installation package by running the following from command line (cmd) from your _\[dspace-source\]/dspace/_ directory: 

{code

}
mvn package

{code}Note #1: This will generate the DSpace installation package in your _\[dspace-source\]/dspace/target/dspace-\[version\]-build.dir/_ directory.Note #2: Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you want to use Oracle instead, you should build the DSpace installation package as follows: 

{code

}
mvn -Ddb.name=oracle package

{code}
# Initialize the DSpace database and install DSpace to _\[dspace\]_ (e.g. _C:\DSpace_) by running the following from command line from your _\[dspace-source\]/dspace/target/dspace-\[version\]-build.dir/_ directory:

{code

}
ant fresh_install

{code}{*}Note:* to see a complete list of build targets, run

{code

}
ant help

{code}
# Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory_\[dspace\]\bin\dspace create-administrator_and enter the required information 

# Copy the Web application directories from _\[dspace\]\webapps to Tomcat's webapps dir, which should be somewhere like C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps_

#* Alternatively, Tell your Tomcat installation where to find your DSpace web application(s). As an example, in the _<Host>_ section of your _\[tomcat\]/conf/server.xml_ you could add lines similar to the following (but replace _\[dspace\]_ with your installation location):

{code

}
<!-- DEFINE A CONTEXT PATH FOR DSpace JSP User Interface  -->
<Context path="/jspui" docBase="[dspace]\webapps\jspui" debug="0"
	reloadable="true" cachingAllowed="false"
	allowLinking="true"/>

<!-- DEFINE A CONTEXT PATH FOR DSpace OAI User Interface  -->
<Context path="/oai" docBase="[dspace]\webapps\oai" debug="0"
	reloadable="true" cachingAllowed="false"
	allowLinking="true"/>

{code}
# Start the Tomcat service
# Browse to either [http://localhost:8080/jspui|http://localhost:8080/jspui_] or [http://localhost:8080/xmlui|http://localhost:8080/xmlui_]. You should see the DSpace home page for either the JSPUI or XMLUI, respectively.


h2.

 Checking Your Installation

The administrator needs to check the installation to make sure all components are working. Here is list of checks to be performed. In brackets after each item, it the associated component or components that might be the issue needing resolution.

* System is up and running. _User can see the DSpace home page. \[Tomcat/Jetty, firewall, IP assignment, DNS\]_

* Database is running and working correctly. _Attempt to create a user, community or collection \[PostgreSQL, Oracle\]_{_}Run the test database command to see if other issues are being report:__\[dspace\]/bin/dspace test-database_

* Email subsystem is running. The user can issue the following command to test the email system. t attempts to send a test email to the email address that is set in dspace.cfg (mail.admin). If it fails, you will get messages informing you as to why, will refer you to the DSpace documentation. _\[dspace\]/bin/test-email_

h2. Known Bugs

In any software project of the scale of DSpace, there will be bugs. Sometimes, a stable version of DSpace includes known bugs. We do not always wait until every known bug is fixed before a release. If the software is sufficiently stable and an improvement on the previous release, and the bugs are minor and have known workarounds, we release it to enable the community to take advantage of those improvements.

The known bugs in a release are documented in the _KNOWN_BUGS_ file in the source package.

Please see the [DSpace bug tracker\|#\|DSpace bug tracker|] for further information on current bugs, and to find out if the bug has subsequently been fixed. This is also where you can report any further bugs you find.


h2.

 Common Problems

In an ideal world everyone would follow the above steps and have a fully functioning DSpace. Of course, in the real world it doesn't always seem to work out that way. This section lists common problems that people encounter when installing DSpace, and likely causes and fixes. This is likely to grow over time as we learn about users' experiences.

* *Database errors occur when you run* *{_}ant fresh_install{_}*:  There are two common errors that occur. If your error looks like this-- 

{code

}[java] 2004-03-25 15:17:07,730 INFO
	    org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database
[java] 2004-03-25 15:17:08,816 FATAL
	    org.dspace.storage.rdbms.InitializeDatabase @ Caught exception:
[java] org.postgresql.util.PSQLException: Connection refused. Check
	    that the hostname and port are correct and that the postmaster is
	    accepting TCP/IP connections.
[java]     at
	    org.postgresql.jdbc1.AbstractJdbc1Connection.openConnection(AbstractJd
bc1Connection.java:204)
[java]     at org.postgresql.Driver.connect(Driver.java:139)

{code}it usually means you haven't yet added the relevant configuration parameter to your PostgreSQL configuration (see above), or perhaps you haven't restarted PostgreSQL after making the change. Also, make sure that the _db.username_ and _db.password_ properties are correctly set in _\[dspace-source\]/config/dspace.cfg_.An easy way to check that your DB is working OK over TCP/IP is to try this on the command line: 

{code

}
psql -U dspace -W -h localhost

{code}Enter the _dspace{_}{_}database_ password, and you should be dropped into the psql tool with a _dspace=>_ prompt.Another common error looks like this: 

{code

}[java] 2004-03-25 16:37:16,757 INFO
	    org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database
[java] 2004-03-25 16:37:17,139 WARN
	    org.dspace.storage.rdbms.DatabaseManager @ Exception initializing DB
	    pool
[java] java.lang.ClassNotFoundException: org.postgresql.Driver
[java]     at java.net.URLClassLoader$1.run(URLClassLoader.java:198)
[java]     at java.security.AccessController.doPrivileged(Native
	   Method)
[java]     at
	   java.net.URLClassLoader.findClass(URLClassLoader.java:186)

{code}This means that the PostgreSQL JDBC driver is not present in _\[dspace-source\]/lib_. See above.

* *Tomcat doesn't shut down*:  If you're trying to tweak Tomcat's configuration but nothing seems to make a difference to the error you're seeing, you might find that Tomcat hasn't been shutting down properly, perhaps because it's waiting for a stale connection to close gracefully which won't happen. To see if this is the case, try:

{code

}
ps -ef | grep java

{code}and look for Tomcat's Java processes. If they stay around after running Tomcat's _shutdown.sh_ script, trying _kill_ing them (with \_-9_ if necessary), then starting Tomcat again.