All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Unsupported Release
This documentation relates to DSpace 1.8.x, an old, unsupported version. Looking for another version? See all documentation.
As of January 2015, DSpace 1.8.x is no longer supported. We recommend upgrading to a more recent version of DSpace. See DSpace Software Support Policy.
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 gunzip -c dspace-1.x-src-release.tar.gz | tar -xf - createuser -U postgres -d -A -P dspace createdb -U dspace -E UNICODE dspace cd [dspace-source]/dspace/config vi dspace.cfg mkdir [dspace] chown dspace [dspace] su - dspace cd [dspace-source]/dspace mvn package cd [dspace-source]/dspace/target/dspace-<version>-build ant fresh_install cp -r [dspace]/webapps/* [tomcat]/webapps /etc/init.d/tomcat start [dspace]/bin/dspace create-administrator
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.
DSpace requires Oracle Java 6 (standard SDK is fine, you don't need J2EE). Please note, at this time, DSpace does not function properly with Java JDK 7 (see warning below).
Oracle's Java can be downloaded from the following location: http://www.oracle.com/technetwork/java/javase/downloads/index.html. Again, you can just download the Java SE JDK version.
Java 7 is currently unsupported
DSpace does not currently support Java 7, as there is a known issue with Java 7 and Lucene/SOLR (which DSpace uses for search & browse functionality). For more details, see this article on the Apache site: "WARNING: Index corruption and crashes in Apache Lucene Core / Apache Solr with Java 7" as well as this Java bug report: 7073868
Other flavors of Java may cause issues
Only Oracle's Java has been tested with each release and is known to work correctly. Other flavors of Java may pose problems.
DSpace 1.7.x requires usage of Maven 2.2.x
DSpace 1.7.x required usage of Maven 2.2.x, as it did not build properly when using Maven 2.0.x or Maven 3.x. This was a known issue (see DS-788). However, DSpace 1.8.x resolved this issue so that DSpace now builds properly with Maven 2.2.x or above.
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 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:
<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 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 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
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.
With the advent of a new Apache Maven 2 based build architecture (first introduced inDSpace 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.
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 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.[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
. 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!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 rootrun:
useradd -m dspace
Zip file. If you downloaded dspace-1.8-release.zipdo the following:
unzip dspace-1.8-release.zip
.gz file. If you downloaded dspace-1.8-release.tar.gzdo the following:
gunzip -c dspace-1.8-release.tar.gz | tar -xf -
.bz2 file. If you downloaded _dspace-1.8-release.tar.bz2_do the following:
bunzip2 dspace-1.8-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 which to change the ownership of the dspace-1.6-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.
createuser -U postgres -d -A -P dspace
You will be prompted for the password of the PostgreSQL superuser (postgres
). Then you'll be prompted (twice) for a password for the new dspace
user.
Create a dspace
database, owned by the dspace
PostgreSQL user (you are still logged in at 'root'):
createdb -U dspace -E UNICODE dspace
You will be prompted for the password of the DSpace database user. (This isn't the same as the dspace user's UNIX password.)
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 the 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.3 -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.xmlE.g.:
<dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.3</version> </dependency>
Edit the [dspace-source]/dspace/config/dspace.cfgdatabase settings:
db.name = oracle 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)))
Also set the username and password of the database you created in step 3:
db.username = your_oracle_username db.password = your_oracle_password
[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)
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:
feedback.recipient = ${mail.admin
}
Refer to the General Configuration section 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:
mkdir [dspace] chown dspace [dspace]
(Assuming the dspace UNIX username.)
Installation Package: As the dspaceUNIX user, generate the DSpace installation package.
cd [dspace-source]/dspace/ mvn package
Defaults to PostgreSQL settings
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:
mvn -Ddb.name=oracle package
Build DSpace and Initialize Database: As the dspace UNIX user, initialize the DSpace database and install DSpace to [dspace]_
:
cd [dspace-source]/dspace/target/dspace-[version]-build ant fresh_install
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 Common Problems Section.
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):
<!-- Define the default virtual host Note: XML Schema validation will not work with Xerces 2.2. --> <Host name="localhost" appBase="[dspace]/webapps" ....
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 couple of DSpace features require that a script is run regularly – the e-mail subscription feature that alerts users of new items being deposited, and the new 'media filter' tool, that generates thumbnails of images and extracts the full-text of documents for indexing.
To set these up, you just need to run the following command as the dspace UNIX user:
crontab -e
Then add the following lines:
# Send out subscription e-mails at 01:00 every day 0 1 * * * [dspace]/bin/dspace sub-daily # Run the media filter at 02:00 every day 0 2 * * * [dspace]/bin/dspace filter-media # Run the checksum checker at 03:00 0 3 * * * [dspace]/bin/dspace checker -lp # Mail the results to the sysadmin at 04:00 0 4 * * * [dspace]/bin/dspace checker-emailer -c
Naturally you should change the frequencies to suit your environment.
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):
# Clean up the database nightly at 4.20am 20 4 * * * vacuumdb --analyze dspace > /dev/null 2>&1
In order that statistical reports are generated regularly and thus kept up to date you should set up the following cron jobs:
# 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
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.
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.
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
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: NOTmod_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 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 [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
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 0 6 * * * [dspace]/bin/dspace generate-sitemaps
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 Statistics for detailed configuration information.
DSpace Configuration for Accessing Solr. In the dspace.cfgfile review the following fields to make sure they are uncommented:
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
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:
useProxies = true
Perform the following step:
cd [dspace-source]/dspace mvn package cd [dspace-source]/dspace/target/dspace-<version>-build ant -Dconfig=[dspace]/config/dspace.cfg update cp -R [dspace]/webapps/* [TOMCAT]/webapps
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
The GeoLite Database file (at [dspace]/config/GeoLiteCity.dat) is used by the DSpace Statistics engine to generate location/country based reports. (Note: If you are not using DSpace Statistics, this file is not needed.)
In most cases, this file is installed automatically when you run ant fresh_install
. However, if the file cannot be downloaded & installed automatically, you may need to manually install it.
As this file is also sometimes updated by MaxMind.com, you may also wish to update it on occasion.
You have two options to install/update this file:
Attempt to re-run the automatic installer from your DSpace Source Directory ([dspace-source]). This will attempt to automatically download the database file, unzip it and install it into the proper location:
ant update_geolite
ant -Dgeolite=[full-URL-of-geolite] update_geolite
[dspace]/config/GeoLiteCity.dat
.If you are installing DSpace on Windows, you will still need to install all the same Prerequisite Software, as listed above.
Note: Use forward slashes / for path separators, though you can still use drive letters, e.g.: dspace.dir = C:/DSpaceAlso, make sure you change all of the parameters with file paths to suit, specifically:
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
Generate the DSpace installation package by running the following from command line (cmd) :
cd [dspace-source]/dspace/ mvn package
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:
mvn -Ddb.name=oracle package
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/directory:
ant fresh_install
ant help
Create an administrator account, by running the following from your [dspace] (e.g. C:\DSpace) directory:
[dspace]\bin\dspace create-administrator
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):
<!-- DEFINE A CONTEXT PATH FOR DSpace XML User Interface --> <Context path="/xmlui" docBase="[dspace]/webapps/xmlui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> <!-- 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"/> <!-- DEFINE ADDITIONAL CONTEXT PATHS FOR OTHER DSPACE WEB APPLICATIONS (SOLR, SWORD, LNI, etc.). CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context path="/[app]" docbase="[dspace]/webapps/[app]" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>
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-1.8.0-build/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. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.
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.
18 Comments
Jason Stirnaman
Postgresql docs now encourage running the Autovacuum daemon instead of using the Vacuum command:
http://www.postgresql.org/docs/8.3/static/routine-vacuuming.html
manish
i have a problem during the installation of postgreSQL please guide me how i install postgreSQL9.1.3-2 version please help me
David Isaak
I got a little tripped up with the example under Windows Installation step 8 ("Alternatively, Tell your Tomcat installation where to find your DSpace web application(s)...").
I pasted the code directly into server.xml and did not realize that I would need to define a context path for each webapp. At first I could not get the XMLUI to work and could not figure out why. It was my misreading, but you may want to make it clearer that the example only covers two of the webapps. Thanks,
Tim Donohue
Thanks for reporting that David. I tried to cleanup the Windows Installation Step #8 to make it clearer. I added an example for XMLUI specifically, and then added a generic example (for any other DSpace web applications).
Lighton Phiri
I've installed versions 1.8.x on Linux and Windows platforms and in both cases, the installation package is constructed in
[dspace-source]/dspace/target/dspace-<version>-build
Not
[dspace-source]/dspace/target/dspace-<version>-build.dir
The .dir should not be part of the relative directory name.
Tim Donohue
Thanks for noticing that, Lighton! It's now been fixed in the instructions above.
manish
i have a problem during the installation of dspace i want you just give full instruction which version is support with each together ..
Lighton Phiri
It would help if you specified the platform (operating system) you are installing DSpace on and possibly the exact problem you are experiencing. At what stage of the installation are you having problems?
manish
Hi Lighton Phiri
i use window7.During the installation of postgresql 9.1.3 it installed but i can not create any database i cant connect to the server .it require port number what should i do please help me ..........
Tim Donohue
Manish,
Please email us on the dspace-tech@lists.sourceforge.net listserv (https://lists.sourceforge.net/lists/listinfo/dspace-tech). It will be much easier to help solve your problem via email than via comments to this wiki page.
When you email us, please provide more details on the steps you've taken so far, and send along any error messages that may appear either on the command-line or in the DSpace log files. For more information on locating error messages in logs, please see: https://wiki.duraspace.org/display/DSPACE/Troubleshoot+an+error
We hope to hear from you on the dspace-tech mailing list.
Robin Taylor
Hi Manish,
Could I suggest you email the dspace-tech mailing list at dspace-tech@lists.sourceforge.net ? Its probably a better place to get help with any installation problems you may be having. You can find some information about the mailing lists here http://www.dspace.org/Mailing-Lists .Thanks, Robin.
manish
HI Robin
apache-ant-1.8.3-bin
apache-manven-2.2.1-bin
apache-tomcat-6.0.35exe
dspace-1.8.2-release
jdk-6u32-window-x64
postgresql-9.1.3-window-x64.exe
these software i use for installation dspase
i install apache-ant-1.8.3-bin,apache-manven-2.2.1-bin
what ever instruction is given in dspace i follow all instruction
but when i intall postgresql-9.1.3-window-x64.exe a error message is
show i send u a image with i dont know what shoud i do know help me
apache-ant-1.8.3-bin
apache-manven-2.2.1-bin
apache-tomcat-6.0.35exe
dspace-1.8.2-release
jdk-6u32-window-x64
postgresql-9.1.3-window-x64.exe
these software i use for installation dspase
i install apache-ant-1.8.3-bin,apache-manven-2.2.1-bin
what ever instruction is given in dspace i follow all instruction
but when i intall postgresql-9.1.3-window-x64.exe a error message is
show i send u a image with i dont know what shoud i do know help me
Lighton Phiri
Robin and Tim suggested that you send your question to the dspace-general mailing list --to do that, you should do the following:
Step #1: Go here -> https://lists.sourceforge.net/lists/listinfo/dspace-general
Step #2: Subscriber using your email address
Step #3: Send your question with details to dspace-general@lists.sourceforge.net
Maurice Bouchard
I think the installation instructions would be clearer if steps 5 and 6 (in the general Installation section, 3 and 4 in the Windows Installation section) were reversed. That is, create the empty installation directory first, then edit the .cfg. If I had created the directory, it would have been obvious what was expected in dspace.dir (the first pass through, I thought the dspace source directory was what was being asked for). It's a minor point and if I had been reading the directions more closely, I wouldn't have installed in the wrong place, but I think it's clearer if you create a directory then add it to a config file, not the other way 'round.
Just my 2 cents,
Mb
manish
hello sir
i have a problem i have done all process but when i enter localhost:8080/xmuli then enter then it show a message the path dose not found
doing this process i have create my emailid,password in one word i do all step then after i found this error please help me ....................
Lighton Phiri
The path separators (/), for docBase attribute in server.xml file, in step #8 of the Windows Installation instructions need to be replaced with backslashes... this could be misleading to individuals without prior experience working with tomcat.
Amar Shejao
hello frnds
I am working as a Librarian in united CIIGMA Hospital ans research center in Aurangabad, India . It is my responsibility to develop digital library .plz tell me the detail procedure for installation of DSpace.
Tim Donohue
Amar,
The detailed procedure to install DSpace is found on this wiki page (see above). You can also find the detailed installation instructions for DSpace 3 at DSpace 3.x Installation.
If you have specific questions about the detailed instructions, please ask them on our tech support mailing list, dspace-tech@googlegroups.com
Information on joining this 'dspace-tech' list can be found at:
https://groups.google.com/d/forum/dspace-tech