Since some users might want to get their test version up and running as fast as possible, offered below is an unsupported outline of getting DSpace to run quickly in a Unix-based environment using the DSpace source release.
Only experienced unix admins should even attempt the following without going to the detailed Installation Instructions |
useradd -m dspace gzip xzf dspace-5.x-src-release.tar.gz createuser --username=postgres --no-superuser --pwprompt dspace createdb --username=postgres --owner=dspace --encoding=UNICODE dspace cd [dspace-source] vi build.properties mkdir [dspace] chown dspace [dspace] su - dspace cd [dspace-source]/dspace mvn package cd [dspace-source]/dspace/target/dspace-installer ant fresh_install cp -r [dspace]/webapps/* [tomcat]/webapps /etc/init.d/tomcat start [dspace]/bin/dspace create-administrator |
You can install and run DSpace on most modern PC, laptop or server hardware. However, if you intend to run DSpace for a large community of potential end users, carefully review the Hardware Recommendations.
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.
Oracle's Java can be downloaded from the following location: http://www.oracle.com/technetwork/java/javase/downloads/index.html. The Java SE JDK version is fine, J2EE is not required for DSpace.
OpenJDK download and installation instructions can be found here http://openjdk.java.net/.
Be aware that Tomcat 7 uses Java 1.6 to compile JSPs by default. See information about Tomcat below on how to configure it to use Java 1.7 for JSPs. Tomcat 8 uses Java 1.7 for JSPs by default. If you use another Servlet Contain please refer to its documentation on this matter. |
Elasticsearch (used in DSpace for Elasticsearch Usage Statistics, an optional feature) has its own recommendations regarding Java flavour and version:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html
"Elasticsearch is built using Java, and requires at least Java 7 in order to run Only Oracle’s Java and the OpenJDK are supported.
We recommend installing the Java 8 update 20 or later, or Java 7 update 55 or later. Previous versions of Java 7 are known to have bugs that can cause index corruption and data loss."
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 existing 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
You can configure a proxy to use for some or all of your HTTP requests in Maven. 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:
<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> |
Apache Ant is 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-installer 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
postgresql.conf
: uncomment the line starting: listen_addresses = 'localhost'
. This is the default, in recent PostgreSQL releases, but you should at least check it.pg_hba.conf
and adding this line: host dspace dspace 127.0.0.1 255.255.255.255 md5
. This should appear before any lines matching all
databases, because the first matching rule governs. If you are using Tomcat 7, we recommend running Tomcat 7.0.30 or above. Tomcat 7.0.29 and lower versions suffer from a memory leak. As a result, those versions of tomcat require an unusual high amount of memory to run DSpace. This has been resolved as of Tomcat 7.0.30. More information can be found in DS-1553 |
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:
<!-- 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"/> |
You may change the port from 8080 by editing it in the file above, and by setting the variable CONNECTOR_PORT in server.xml.
Tomcat 8 and above is using at least Java 1.7 for JSP compilation. However, by default, Tomcat 7 uses Java 1.6 for JSP compilation. If you want to use Java 1.7 in your .jsp files, you have to change the configuration of Tomcat 7. Edit the file called web.xml in the configuration directory of your Tomcat instance (${CATALINA_HOME}/conf in Tomcat notation). Look for a servlet definition using the org.apache.jasper.servlet.JSPServlet servlet-class and add two init parameters compilerSourceVM
and compilerTargetVM
as you see it in the example below. Then restart Tomcat.
<servlet> <servlet-name>jsp</servlet-name> <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class> <init-param> <param-name>fork</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>xpoweredBy</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>compilerSourceVM</param-name> <param-value>1.7</param-value> </init-param> <init-param> <param-name>compilerTargetVM</param-name> <param-value>1.7</param-value> </init-param> <load-on-startup>3</load-on-startup> </servlet> |
Two different distributions are available for DSpace, both of which require you to build the distribution using Apache Maven 3. The steps that are required to execute the build are identical. In a nutshell, the binary release build will download pre-compiled parts of DSpace, while the building the source release will compile most of DSpace's source code on your local machine.
It's important to notice that both releases will require outgoing internet connections on the machine or server where you are executing the build, because maven needs to download 3rd party dependencies that are not even included in the DSpace source release distribution.
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:
[dspace]
. This is the location where DSpace is installed and running. It is the location that is 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.[dspace-source]
. This is the location where the DSpace release distribution has been unpacked. It usually has the name of the archive that you expanded such as dspace
-<version>
-release
or dspace
-<version>
-src
-release
. Normally it is the directory where all of your "build" commands will be run. [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
).[dspace-source]
and [dspace]
directories are always separate!If you ever notice that many files seems to have duplicates under [dspace-source]/dspace/target
do not worry about it. This "target" directory will be used by Maven for the build process and you should not change any file in it unless you know exactly what you are doing.
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:
useradd -m dspace |
Zip file. If you downloaded dspace-5.x-release.zip do the following:
unzip dspace-5.x-release.zip |
.gz file. If you downloaded dspace-5.x-release.tar.gz do the following:
gunzip -c dspace-5.x-release.tar.gz | tar -xf - |
.bz2 file. If you downloaded _dspace-5.x-release.tar.bz do the following:
bunzip2 dspace-5.x-release.tar.bz | tar -xf - |
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 wish to change the ownership of the dspace-5.x-release to the "dspace" user. (And you may need to change the group).
Create a dspace
database user. This is entirely separate from the dspace
operating-system user created above (you are still logged in as "root"):
createuser --username=postgres --no-superuser --pwprompt dspace |
You will be prompted (twice) for a password for the new dspace
user. Then you'll be prompted for the password of the PostgreSQL superuser (postgres
).
Create a dspace
database, owned by the dspace
PostgreSQL user (you are still logged in as 'root'):
createdb --username=postgres --owner=dspace --encoding=UNICODE dspace |
You will be prompted for the password of the PostgreSQL superuser (postgres
).
Setting up DSpace to use 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/technetwork/database/enterprise-edition/jdbc-112010-090769.html.) Run the following command (all on one line):
mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.4.0 -Dpackaging=jar -DgeneratePom=true |
You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your Oracle version - update the version in [dspace-source]/pom.xml E.g.:
<dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.4.0</version> </dependency> |
Uncomment and edit the Oracle database settings in [dspace-source]/build.properties (see below for more information on the build.properties file):
db.driver = oracle.jdbc.OracleDriver db.url = jdbc:oracle:thin:@host:port/SID |
Where SID is the SID of your database defined in tnsnames.ora, default Oracle port is 1521.
Alternatively, you can use a full SID definition, e.g.:
db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE))) |
[dspace-source]/build.properties
. This properties file contains the basic settings necessary to actually build/install DSpace for the first time (see build.properties Configuration for more detail). In particular you'll need to set these properties -- examples or defaults are provided in the file:dspace.install.dir
- must be set to the [dspace] (installation) directory (On Windows be sure to use forward slashes for the directory path! For example: "C:/dspace" is a valid path for Windows.)dspace.hostname
- fully-qualified domain name of web server.dspace.baseUrl
- complete URL of this server's DSpace home page but without any context eg. /xmlui, /oai, etc.dspace.name
- "Proper" name of your server, e.g. "My Digital Library".solr.server
- complete URL of the Solr server. DSpace makes use of Solr for indexing purposes. default.language
db.driver
db.url
db.username
- the database username used in the previous step.db.password
- the database password used 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.mail.feedback.recipient
- mailbox for feedback mail.mail.admin
- mailbox for DSpace site administrator.mail.alert.recipient
- mailbox for server errors/alerts (not essential but very useful!)mail.registration.notify
- mailbox for emails when new users register (optional)
The "build.properties" file is provided as a convenient method of setting only those configurations necessary to install/upgrade DSpace. Any settings changed in this file, will be automatically copied over to the full "dspace.cfg" file (which is held in It is also worth noting that you may choose to copy/rename the "build.properties" under a different name for different environments (e.g. "development.properties", "test.properties", and "production.properties"). You can choose which properties file you want to build DSpace with by passing a "-Denv" (environment) flag to the "mvn package" command (e.g. "mvn package -Denv=test" would build using "test.properties). See General Configuration section for more details. |
When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings. Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting. Instead, if you wish to remove/disable a particular setting, just clear out its value. For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g.
|
DSpace Directory: Create the directory for the DSpace installation (i.e. [dspace]
). As root (or a user with appropriate permissions), run:
mkdir [dspace] chown dspace [dspace] |
(Assuming the dspace UNIX username.)
Build the Installation Package: As the dspace UNIX user, generate the DSpace installation package.
cd [dspace-source] mvn package |
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: |
Mirage 2 is a responsive theme for the XML User Interface, added as a new feature in DSpace 5. It has not yet replaced the Mirage 1 theme as the XMLUI default theme. To enable Mirage 2, add the following to the <theme name="Mirage 2" regex=".*" path="Mirage2/" /> It is important to do this before executing the maven build. Mirage 2 is not yet activated in the default "mvn package" build. To include it as part of the build, run: mvn package -Dmirage2.on=true The speed of this specific step of the build can be increased by installing local copies of the specific dependencies required for building Mirage 2. The Mirage 2 developer documentation provides detailed instructions for these installations. After the installation of these dependencies, you can choose to run: mvn package -Dmirage2.on=true -Dmirage2.deps.included=false |
Without any extra arguments, the DSpace installation package will be initialized using the settings in the
See General Configuration section for more details. |
Install DSpace: As the dspace UNIX user, install DSpace to [dspace]
:
cd [dspace-source]/dspace/target/dspace-installer ant fresh_install |
To see a complete list of build targets, run: |
Decide which DSpace Web Applications you want to install. DSpace comes with a variety of web applications (in [dspace]/
webapps), each of which provides a different "interface" to your DSpace. Which ones you install is up to you, but there are a few that we highly recommend (see below):
"xmlui" = This is the XML-based User Interface, based on Apache Cocoon. It comes with a variety of out-of-the-box themes, including Mirage 1 (the default) and Mirage 2 (based on Bootstrap). Between the "xmlui" and "jspui", you likely only need to choose one.
"jspui" = This is the JSPUI-based User Interface, which is based on Bootstrap. Between the "xmlui" and "jspui", you likely only need to choose one.
"solr" (required) = This is Apache Solr web application, which is used by both the "xmlui" and "jspui" for search & browse functionality. It must be installed in support of either UI.
mvn package -Pdspace-lni
Technique A. Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the directory [tomcat]/conf/Catalina/localhost
you could add files similar to the following (but replace [dspace]
with your installation location):
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/xmlui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/jspui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/solr" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/oai" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
<?xml version='1.0'?> <!-- CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context docBase="[dspace]/webapps/[app]" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
The name of the file (not including the suffix ".xml") will be the name of the context, so for example xmlui.xml
defines the context at http://host:8080/xmlui
. To define the root context (http://host:8080/
), name that context's file ROOT.xml
.
The above Tomcat Context Settings show adding the following to each reloadable="true" cachingAllowed="false" These settings are extremely useful to have when you are first getting started with DSpace, as they let you tweak the DSpace XMLUI (XSLTs or CSS) or JSPUI (JSPs) and see your changes get automatically reloaded by Tomcat (without having to restart Tomcat). However, it is worth noting that the Apache Tomcat documentation recommends Production sites leave the default values in place ( It is entirely up to you whether to keep these Tomcat settings in place. We just recommend beginning with them, so that you can more easily customize your site without having to require a Tomcat restart. Smaller DSpace sites may not notice any performance issues with keeping these settings in place in Production. Larger DSpace sites may wish to ensure that Tomcat performance is more streamlined. |
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.)Initialize the DSpace Database (optional): While this step is optional (as the DSpace database will auto-initialize itself on first startup), it's always good to verify one last time that your database connection is working properly. To initialize the database run: (for more information on "database migrate" see Database Utilities)
[dspace]/bin/dspace database migrate |
Administrator Account: Create an initial administrator account:
[dspace]/bin/dspace create-administrator |
http://dspace.myu.edu:8080/jspui
http://dspace.myu.edu:8080/xmlui
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.
The above installation steps are sufficient to set up a test server to play around with, but there are a few other steps and options you should probably consider before deploying a DSpace production site.
A few DSpace features require that a script is run regularly (via cron, or similar):
For much more information on recommended scheduled tasks, please see Scheduled Tasks via Cron.
In order to deploy a multilingual version of DSpace you have to configure two parameters in [dspace-source]/config/dspace.cfg:
default.locale = en
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.
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.
Loosely based on http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html.
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:
$JAVA_HOME/bin/keytool -import -noprompt -v -storepass changeit -keystore $CATALINA_BASE/conf/keystore -alias tomcat -file myserver.pem |
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:
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit -trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA -file ca.pem |
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:
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit -trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1 -file client1.pem |
Now add another Connector tag to your server.xmlTomcat 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)
<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" /> |
Also, check that the default Connector is set up to redirect "secure" requests to the same port as your SSL connector, e.g.:
<Connector port="8080" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443" acceptCount="100" debug="0" /> |
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:
$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' |
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
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore \ -storepass changeit \ -certreq -alias tomcat -v -file tomcat.csr |
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):
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore \ -storepass changeit -import -alias mitCA -trustcacerts -file mitCA.pem |
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)
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore \ -storepass changeit \ -import -alias tomcat -trustcacerts -file signed-cert.pem |
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:
$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore \ $CATALINA_BASE/conf/keystore -storepass changeit |
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:
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit \ -trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1 \ -file client1.pem |
When using Apache 2.4.2 (and lower) in front of a DSpace webapp deployed in Tomcat, mod_proxy_ajp and possibly mod_proxy_http breaks the connection to the back end (Tomcat) prematurely leading to response mixups. This is reported as bug CVE-2012-3502 ( http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2012-3502 ) of Apache and fixed in Apache 2.4.3 (see http://www.apache.org/dist/httpd/CHANGES_2.4) . The 2.2.x branch hasn't shown this problem only the 2.4.x branch has. |
If you choose Apache HTTPD as your primary HTTP server, you can have it forward requests to the Tomcat servlet container via Apache Jakarta Tomcat Connector. This can be configured to work over SSL as well. First, you must configure Apache for SSL; for Apache 2.0 see Apache SSL/TLS Encryption for information about using mod_ssl.
If you are using X.509 Client Certificates for authentication: add these configuration options to the appropriate httpd configuration file, e.g. ssl.conf, and be sure they are in force for the virtual host and namespace locations dedicated to DSpace:
## SSLVerifyClient can be "optional" or "require" SSLVerifyClient optional SSLVerifyDepth 10 SSLCACertificateFile path-to-your-client-CA-certificate SSLOptions StdEnvVars ExportCertData |
Now consult the Apache Jakarta Tomcat Connector documentation to configure the mod_jk (note: NOT mod_jk2) module. Select the AJP 1.3 connector protocol. Also follow the instructions there to configure your Tomcat server to respond to AJP.
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.
First a few facts to clear up some common misconceptions:
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 send 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 [dspace]/handle-server |
Ensure that [dspace]/handle-server matches whatever you have in dspace.cfg for the handle.dir property.
If you are using Windows, the proper command is:
[dspace]/bin/dspace dsrun net.handle.server.SimpleSetup [dspace]/handle-server |
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:
"storage_type" = "CUSTOM" "storage_class" = "org.dspace.handle.HandlePlugin" |
This tells the Handle server to get information about individual Handles from the DSpace code.
Now start your handle server (as the dspace user):
[dspace]/bin/start-handle-server |
If you are using Windows, the proper command is (please replace "[dspace]\handle-server" with the full path of the handle-server directory):
[dspace]/bin/dspace dsrun net.handle.server.Main [dspace]/handle-server |
Ensure that [dspace]/handle-server matches whatever you have in dspace.cfg for the handle.dir property.
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.
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:
[dspace]/bin/dspace update-handle-prefix 123456789 1303 |
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.
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 its 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/dspace generate-sitemaps This creates the sitemaps in [dspace]/sitemaps/
The sitemaps can be accessed from the following URLs:
When running [dspace]/bin/dspace 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/. 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]/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:
# Generate sitemaps at 6:00 am local time each day 0 6 * * * [dspace]/bin/dspace generate-sitemaps |
More information on why we highly recommend enabling sitemaps can be found at Search Engine Optimization (SEO). |
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 DSpace Statistic Configuration for detailed information.
Essentially installing on Windows is the same as installing on Unix so please refer back to the main Installation Instructions section.
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.
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 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.
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.
ant fresh_install
: There are two common errors that occur.If your error looks like this:
[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) |
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]/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:
psql -U dspace -W -h localhost |
Enter the dspace database password, and you should be dropped into the psql tool with a dspace=> prompt.
Another common error looks like this:
[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) |
This means that the PostgreSQL JDBC driver is not present in [dspace]/lib. See above.
ant fresh_install
: There are two common errors that may occur:If your error looks like this:
[get] Error getting http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz to /usr/local/dspace/config/GeoLiteCity.dat.gz BUILD FAILED /dspace-release/dspace/target/dspace-installer/build.xml:931: java.net.ConnectException: Connection timed out |
it means that you likely either (a) don't have an internet connection to download the necessary GeoLite Database file (used for DSpace Statistics), or (b) the GeoLite Database file's URL is no longer valid.
Another common message looks like this:
[echo] WARNING : FAILED TO DOWNLOAD GEOLITE DATABASE FILE [echo] (Used for DSpace Solr Usage Statistics) |
Again, this means the GeoLite Database file cannot be downloaded or is unavailable for some reason. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.
ps -ef | grep java
and look for Tomcat's Java processes. If they stay around after running Tomcat's shutdown.sh script, trying running kill
on them (or kill -9
if necessary), then starting Tomcat again.ps -ef | grep postgres
You might see some processes like this:
dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace 127.0.0.1 idle in transaction |
This is normal. DSpace maintains a 'pool' of open database connections, which are re-used to avoid the overhead of constantly opening and closing connections. If they're 'idle' it's OK; they're waiting to be used.
However sometimes, if something went wrong, they might be stuck in the middle of a query, which seems to prevent other connections from operating, e.g.:
dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace 127.0.0.1 SELECT |
This means the connection is in the middle of a SELECT operation, and if you're not using DSpace right that instant, it's probably a 'zombie' connection. If this is the case, try running kill
on the process, and stopping and restarting Tomcat.