DSpace Prerequisite applications and Installation Guide

The list below are the third party components and tools you will need for running a DSpace Server and
also some important points are mentioned for some of the applications that requires additional
configuration issue when installed.
1. Oracle Java JDK
!. "pache #aven $.%.&'
#aven is necessary in the first stage of the build process to assemble the installation pac(age for
your DSpace instance. )t gives you the fle*ibility to customi+e DSpace using the e*isting #aven
pro,ects found in the [dspace-source]/dspace/modules directory or by adding in your own #aven
pro,ect to build the installation pac(age for DSpace- and apply any custom interface .overlay.
changes.
Note:
/or easier access of the 0mvn command- add [c:\ maven\apache-maven-3.0.4]\bin
to the system environment variable as follows.
1. Open the 0System properties1 dialog by clic(ing on the #y 2omputer icon properties menu.
!. 3o to the advanced menu of the System properties.
$. 3o to System 4ariables section and edit the path variable.
4. "dd 0;[c:\ maven\apache-maven-3.0.4]\bin without the quotations and the
braces to the end of the variable value field. 5ote' 62'7maven7 apache-maven-3.0.48-
replace it with the location where you e*tracted the apache-maven-3.0.4 +ip file.
9. /inally- clic( o( button then logoff or restart to reflect the changes.
$. "pache "nt 1.: or later'
"pache "nt is required for the second stage of the build process. )t is used once the installation
pac(age has been constructed in [dspace-source]/dspace/target/dspace-<version>-build.dir.
Note:
"s described in step ! of the "pache #aven $.%.& - add [c:\ant\apache-ant-
1.8.2]\bin to the system environment variable.
&. ;elational Database <=ostgreS>?@
9. Servlet Angine' "pache Tomcat B.%.!9 binary release
Note:
The following are some configuration issues you need to consider when installing "pache
Tomcat.
C DSpace will need to run as the same user as Tomcat- so you might want to install and
run Tomcat as a user called DdspaceD. 2reate the environment variable TOMCAT_!"# as follow'
1. Open the System properties from your computer and clic( on the Anvironment 4ariables button as
shown in the snapshot below.

!. 2lic( on the 5ew button and when a dialog appears- set the variable name to TOMCAT_S!"
and the variable value to any user name you want and clic( o( button then the user will be added
to the lists of Eser variables. ?oo( the snapshot below.
C Fou need to ensure that Tomcat has enough memory to run DSpace and uses ET/C: as its
default file encoding for international character support.
C Ansure in your startup scripts <6dspace87bin7dspace.bat@ that the following environment
variable is set' JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoin!="T#-$".
This sample script is taken from the [dspace]\bin\dspace.bat file
@echo off
set !""#$%&'(")*cd*
set +,-,&./%0)-1m23124 -1ms544 -'fi6e.encodin7)!%8-8
C Modi#ications in [tomcat]/conf/server.xml' Fou also need to alter TomcatDs default
configuration to support searching and browsing of multiCbyte ET/C: correctly. Fou need to
add a configuration option to the <Connector> element in [tomcat]/con$ig/server.%ml'
#&"ncoding'(T)-*( e.g. if youDre 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"/>
Fou may change the port from :%:% by editing it in the file above- and by setting the
variable CO++"CTO#_,O#T in server.%ml.
. =erl' strawberryCperl 4.9.1!.$.%
Dspace Director$ Structure
Gefore beginning an installation of the Dspace System- it is important to get a general understanding of
the DSpace directories and the names by which they are generally referred.
DSpace uses three separate directory trees. "lthough you donDt need to (now all the details of them in
order to install DSpace- you do need to (now they e*ist
%& T'e installation director$- referred to as 6dspace8. 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.. )t is where
all the DSpace configuration files- command line scripts- documentation and webapps will be
installed to.
(& T'e source director$- referred to as 6dspaceCsource8 . This is the location where the DSpace
release distribution has been un+ipped into. )t usually has the name of the archive that you
e*panded such as dspaceCHversionICrelease or dspaceCHversionICsrcCrelease. 5ormally it is the
directory where all of your .build. commands will be run.
)& T'e *eb deplo$ment director$. This is the directory that contains your DSpace web
application<s@.
DSpace Installation Steps
1. En+ip the DSpace source release somewhere on your dis( e.g <2'7@
!. Ansure the =ostgreS>? service is running- and then run pg"dmin ))) <Start CI =ostgreS>? :.% CI
pg"dmin )))@. 2onnect to the local database as the postgres user and'
2reate a D?ogin ;oleD <user@ called dspace with the password dspace
2reate a database called dspace owned by the user dspace- with ET/C: encoding
3. Edit [dspace-source]/dspace/config/dspace.cfg, in particular you'll
need to set these properties:
assetsto9e.di9 C location for file storage
6o7.di9 - Jhere to put the logs
:p6oad.temp.di9 C Jhere to temporarily store uploaded files
9epo9t.di9 - directory where live reports are stored
hand6e.di9 - Directory for installing Kandle server files
dspace.dir - must be set to the [dspace] <installation@ directory.
dspace.url - complete E;? of this serverDs DSpace home page.
dspace.hostname - fullyCqualified domain name of web server.
dspace.name - .=roper. name of your server- e.g. .#y Digital ?ibrary..
db.password - the database password you entered in the previous step.
mail.server - fullyCqualified domain name of your outgoing mail server.
mail.from.address - the ./rom'. address to put on email sent by DSpace.
feedback.recipient - mailbo* for feedbac( mail.
mail.admin - mailbo* for DSpace site administrator.
alert.recipient - mailbo* for server errorsLalerts <not essential but very usefulM@
registration.notify - mailbo* for emails when new users register <optional@
Note:
C Ese forward slashes / for path separators- though you can still use drive letters- e.g.
dspace.dir ' C-/.!pace.
C Fou can also interpolate the value of one configuration variable in the value of
another one. /or e*ample- to set feedback.recipient to the same value as mail.admin-
the line would loo( li(e' feedback.recipient = ${mail.admin}
&. 2reate the directory for the DSpace installation <e.g. C-/.!pace@
9. 3enerate the DSpace installation pac(age by running the following from command line <cmd@ '
cd 6dspaceCsource8LdspaceL
mvn pac(age
Note:
- This will generate the DSpace installation pac(age in your [dspace
source]/dspace/target/dspace-[version]-build.dir/ directory.
- Jithout any e*tra arguments- the DSpace installation pac(age is initiali+ed for
=ostgreS>?
. )nitiali+e the DSpace database and install DSpace to [dspace] <e.g. C-/.!pace@ by running the
following from command line from your [dspace-source]/dspace/target/dspace-[version]-
build.dir/ directory'
ant freshNinstall
Note: to see a complete list of build targets- run' ant help
B. 2reate an administrator account- by running the following from your [dspace] <e.g. C-/.!pace@
directory'
6dspace87bin7dspace createCadministrator
:. 2opy the Jeb application directories from [dspace]/0ebapps to TomcatDs webapps dir- which
should be somewhere li(e C-/,rogram )iles/Apac1e !o$t0are )oundation/Tomcat/0ebapps
"lternatively- Tell your Tomcat installation where to find your DSpace web application<s@. "s an
e*ample- in the <2ost> section of your [tomcat]/con$/server.%ml you could add lines similar to
the following <but replace [dspace] with your installation location@'

HMCC DA/)5A " 2O5TAOT ="TK /O; DSpace JS= Eser )nterface CCI
H2onte*t pathP.L,spui. docGaseP.6dspace87webapps7,spui. debugP.%.
reloadableP.true. caching"llowedP.false. allow?in(ingP.true.LI
HMCC DA/)5A " 2O5TAOT ="TK /O; DSpace O") Eser )nterface CCI
H2onte*t pathP.Loai. docGaseP.6dspace87webapps7oai. debugP.%.
reloadableP.true. caching"llowedP.false. allow?in(ingP.true.LI
Q. Start the Tomcat service
1%. Growse to either http'LLlocalhost':%:%L,spui or http'LLlocalhost':%:%L*mlui. Fou should see the
DSpace home page for either the JS=E) or O#?E)- respectively.
.