Page History

...

Code Block

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.dir
ant fresh_install
cp -r [dspace]/webapps/* [tomcat]/webapps
/etc/init.d/tomcat start
[dspace]/bin/dspace create-administrator

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.

...

UNIX-like OS (Linux, HP/UX, Mac OSX, 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 or local system administrators to determine what is already available.
Microsoft Windows: (see full Windows Instructions for full set of prerequisites)After verifying all prerequisites below, see the Windows Installation section for Windows tailored instructions

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

...

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

Apache Maven 2.

...

2.

...

x (Java build tool)

...

Note
title Known issue with Maven 2.0.x and Maven 3.x and DSpace 1.7.x
DSpace 1.7.x does not build properly when using Maven 2.0.x or Maven 3.x. This is a known issue. The quick fix is to use Maven 2.2.x. More information on this issue can be found in the following JIRA issue: DS-788.
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" Wiki MarkupMaven 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
...

Apache Ant 1.7 or later (Java build tool)

Wiki MarkupApache 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

...

Apache Tomcat 5.5 or later. Tomcat can be downloaded from the following location: 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"unmigrated-wiki-markup

*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 Block

<!-- 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.

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

...

Perl

...

(only

...

required

...

for

...

[dspace

...

]/bin/dspace-info.pl)

Installation Instructions

...

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:
  - Wiki Markup_\[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

...

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.unmigrated-wiki-markup
*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.
Wiki Markup*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\!_

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 Block
useradd -m dspace
Download the 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:
1. Zip file. If you downloaded dspace-1.6-release.zip do the following:
  Code Block
  unzip dspace-1.7-release.zip
2. .gz file. If you downloaded dspace-1.6-release.tar.gz do the following:
  Code Block
  gunzip -c dspace-1.7-release.tar.gz | tar -xf -
3. .bz2 file. If you downloaded _dspace-1.6-release.tar.bz2_do the following: unmigrated-wikimarkup
  Code Block
  bunzip2 dspace-1.7-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).
Database Setup
- PostgreSQL:
  - A PostgreSQL JDBC 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 Block
    createuser -U postgres -d -A -P dspace ; dspace createdb -U dspace -E UNICODE dspace
    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/technologytechnetwork/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.htmldatabase/enterprise-edition/jdbc-112010-090769.html) Run the following command (all on one line)
    Code Block
    Code Block
    $ mvn install:install-file -Dfile=ojdbc14ojdbc6.jar -DgroupId=com.oracle.oracle -DartifactId=ojdbc14ojdbc6 -Dversion=1011.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 required 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.
  - Wiki MarkupEdit the _\[dspace-source\]/dspace/config/dspace.cfg_ database settings:
    Code Block
    db.name = oracle db.url = jdbc:oracle:thin:@//host:port/dspace db.driver = oracle.jdbc.OracleDriver
unmigrated-wiki-markup

*Initial Configuration:* Edit {{\[dspace-source\]/dspace/config/dspace.cfg}}, in particular you'll need to set these properties:

unmigrated-wiki-markup

{{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)

Info
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.

Wiki Markup*DSpace Directory:* Create the directory for the DSpace installation (i.e. {{\[dspace\]}}). As _root_ (or a user with appropriate permissions), run:
Code Block
mkdir [dspace] chown dspace [dspace]
(Assuming the dspace UNIX username.)unmigrated-wiki-markup*

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

Code Block
cd [dspace-source]/dspace/ mvn package

*

Info

title	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

Wiki Markup

Build DSpace and Initialize Database:* As the _dspace_ UNIX user, initialize the DSpace database and install DSpace to {{\[dspace\]\_}}:
Code Block
cd [dspace-source]/dspace/target/dspace-[version]-build.dir ant fresh_install
Info
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.
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 \
  cp -R \ [dspace\]/webapps/\* \ [tomcat\]/webapps\*}} (This will copy all the web applications to Tomcat). \\ {{cp \
  cp -R \ [dspace\]/webapps/jspui \ [tomcat\]/webapps\*}} (This will copy only the jspui web application to Tomcat.)unmigrated-wiki-markup
- _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 Block
   <Host name="localhost" appBase="[dspace]/webapps" ....
Administrator Account: Create an initial administrator account:
Code Block
[dspace]/bin/dspace create-administrator
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)

...

Multilingual Installation

Wiki MarkupIn 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.

...

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:
Code Block
_\[dspace\]/bin/dspace make-handle-config_ Ensure that \_\[dspace\ [dspace]/handle-server
Ensure that [dspace]/handle-server_ matches whatever you have in _dspace.cfg_ for the _handle.dir_ property.unmigrated-wiki-markup
Edit the resulting _\[dspace\]/handle-server/config.dct_ file to include the following lines in the _"server_config"_ clause:
Code Block
"storage_type" = "CUSTOM" "storage_class" = "org.dspace.handle.HandlePlugin"
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 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.unmigrated-wiki-markup
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 Block
[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.

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 Block
[dspace]/bin/dspace update-handle-prefix 123456789 1303

...

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

Wiki MarkupTo 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:

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 HTML based sitemap
etc...

...

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/|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_

Wiki MarkupThe 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 Block
# Generate sitemaps 0 6 * * * [dspace]/bin/dspace generate-sitemaps

DSpace Statistics

...

DSpace Configuration for Accessing Solr. In the dspace.cfg file review the following fields to make sure they are uncommented:

Code Block

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:

Code Block
useProxies = true

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: . This feature can be enabled by ensuring the following setting is uncommented in the logging section of dspace.cfg:

Code Block

useProxies = true

Code Block

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

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: unmigrated-wiki-markup
  Code Block
  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
  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)

Windows Installation

Pre-requisite Software

You'll need to install this pre-requisite software:

If you are installing DSpace on Windows, you will still need to install all the same Prerequisite Software, as listed above.

If you install PostgreSQL, it's recommended to select to install the pgAdmin III tool. It provides a nice User Interface for interacting with PostgreSQL databases.
Java SDK 1.5 or later (standard SDK is fine, you don't need J2EE)
PostgreSQL 8.x for Windows OR 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. 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
Apache Maven 2.0.8 or later

Installation Steps

Download the DSpace source from SourceForge and untar unzip it (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

Wiki MarkupUpdate 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:

Also, make sure you change all of the parameters with file paths to suit, specifically:

Code Block
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

Create the directory for the DSpace installation (e.g. C:\/DSpace)
Wiki MarkupGenerate the DSpace installation package by running the following from command line (cmd) from your _\[dspace-source\]/dspace/_ directory: unmigrated-wiki-markup
Code Block
mvn package
- 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 Block
- mvn -Ddb.name=
oracle package unmigrated-wiki-markup
- 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.dir/_ directory:
Code Block
ant fresh_install
- Note: to see a complete list of build targets, run
Code Block
- : ant
- help
unmigrated-wiki-markup
Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory: unmigrated-wiki-markup
Code Block
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_

Wiki MarkupAlternatively, 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 Block

<!-- 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"/>

Start the Tomcat service
Browse to either http://localhost:8080/jspui or http://localhost:8080/xmlui. You should see the DSpace home page for either the JSPUI or XMLUI, respectively.

...

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.

Wiki MarkupSystem is up and running. _User can see the DSpace home page. \ [Tomcat/Jetty, firewall, IP assignment, DNS\]_unmigrated-wiki-markup
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\Oracle]Run the test database command to see if other issues are being report:[dspace]/bin/dspace test-database_unmigrated-wiki-markup
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_

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\ 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.

...

Database errors occur when you run ant fresh_install: There are two common errors that occur.

If your error looks like this

--

:

Code Block

[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)

unmigrated-wiki-markup

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 Block
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:

Code Block

[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)

Wiki Markup

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 running:
Code Block
- 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
_ing
- on them (
with _
- or kill -9 if necessary), then starting Tomcat again.
Database connections don't work, or accessing DSpace takes forever: If you find that when you try to access a DSpace Web page and your browser sits there connecting, or if the database connections fail, you might find that a 'zombie' database connection is hanging around preventing normal operation.
- To see if this is the case, try running:
Code Block
- ps
- -ef
- |
- grep
- postgres
- You might see some processes like this:
  Code Block
  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.:
  Code Block
  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
_ing
- on the process, and stopping and restarting Tomcat.

All Versions

DSpace Documentation

Page tree

Versions Compared

Old Version 35

New Version Current

Key

Prerequisite Software

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

Apache Maven 2.

2.

x (Java build tool)

Apache Ant 1.7 or later (Java build tool)

Perl

(only

required

for

[dspace

]/bin/dspace-info.pl)

Installation Instructions

Installation

Multilingual Installation

Updating Existing Handle Prefixes

DSpace Statistics

Windows Installation

Pre-requisite Software

Installation Steps

Known Bugs

Code Block
Code Block
$ mvn install:install-file -Dfile=ojdbc14ojdbc6.jar -DgroupId=com.oracle.oracle -DartifactId=ojdbc14ojdbc6 -Dversion=1011.2.0.2.0 -Dpackaging=jar -DgeneratePom=true