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

...

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"

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.

...

Wiki Markup

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

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}}. In the case of the Source Release Normally it is the directory where all of your "build" commands will be run. In the case of the Binary Release all "build" commands will be run from the subdirectory {{\[dspace-source\]/dspace}}.&nbsp;

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

...

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:

Zip file. If you downloaded dspace-1.8-release.zip do the following:
Code Block
unzip dspace-1.8-release.zip
.gz file. If you downloaded dspace-1.8-release.tar.gz do the following:
Code Block
gunzip -c dspace-1.8-release.tar.gz | tar -xf -

.bz2 file. If you downloaded _dspace-1.8-release.tar.bz2_do the following:

Code Block
bunzip2 dspace-1.8-release.tar.bz \| tar -xf -

Wiki Markup

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 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/technetwork/database/enterprise-edition/jdbc-112010-090769.html) Run the following command (all on one line)
    Code Block
    mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.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 Markup
    Edit 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

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

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

Installation Package: As the dspace UNIX user, generate the DSpace installation package. For the Source Release :

Code Block
cd [dspace-source]/ mvn package

For the Binary Release :

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:

Wiki Markup

_Technique A._ Simple and complete. You copy only (or all) of the DSpace Web application(s) you wish to use from the \[dspace\]/webapps directory to the appropriate directory in your Tomcat/Jetty/Resin installation. For example:
\\  
{{cp \-R \[dspace\]/webapps/\* \[tomcat\]/webapps\*}} (This will copy all the web applications to Tomcat).
\\  
{{cp \-R \[dspace\]/webapps/jspui \[tomcat\]/webapps\*}} (This will copy only the jspui web application to Tomcat.)

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
<!-- 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:
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)

...

To configure your DSpace installation to run the handle server, run the following command:

Code Block
[dspace]/bin/dspace make-handle-config [dspace]/handle-server

Wiki Markup
Ensure that _\[dspace\]/handle-server_ matches whatever you have in _dspace.cfg_ for the _handle.dir_ property.

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.

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.

...

Wiki Markup

The GeoLite Database file (at \[dspace\]/config/GeoLiteCity.dat) is used by the [DSpace Statistics|#DSpace Statistics] engine to generate location/country based reports.  (_Note: If you are not using DSpace Statistics, this file is not needed._)

...

Wiki Markup

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:

Code Block
ant update_geolite

Wiki Markup

NOTE: If the location of the GeoLite Database file is known to have changed, you can also run this auto-installer by passing it the new URL of the GeoLite Database File: {{ant \-Dgeolite=\[full-URL-of-geolite\] update_geolite}}

OR, you can manually install the file by performing these steps yourself:
- First, download the latest GeoLite Database file from http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
- Next, unzip that file to create a file named GeoLiteCity.dat
- Wiki Markup
  Finally, move or copy that file to your DSpace installation, so that it is located at {{\[dspace\]/config/GeoLiteCity.dat}}.

...

Download the DSpace source from SourceForge and 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 Markup
Update paths in _\[dspace-source\]\dspace\config\dspace.cfg_

Note: Use forward slashes / for path separators, though you can still use drive letters, e.g.: dspace.dir = C:/DSpace 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)
Generate the DSpace installation package by running the following from command line (cmd) :
For the Source Release :
Code Block
cd [dspace-source]/ mvn package
For the Binary Release :
Code Block
cd [dspace-source]/dspace/ mvn package
- Wiki Markup
  _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

Wiki Markup

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: ant help

Wiki Markup
Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory:

Code Block
[dspace]\bin\dspace create-administrator

Wiki Markup
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\webapps_

Wiki Markup

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

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

...

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)

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\]/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\]/lib_. See above.

...

All Versions

DSpace Documentation

Page tree

Versions Compared

Old Version 16

New Version 17

Key