Versions Compared

Old Version 16

changes.mady.by.user Jeffrey Trimble

Saved on

compared with

New Version 17

changes.mady.by.user Jeffrey Trimble

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DSpace

...

System

...

Documentation:

...

Installation

...

Table of Contents

...

outlinetrue

For the Impatient

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.

Only experienced unix admins should even attempt the following without going to Section 3.3

Warning
=true} h2. For the Impatient 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. Only experienced unix admins should even attempt the following without going to Section 3.3 {warning} {code}
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
{code}{warning} h2. Prerequisite Software The list below describes the 
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.
...
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.
...
UNIX-like 
...
 OS 
...
 or 
...
 Microsoft 
...
 Windows
...
  • UNIX-like 
...
  •  OS 
...
  •  (Linux, 
...
  •  HP/UX 
...
  •  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 
...
  •  to 
...
  •  determine 
...
  •  what 
...
  •  is 
...
  •  already 
...
  •  available.¬†
...
  • Microsoft 
...
  •  Windows: 
...
  •  (see 
...
  •  full 
...
  •  Windows 
...
  •  Instructions 
...
  •  for 
...
  •  full 
...
  •  set 
...
  •  of 
...
  •  prerequisites)
...
Oracle 
...
 Java 
...
 JDK 
...
 6 
...
 or 
...
 later 
...
 (standard 
...
 SDK 
...
 is 
...
 fine, 
...
 you 
...
 don't 
...
 need 
...
 J2EE)
...
DSpace 
...
 now 
...
 requires 
...
Oracle
...
 Java 
...
 6 
...
 or 
...
 greater 
...
 because 
...
 of 
...
 usage 
...
 of 
...
 new 
...
 language 
...
 capabilities 
...
 introduced 
...
 in 
...
 5 
...
 and 
...
 6 
...
 that 
...
 make 
...
 coding 
...
 easier 
...
 and 
...
 cleaner.
...
Java 
...
 can 
...
 be 
...
 downloaded 
...
 from 
...
 the 
...
 following 
...
 location: 
...
http://java.sun.com/javase/downloads/index.jsp
...
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.0.8 
...
 or 
...
 later 
...
 (Java 
...
 build 
...
 tool)
...
 Wiki Markup
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 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
...
Configuring a Proxy
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:

{
 Code Block
}<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> {code}


h3. Apache Ant 
Apache Ant 1.7 
...
 or 
...
 later 
...
 (Java 
...
 build 
...
 tool)
...
 Wiki Markup
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.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
...
Relational Database: (PostgreSQL or Oracle).
...
  • . It is highly recommended that you try to work with Postgres 8.4 or greater, however, 8.1 or greater should still work. Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+. 
...
  •  Once 
...
  •  installed, 
...
  •  you 
...
  •  need 
...
  •  to 
...
  •  enable 
...
  •  TCP/IP 
...
  •  connections 
...
  •  (DSpace 
...
  •  uses 
...
  •  JDBC). 
...
  •  In 
...
  • postgresql.conf
...
  • : 
...
  •  uncomment 
...
  •  the 
...
  •  line 
...
  •  starting: 
...
  • listen_addresses 
...
  •  = 
...
  •  'localhost'
...
  • . 
...
  •  Then 
...
  •  tighten 
...
  •  up 
...
  •  security 
...
  •  a 
...
  •  bit 
...
  •  by 
...
  •  editing 
...
  • pg_hba.conf
...
  •  and 
...
  •  adding 
...
  •  this 
...
  •  line: 
...
  • host 
...
  •  dspace 
...
  •  dspace 
...
  •  127.0.0.1 
...
  •  255.255.255.255 
...
  •  md5
...
  • . 
...
  •  Then 
...
  •  restart 
...
  •  PostgreSQL.
...
  • Oracle 
...
  •  10g 
...
  •  or 
...
  •  greater
...
  •  Details 
...
  •  on 
...
  •  acquiring 
...
  •  Oracle 
...
  •  can 
...
  •  be 
...
  •  downloaded 
...
  •  from 
...
  •  the 
...
  •  following 
...
  •  location: 
...
...
  • . 
...
  •  You 
...
  •  will 
...
  •  need 
...
  •  to 
...
  •  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 
...
  •  suggested 
...
  •  that 
...
  •  the 
...
  •  Oracle 
...
  •  database 
...
  •  use 
...
  •  the 
...
  •  same 
...
  •  character 
...
  •  set. 
...
  •  You 
...
  •  will 
...
  •  also 
...
  •  need 
...
  •  to 
...
  •  create 
...
  •  a 
...
  •  user 
...
  •  account 
...
  •  for 
...
  •  DSpace 
...
  •  (e.g. 
...
  • dspace
...
  • ) 
...
  •  and 
...
  •  ensure 
...
  •  that 
...
  •  it 
...
  •  has 
...
  •  permissions 
...
  •  to 
...
  •  add 
...
  •  and 
...
  •  remove 
...
  •  tables 
...
  •  in 
...
  •  the 
...
  •  database. 
...
  •  Refer 
...
  •  to 
...
  •  the 
...
  •  Quick 
...
  •  Installation 
...
  •  for 
...
  •  more 
...
  •  details. 
...
    • NOTE:
...
    •  DSpace 
...
    •  uses 
...
    •  sequences 
...
    •  to 
...
    •  generate 
...
    •  unique 
...
    •  object 
...
    •  IDs 
...
    • — beware 
...
    •  Oracle 
...
    •  sequences, 
...
    •  which 
...
    •  are 
...
    •  said 
...
    •  to 
...
    •  lose 
...
    •  their 
...
    •  values 
...
    •  when 
...
    •  doing 
...
    •  a 
...
    •  database 
...
    •  export/import, 
...
    •  say 
...
    •  restoring 
...
    •  from 
...
    •  a 
...
    •  backup. 
...
    •  Be 
...
    •  sure 
...
    •  to 
...
    •  run 
...
    •  the 
...
    •  script 
...
    • etc/update-sequences.sql
...
    • .
...
    • For 
...
    •  people 
...
    •  interested 
...
    •  in 
...
    •  switching 
...
    •  from 
...
    •  Postgres 
...
    •  to 
...
    •  Oracle, 
...
    •  I 
...
    •  know 
...
    •  of 
...
    •  no 
...
    •  tools 
...
    •  that 
...
    •  would 
...
    •  do 
...
    •  this 
...
    •  automatically. 
...
    •  You 
...
    •  will 
...
    •  need 
...
    •  to 
...
    •  recreate 
...
    •  the 
...
    •  community, 
...
    •  collection, 
...
    •  and 
...
    •  eperson 
...
    •  structure 
...
    •  in 
...
    •  the 
...
    •  Oracle 
...
    •  system, 
...
    •  and 
...
    •  then 
...
    •  use 
...
    •  the 
...
    •  item 
...
    •  export 
...
    •  and 
...
    •  import 
...
    •  tools 
...
    •  to 
...
    •  move 
...
    •  your 
...
    •  content 
...
    •  over.
...
Servlet 
...
 Engine: 
...
 (Apache 
...
 Tomcat 
...
 5.5 
...
 or 
...
 6, 
...
 Jetty, 
...
 Caucho 
...
 Resin 
...
 or 
...
 equivalent).
...
  • Apache 
...
  •  Tomcat 
...
  •  5.5 
...
  •  or 
...
  •  later.
...
  •  Tomcat 
...
  •  can 
...
  •  be 
...
  •  downloaded 
...
  •  from 
...
  •  the 
...
  •  following 
...
  •  location: 
...
...
  • . 
    • 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 
...
  •  (
...
...
  • ) 
...
  •  or 
...
  •  Caucho 
...
  •  Resin 
...
  •  (
...
...
  • . 
...
  •  Jetty 
...
  •  and 
...
  •  Resin 
...
  •  are 
...
  •  configured 
...
  •  for 
...
  •  correct 
...
  •  handling 
...
  •  of 
...
  •  UTF-8 
...
  •  by 
...
  •  default.
...
 Wiki Markup
Perl (required for \[dspace\]/bin/dspace-info.pl)
...
Installation Options
Overview of Install Options
With the advent of a new Apache Maven 2 based build architecture in DSpace 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.
...
  • 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: 
...
      •  Wiki Markup
        _\[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
Overview of DSpace Directories
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:
  1.  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.
...
  2.  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.
...
  2.  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.
  1. 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
...
  2. Download the latest DSpace release There are two version available with each release of DSpace: (dspace-1.x-release.
...
  1.  and 
...
  1. dspace-1.x-src-release.xxx
...
  1. ); 
...
  1.  you 
...
  1.  only 
...
  1.  need 
...
  1.  to 
...
  1.  choose 
...
  1.  one. 
...
  1.  If 
...
  1.  you 
...
  1.  want 
...
  1.  a 
...
  1.  copy 
...
  1.  of 
...
  1.  all 
...
  1.  underlying 
...
  1.  Java 
...
  1.  source 
...
  1.  code, 
...
  1.  you 
...
  1.  should 
...
  1.  download 
...
  1.  the 
...
  1. dspace-1.x-src-release.xxx
...
  1.  Within 
...
  1.  each 
...
  1.  version, 
...
  1.  you 
...
  1.  have 
...
  1.  a 
...
  1.  choice 
...
  1.  of 
...
  1.  compressed 
...
  1.  file 
...
  1.  format. 
...
  1.  Choose 
...
  1.  the 
...
  1.  one 
...
  1.  that 
...
  1.  best 
...
  1.  fits 
...
  1.  your 
...
  1.  environment.
...
  2. Unpack 
...
  1.  the 
...
  1.  DSpace 
...
  1.  software
...
  1. . 
...
  1.  After 
...
  1.  downloading 
...
  1.  the 
...
  1.  software, 
...
  1.  based 
...
  1.  on 
...
  1.  the 
...
  1.  compression 
...
  1.  file 
...
  1.  format, 
...
  1.  choose 
...
  1.  one 
...
  1.  of 
...
  1.  the 
...
  1.  following 
...
  1.  methods 
...
  1.  to 
...
  1.  unpack 
...
  1.  your 
...
  1.  software: 
...
    1. Zip 
...
    1.  file
...
    1. . 
...
    1.  If 
...
    1.  you 
...
    1.  downloaded 
...
    1. dspace-1.6-release.zip
...
    1.  do 
...
    1.  the 
...
    1.  following: 
...
    1.  Code Block
...
    1. unzip dspace-1.7-release.zip
...
    2. .gz 
...
    1.  file
...
    1. . 
...
    1.  If 
...
    1.  you 
...
    1.  downloaded 
...
    1. dspace-1.6-release.tar.gz
...
    1.  do 
...
    1.  the 
...
    1.  following: 
...
    1.  Code Block
...
    1. gunzip -c dspace-1.7-release.tar.gz | tar -xf -
...
    2. .bz2 
...
    1.  file
...
    1. . 
...
    1.  If 
...
    1.  you 
...
    1.  downloaded 
...
    1.  _dspace-1.6-release.tar.bz2_do 
...
    1.  the 
...
    1.  following: 
...
    1.  Code Block
...
    1. bunzip2 dspace-1.7-release.tar.bz | tar -xf 
...
    1. -
       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).
...
  2. Database 
...
  1. Setup
    PostgreSQL:
...
    1. A 
...
    1.  PostgreSQL 
...
    1.  8.1-404 
...
    1.  jdbc3 
...
    1.  driver 
...
    1.  is 
...
    1.  configured 
...
    1.  as 
...
    1.  part 
...
    1.  of 
...
    1.  the 
...
    1.  default 
...
    1.  DSpace 
...
    1.  build. 
...
    1.  You 
...
    1.  no 
...
    1.  longer 
...
    1.  need 
...
    1.  to 
...
    1.  copy 
...
    1.  any 
...
    1.  PostgreSQL 
...
    1.  jars 
...
    1.  to 
...
    1.  get 
...
    1.  PostgreSQL 
...
    1.  installed.
...
    2. Create 
...
    1.  a 
...
    1. dspace
...
    1.  database, 
...
    1.  owned 
...
    1.  by 
...
    1.  the 
...
    1. dspace
...
    1.  PostgreSQL 
...
    1.  user 
...
    1. (you 
...
    1.  are 
...
    1.  still 
...
    1.  logged 
...
    1.  in 
...
    1.  at 
...
    1.  'root')
...
    1. : 
...
    1.  Code Block
...
    1. createuser -U postgres -d -A -P dspace ; createdb -U dspace -E UNICODE dspace
...
    1.  You 
...
    1.  will 
...
    1.  be 
...
    1.  prompted 
...
    1.  for 
...
    1.  a 
...
    1.  password 
...
    1.  for 
...
    1.  the 
...
    1.  DSpace 
...
    1.  database. 
...
    1.  (This 
...
    1.  isn't 
...
    1.  the 
...
    1.  same 
...
    1.  as 
...
    1.  the 
...
    1. dspace
...
    1.  user's 
...
    1.  UNIX 
...
    1.  password.) 
...

    1.  Oracle:
    2. 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/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html
...
    1. $ 
...
    1.  mvn 
...
    1.  install:install-file 
...
    1.  -Dfile=ojdbc14.jar 
...
    1.  -DgroupId=com.oracle 
...
    1.  \ 
...
    1.  -DartifactId=ojdbc14 
...
    1.  -Dversion=10.2.0.2.0 
...
    1.  -Dpackaging=jar 
...
    1.  -DgeneratePom=true
...
    2. Create 
...
    1.  a 
...
    1.  database 
...
    1.  for 
...
    1.  DSpace. 
...
    1.  Make 
...
    1.  sure 
...
    1.  that 
...
    1.  the 
...
    1.  character 
...
    1.  set 
...
    1.  is 
...
    1.  one 
...
    1.  of 
...
    1.  the 
...
    1.  Unicode 
...
    1.  character 
...
    1.  sets. 
...
    1.  DSpace 
...
    1.  uses 
...
    1.  UTF-8 
...
    1.  natively, 
...
    1.  and 
...
    1.  it 
...
    1.  is 
...
    1.  suggested 
...
    1.  that 
...
    1.  the 
...
    1.  Oracle 
...
    1.  database 
...
    1.  use 
...
    1.  the 
...
    1.  same 
...
    1.  character 
...
    1.  set. 
...
    1.  Create 
...
    1.  a 
...
    1.  user 
...
    1.  account 
...
    1.  for 
...
    1.  DSpace 
...
    1.  (e.g. 
...
    1. dspace
...
    1. ,) 
...
    1.  and 
...
    1.  ensure 
...
    1.  that 
...
    1.  it 
...
    1.  has 
...
    1.  permissions 
...
    1.  to 
...
    1.  add 
...
    1.  and 
...
    1.  remove 
...
    1.  tables 
...
    1.  in 
...
    1.  the 
...
    1.  database.
...
    2.  Wiki Markup
      Edit the _\[dspace-source\]/dspace/config/dspace.cfg_ database settings:
...
    1.  Code Block
...
    1. 
db.name   = oracle
db.url    = jdbc:oracle:thin:@//host:port/dspace
db.driver = oracle.jdbc.OracleDriver
							
...
  2.  Wiki Markup
    *Initial Configuration*Edit_\[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) \*NOTE:* 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:
...
  1.  Code Block
...
  1.      feedback.recipient = ${mail.admin}
...
  1.  Refer 
...
  1.  to 
...
  1. 5.2. 
...
  1.  General 
...
  1.  Configuration
...
  1.  for 
...
  1.  details 
...
  1.  and 
...
  1.  examples 
...
  1.  of 
...
  1.  the 
...
  1.  above.
...
  2.  Wiki Markup
    \*DSpace Directory*Create the directory for the DSpace installation (i.e. _\[dspace\]_). As _root_ (or a user with appropriate permissions), run: 
...
  1.  Code Block
...
  1. mkdir [dspace]
chown dspace [dspace]
...
  1.  (Assuming 
...
  1.  the 
...
  1. dspace
...
  1.  UNIX 
...
  1.  username.)
...
  2.  Wiki Markup
    \*Installation Package*As the _dspace_ UNIX user, generate the DSpace installation package in the _\[dspace-source\]/dspace_ directory:
...
  1.  Code Block
...
  1. cd [dspace-source]/dspace/
mvn package
...
  1.  Note: 
...
  1.  without 
...
  1.  any 
...
  1.  extra 
...
  1.  arguments, 
...
  1.  the 
...
  1.  DSpace 
...
  1.  installation 
...
  1.  package 
...
  1.  is 
...
  1.  initialized 
...
  1.  for 
...
  1.  PostgreSQL. 
...
  1. If 
...
  1.  you 
...
  1.  want 
...
  1.  to 
...
  1.  use 
...
  1.  Oracle 
...
  1.  instead, 
...
  1.  you 
...
  1.  should 
...
  1.  build 
...
  1.  the 
...
  1.  DSpace 
...
  1.  installation 
...
  1.  package 
...
  1.  as 
...
  1.  follows:
...
  1.  Code Block
...
  1. mvn -Ddb.name=oracle package
...
  2.  Wiki Markup
    \*Build DSpace and Initialize Database*As the _dspace_ UNIX user, initialize the DSpace database and install DSpace to _\[dspace\]_:
...
  1.  Code Block
...
  1. cd [dspace-source]/dspace/target/dspace-[version]-build.dir

ant fresh_install
...
  1.  To 
...
  1.  see 
...
  1.  a 
...
  1.  complete 
...
  1.  list 
...
  1.  of 
...
  1.  build 
...
  1.  targets, 
...
  1.  run:
...
  1.  ant 
...
  1.  help
...
  1. The 
...
  1.  most 
...
  1.  likely 
...
  1.  thing 
...
  1.  to 
...
  1.  go 
...
  1.  wrong 
...
  1.  here 
...
  1.  is 
...
  1.  the 
...
  1.  database 
...
  1.  connection. 
...
  1.  See 
...
  1.  the 
...
  1.  _3.7 
...
  1.  Common 
...
  1.  Problems 
...
  1.  Section
...
  1. .
...
  2. Deploy 
...
  1.  Web 
...
  1.  Applications.
...

  1.  You 
...
  1.  have 
...
  1.  two 
...
  1.  choices 
...
  1.  or 
...
  1.  techniques 
...
  1.  for 
...
  1.  having 
...
  1.  Tomcat/Jetty/Resin 
...
  1.  serve 
...
  1.  up 
...
  1.  your 
...
  1.  web 
...
  1.  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:
...
  •  Wiki Markup
    {{{*}cp \-R \[dspace\]/webapps/\* \[tomcat\]/webapps{*}}} (This will copy all the web applications to Tomcat).&nbsp;
...
  •  Wiki Markup
    {{{*}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"
	....{code}
# \*Administrator Account &nbsp;*Create an initial administrator account:{code}
  1. *Administrator Account  *Create an initial administrator account: 
     Code Block
    [dspace]/bin/dspace create-administrator
...
  2. Initial Startup!  Now the moment of truth! Start up (or restart) Tomcat/Jetty/Resin. 
...
  1.  Visit 
...
  1.  the 
...
  1.  base 
...
  1.  URL(s) 
...
  1.  of 
...
  1.  your 
...
  1.  server, 
...
  1.  depending 
...
  1.  on 
...
  1.  which 
...
  1.  DSpace 
...
  1.  web 
...
  1.  applications 
...
  1.  you 
...
  1.  want 
...
  1.  to 
...
  1.  use. 
...
  1.  You 
...
  1.  should 
...
  1.  see 
...
  1.  the 
...
  1.  DSpace 
...
  1.  home 
...
  1.  page. 
...
  1.  Congratulations
...
  1. ! 
...
  1.  Base 
...
  1.  URLs 
...
  1.  of 
...
  1.  DSpace 
...
  1.  Web 
...
  1.  Applications: 
...
    • JSP 
...
    •  User 
...
    •  Interface
...
    • - 
...
    •  (e.g.)
...
...
    • XML User Interface (aka. 
...
    •  Manakin)
...
    • - 
...
    •  (e.g.)
...
...
    • OAI-PMH 
...
    •  Interface
...
    • - 
...
    •  (e.g.)
...
...
    • (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.
Advanced Installation
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.
'cron' Jobs
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:
 Code Block
crontab -e
Then add the following lines:
 Code Block




h2. Advanced Installation

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.

h3. 'cron' Jobs

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:
{code}crontab -e{code}
Then add the following lines:
{code}# 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
{code}

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

{
 Code Block
}# Clean up the database nightly at 4.20am
20 4 * * * vacuumdb --analyze dspace > /dev/null 2>&1{code}

In 
...
 order 
...
 that 
...
 statistical 
...
 reports 
...
 are 
...
 generated 
...
 regularly 
...
 and 
...
 thus 
...
 kept 
...
 up 
...
 to 
...
 date 
...
 you 
...
 should 
...
 set 
...
 up 
...
 the 
...
 following 
...
 cron 
...
 jobs:

{
 Code Block
}# 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{code}

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.
...
Multilingual Installation
 Wiki Markup
In 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.
...
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.
...
DSpace over HTTPS
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.
...
To 
...
 enable 
...
 the 
...
 HTTPS 
...
 support 
...
 in 
...
 Tomcat 
...
 5.0:
...
  1. For 
...
  1.  Production 
...
  1.  use:
...
  1.  Follow 
...
  1.  this 
...
  1.  procedure 
...
  1.  to 
...
  1.  set 
...
  1.  up 
...
  1.  SSL 
...
  1.  on 
...
  1.  your 
...
  1.  server. 
...
  1.  Using 
...
  1.  a 
...
  1.  "real" 
...
  1.  server 
...
  1.  certificate 
...
  1.  ensures 
...
  1.  your 
...
  1.  users' 
...
  1.  browsers 
...
  1.  will 
...
  1.  accept 
...
  1.  it 
...
  1.  without 
...
  1.  complaints. 
...
  1.  In 
...
  1.  the 
...
  1.  examples 
...
  1.  below, 
...
  1. $CATALINA_BASE
...
  1.  is 
...
  1.  the 
...
  1.  directory 
...
  1.  under 
...
  1.  which 
...
  1.  your 
...
  1.  Tomcat 
...
  1.  is 
...
  1.  installed. 
...
    1. Create 
...
    1.  a 
...
    1.  Java 
...
    1.  keystore 
...
    1.  for 
...
    1.  your 
...
    1.  server 
...
    1.  with 
...
    1.  the 
...
    1.  password 
...
    1. changeit
...
    1. , 
...
    1.  and 
...
    1.  install 
...
    1.  your 
...
    1.  server 
...
    1.  certificate 
...
    1.  under 
...
    1.  the 
...
    1.  alias 
...
    1. "tomcat"
...
    1. . 
...
    1.  This 
...
    1.  assumes 
...
    1.  the 
...
    1.  certificate 
...
    1.  was 
...
    1.  put 
...
    1.  in 
...
    1.  the 
...
    1.  file 
...
    1. server.pem
...
    1. : 
...
    1.  Code Block
...
    1. $JAVA_HOME/bin/keytool -import -noprompt -v -storepass changeit
	-keystore $CATALINA_BASE/conf/keystore -alias tomcat -file
	myserver.pem
...
    2. Install the CA (Certifying 
...
    1.  Authority) 
...
    1.  certificate 
...
    1.  for 
...
    1.  the 
...
    1.  CA 
...
    1.  that 
...
    1.  granted 
...
    1.  your 
...
    1.  server 
...
    1.  cert, 
...
    1.  if 
...
    1.  necessary. 
...
    1.  This 
...
    1.  assumes 
...
    1.  the 
...
    1.  server 
...
    1.  CA 
...
    1.  certificate 
...
    1.  is 
...
    1.  in 
...
    1. ca.pem
...
    1. : 
...
    1.  Code Block
...
    1.  $JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA
	-file ca.pem

...
    2. 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: 
       Code Block
      $JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore  -alias client1
	-file client1.pem

...
    2. Now add another Connector tag to your server.xml
...
    1.  Tomcat 
...
    1.  configuration 
...
    1.  file, 
...
    1.  like 
...
    1.  the 
...
    1.  example 
...
    1.  below. 
...
    1.  The 
...
    1.  parts 
...
    1.  affecting 
...
    1.  or 
...
    1.  specific 
...
    1.  to 
...
    1.  SSL 
...
    1.  are 
...
    1.  shown 
...
    1.  in 
...
    1.  bold. 
...
    1.  (You 
...
    1.  may 
...
    1.  wish 
...
    1.  to 
...
    1.  change 
...
    1.  some 
...
    1.  details 
...
    1.  such 
...
    1.  as 
...
    1.  the 
...
    1.  port, 
...
    1.  pathnames, 
...
    1.  and 
...
    1.  keystore 
...
    1.  password) 
...
    1.  Code Block
...
    1.      <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" />

...
    1.  Also, 
...
    1.  check 
...
    1.  that 
...
    1.  the 
...
    1.  default 
...
    1.  Connector 
...
    1.  is 
...
    1.  set 
...
    1.  up 
...
    1.  to 
...
    1.  redirect 
...
    1.  "secure" 
...
    1.  requests 
...
    1.  to 
...
    1.  the 
...
    1.  same 
...
    1.  port 
...
    1.  as 
...
    1.  your 
...
    1.  SSL 
...
    1.  connector, 
...
    1.  e.g.: 
...
    1.    
...
    1.  Code Block
...
    1. <Connector port="8080"
                 maxThreads="150" minSpareThreads="25"
	             maxSpareThreads="75"
                 enableLookups="false"
	             redirectPort="8443"
                 acceptCount="100" debug="0"  	/>

...
  2. Quick-and-dirty 
...
  1.  Procedure 
...
  1.  for 
...
  1.  Testing:
...
  1.  If 
...
  1.  you 
...
  1.  are 
...
  1.  just 
...
  1.  setting 
...
  1.  up 
...
  1.  a 
...
  1.  DSpace 
...
  1.  server 
...
  1.  for 
...
  1.  testing, 
...
  1.  or 
...
  1.  to 
...
  1.  experiment 
...
  1.  with 
...
  1.  HTTPS, 
...
  1.  then 
...
  1.  you 
...
  1.  don't 
...
  1.  need 
...
  1.  to 
...
  1.  get 
...
  1.  a 
...
  1.  real 
...
  1.  server 
...
  1.  certificate. 
...
  1.  You 
...
  1.  can 
...
  1.  create 
...
  1.  a 
...
  1.  "self-signed" 
...
  1.  certificate 
...
  1.  for 
...
  1.  testing; 
...
  1.  web 
...
  1.  browsers 
...
  1.  will 
...
  1.  issue 
...
  1.  warnings 
...
  1.  before 
...
  1.  accepting 
...
  1.  it 
...
  1.  but 
...
  1.  they 
...
  1.  will 
...
  1.  function 
...
  1.  exactly 
...
  1.  the 
...
  1.  same 
...
  1.  after 
...
  1.  that 
...
  1.  as 
...
  1.  with 
...
  1.  a 
...
  1.  "real" 
...
  1.  certificate. 
...
  1.   In 
...
  1.  the 
...
  1.  examples 
...
  1.  below, 
...
  1. $CATALINA_BASE
...
  1.  is 
...
  1.  the 
...
  1.  directory 
...
  1.  under 
...
  1.  which 
...
  1.  your 
...
  1.  Tomcat 
...
  1.  is 
...
  1.  installed. 
...
    1. Optional – ONLY if you don't 
...
    1.  already 
...
    1.  have 
...
    1.  a 
...
    1.  server 
...
    1.  certificate. 
...
    1.  Follow 
...
    1.  this 
...
    1.  sub-procedure 
...
    1.  to 
...
    1.  request 
...
    1.  a 
...
    1.  new, 
...
    1.  signed 
...
    1.  server 
...
    1.  certificate 
...
    1.  from 
...
    1.  your 
...
    1.  Certifying 
...
    1.  Authority 
...
    1.  (CA):  
...
      • 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: 
...
      •  Code Block
...
      • 
$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
...
      •  Code Block
        
 $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
...
      • ): 
...
      •  Code Block
...
      • 
 $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
...
      • ) 
...
      •  Code Block
...
      • 
 $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.¬†
...
    2. Create 
...
    1.  a 
...
    1.  Java 
...
    1.  keystore 
...
    1.  for 
...
    1.  your 
...
    1.  server 
...
    1.  with 
...
    1.  the 
...
    1.  password 
...
    1. changeit
...
    1. , 
...
    1.  and 
...
    1.  install 
...
    1.  your 
...
    1.  server 
...
    1.  certificate 
...
    1.  under 
...
    1.  the 
...
    1.  alias 
...
    1. "tomcat"
...
    1. . 
...
    1.  This 
...
    1.  assumes 
...
    1.  the 
...
    1.  certificate 
...
    1.  was 
...
    1.  put 
...
    1.  in 
...
    1.  the 
...
    1.  file 
...
    1. server.pem
...
    1. : 
...
    1.  Code Block
...
    1. 
 $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore
	$CATALINA_BASE/conf/keystore -storepass changeit

...
    1.  When 
...
    1.  answering 
...
    1.  the 
...
    1.  questions 
...
    1.  to 
...
    1.  identify 
...
    1.  the 
...
    1.  certificate, 
...
    1.  be 
...
    1.  sure 
...
    1.  to 
...
    1.  respond 
...
    1.  to 
...
    1.  "First 
...
    1.  and 
...
    1.  last 
...
    1.  name" 
...
    1.  with 
...
    1.  the 
...
    1.  fully-qualified 
...
    1.  domain 
...
    1.  name 
...
    1.  of 
...
    1.  your 
...
    1.  server 
...
    1.  (e.g. 
...
    1. test-dspace.myuni.edu
...
    1. ). 
...
    1.  The 
...
    1.  other 
...
    1.  questions 
...
    1.  are 
...
    1.  not 
...
    1.  important.
...
    2. Optional – ONLY if you need to accept client certificates for the X.509 
...
    1.  certificate 
...
    1.  stackable 
...
    1.  authentication 
...
    1.  module 
...
    1.  See 
...
    1.  the 
...
    1.  configuration 
...
    1.  section 
...
    1.  for 
...
    1.  instructions 
...
    1.  on 
...
    1.  enabling 
...
    1.  the 
...
    1.  X.509 
...
    1.  authentication 
...
    1.  method. 
...
    1.  Load 
...
    1.  the 
...
    1.  keystore 
...
    1.  with 
...
    1.  the 
...
    1.  CA 
...
    1.  (certifying 
...
    1.  authority) 
...
    1.  certificates 
...
    1.  for 
...
    1.  the 
...
    1.  authorities 
...
    1.  of 
...
    1.  any 
...
    1.  clients 
...
    1.  whose 
...
    1.  certificates 
...
    1.  you 
...
    1.  wish 
...
    1.  to 
...
    1.  accept. 
...
    1.  For 
...
    1.  example, 
...
    1.  assuming 
...
    1.  the 
...
    1.  client 
...
    1.  CA 
...
    1.  certificate 
...
    1.  is 
...
    1.  in 
...
    1. client1.pem
...
    1. : 
...
    1.  Code Block
...
    1. 
 $JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
	-trustcacerts -keystore $CATALINA_BASE/conf/keystore  -alias client1
	-file client1.pem

    2. Follow the procedure in the section above to add another Connector tag, for the HTTPS port, to your server.xml file.
To use SSL on Apache HTTPD with mod_jk:
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:
 Code Block
{code}
## Follow the procedure in the section above to add another Connector tag, for the HTTPS port, to your _server.xml_ file.

h4. To use SSL on Apache HTTPD with mod_jk:

If you choose [Apache HTTPD|http://httpd.apache.org/|Apache HTTPD] as your primary HTTP server, you can have it forward requests to the [Tomcat servlet container|http://tomcat.apache.org/|Tomcat servlet container] via [Apache Jakarta Tomcat Connector|http://tomcat.apache.org/connectors-doc/|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|http://httpd.apache.org/docs/2.0/ssl/|Apache SSL/TLS Encryption] for information about using [mod_ssl|http://httpd.apache.org/docs/2.0/mod/mod_ssl.html|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:
{code}
        ##  SSLVerifyClient can be "optional" or
	"require"
        SSLVerifyClient optional
        SSLVerifyDepth  10
        SSLCACertificateFile
	path-to-your-client-CA-certificate
        SSLOptions StdEnvVars ExportCertData

{code}

Now 
...
 consult 
...
 the 
...
Apache 
...
 Jakarta 
...
 Tomcat 
...
 Connector
...
 documentation 
...
 to 
...
 configure 
...
 the 
...
mod_jk
...
 (note: 
...
NOT
...
mod_jk2
...
) 
...
 module. 
...
 Select 
...
 the 
...
 AJP 
...
 1.3 
...
 connector 
...
 protocol. 
...
 Also 
...
 follow 
...
 the 
...
 instructions 
...
 there 
...
 to 
...
 configure 
...
 your 
...
 Tomcat 
...
 server 
...
 to 
...
 respond 
...
 to 
...
 AJP.
...
To 
...
 use 
...
 SSL 
...
 on 
...
 Apache 
...
 HTTPD 
...
 with 
...
 mod_webapp
...
 consult 
...
 the 
...
 DSpace 
...
 1.3.2 
...
 documentation. 
...
 Apache 
...
 have 
...
 deprecated 
...
 the 
...
mod_webapp
...
 connector 
...
 and 
...
 recommend 
...
 using 
...
mod_jk
...
.
...
To 
...
 use 
...
 Jetty's 
...
 HTTPS 
...
 support
...
 consult 
...
 the 
...
 documentation 
...
 for 
...
 the 
...
 relevant 
...
 tool.
...
The Handle Server
First a few facts to clear up some common misconceptions:
  • You don't have to use CNRI's Handle system. At the moment, you need to change the code a little to use something else (e.g PURLs) but that should change soon.
  • You'll notice that while you've been playing around with a test server, DSpace has apparently been creating handles for you looking like hdl:123456789/24 and so forth. These aren't really Handles, since the global Handle system doesn't actually know about them, and lots of other DSpace test installs will have created the same IDs.They're only really Handles once you've registered a prefix with CNRI (see below) and have correctly set up the Handle server included in the DSpace distribution. This Handle server communicates with the rest of the global Handle infrastructure so that anyone that understands Handles can find the Handles your DSpace has created.¬†
     If you want to use the Handle system, you'll need to set up a Handle server. This is included with DSpace. Note that this is not required in order to evaluate DSpace; you only need one if you are running a production service. You'll need to obtain a Handle prefix from the central CNRI Handle site.
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.
  1.  Wiki Markup
    To configure your DSpace installation to run the handle server, run the following command: _\[dspace\]/bin/dspace make-handle-config_Ensure that \_\[dspace\]/handle-server_ matches whatever you have in _dspace.cfg_ for the _handle.dir_ property.
...
  2.  Wiki Markup
    Edit the resulting _\[dspace\]/handle-server/config.dct_ file to include the following lines in the _"server_config"_ clause: 
...
  1.  Code Block
...
  1. "storage_type" = "CUSTOM"
"storage_class" = "org.dspace.handle.HandlePlugin"

...
  1.  This 
...
  1.  tells 
...
  1.  the 
...
  1.  Handle 
...
  1.  server 
...
  1.  to 
...
  1.  get 
...
  1.  information 
...
  1.  about 
...
  1.  individual 
...
  1.  Handles 
...
  1.  from 
...
  1.  the 
...
  1.  DSpace 
...
  1.  code. 
...
  2. Once 
...
  1.  the 
...
  1.  configuration 
...
  1.  file 
...
  1.  has 
...
  1.  been 
...
  1.  generated, 
...
  1.  you 
...
  1.  will 
...
  1.  need 
...
  1.  to 
...
  1.  go 
...
  1.  to 
...
  1. http://hdl.handle.net/4263537/5014
...
  1.  to 
...
  1.  upload 
...
  1.  the 
...
  1.  generated 
...
  1.  sitebndl.zip 
...
  1.  file. 
...
  1.  The 
...
  1.  upload 
...
  1.  page 
...
  1.  will 
...
  1.  ask 
...
  1.  you 
...
  1.  for 
...
  1.  your 
...
  1.  contact 
...
  1.  information. 
...
  1.  An 
...
  1.  administrator 
...
  1.  will 
...
  1.  then 
...
  1.  create 
...
  1.  the 
...
  1.  naming 
...
  1.  authority/prefix 
...
  1.  on 
...
  1.  the 
...
  1.  root 
...
  1.  service 
...
  1.  (known 
...
  1.  as 
...
  1.  the 
...
  1.  Global 
...
  1.  Handle 
...
  1.  Registry), 
...
  1.  and 
...
  1.  notify 
...
  1.  you 
...
  1.  when 
...
  1.  this 
...
  1.  has 
...
  1.  been 
...
  1.  completed. 
...
  1.  You 
...
  1.  will 
...
  1.  not 
...
  1.  be 
...
  1.  able 
...
  1.  to 
...
  1.  continue 
...
  1.  the 
...
  1.  handle 
...
  1.  server 
...
  1.  installation 
...
  1.  until 
...
  1.  you 
...
  1.  receive 
...
  1.  further 
...
  1.  information 
...
  1.  concerning 
...
  1.  your 
...
  1.  naming 
...
  1.  authority.
...
  2.  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.
...
  2. Now 
...
  1.  start 
...
  1.  your 
...
  1.  handle 
...
  1.  server 
...
  1.  (as 
...
  1.  the 
...
  1.  dspace 
...
  1.  user):  
...
  1.  Code Block
...
  1. [dspace]/bin/start-handle-server
...
  1.  Note 
...
  1.  that 
...
  1.  since 
...
  1.  the 
...
  1.  DSpace 
...
  1.  code 
...
  1.  manages 
...
  1.  individual 
...
  1.  Handles, 
...
  1.  administrative 
...
  1.  operations 
...
  1.  such 
...
  1.  as 
...
  1.  Handle 
...
  1.  creation 
...
  1.  and 
...
  1.  modification 
...
  1.  aren't 
...
  1.  supported 
...
  1.  by 
...
  1.  DSpace's 
...
  1.  Handle 
...
  1.  server.
...
Updating 
...
 Existing 
...
 Handle 
...
Prefixes
 Wiki Markup
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
                {code}

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.
...
Google and HTML sitemaps
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 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 Markup
To generate the sitemaps, you need to run _\[dspace\]/bin/generate-sitemaps_ This creates the sitemaps in _\[dspace\]/sitemaps/_
...
The 
...
 sitemaps 
...
 can 
...
 be 
...
 accessed 
...
 from 
...
 the 
...
 following 
...
 URLs:
...
...
  •  - 
...
  •  Index 
...
  •  sitemap¬†
...
...
  •  - 
...
  •  First 
...
  •  list 
...
  •  of 
...
  •  items 
...
  •  (up 
...
  •  to 
...
  •  50,000)¬†
...
...
  •  - 
...
  •  Subsequent 
...
  •  lists 
...
  •  of 
...
  •  items 
...
  •  (e.g. 
...
  •  50,0001 
...
  •  to 
...
  •  100,000) 
...
  •  etc...¬†
...

  •  HTML 
...
  •  sitemaps 
...
  •  follow 
...
  •  the 
...
  •  same 
...
  •  procedure:
...
...
  •  - 
...
  •  Index 
...
  •  sitemap¬†
...
  • etc...¬†
...
 Wiki Markup
When running _\[dspace\]/bin/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 Markup
The 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/generate-sitemaps

{code}

h3. DSpace Statistics

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
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 5.2.35 
...
 DSpace 
...
 Statistic 
...
 Configuration 
...
 for 
...
 detailed 
...
 information.
...
  1. DSpace 
...
  1.  Configuration 
...
  1.  for 
...
  1.  Accessing 
...
  1.  Solr.
...
  1.  In 
...
  1.  the 
...
  1. dspace.cfg
...
  1.  file 
...
  1.  review 
...
  1.  the 
...
  1.  following 
...
  1.  fields 
...
  1.  to 
...
  1.  make 
...
  1.  sure 
...
  1.  they 
...
  1.  are 
...
  1.  uncommented: 
...
  1.  Code Block
...
  1. 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
...
  2. 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 
...
  1.  header.
...
  1.   This 
...
  1.  feature 
...
  1.  can 
...
  1.  be 
...
  1.  enabled 
...
  1.  by 
...
  1.  ensuring 
...
  1.  the 
...
  1.  following 
...
  1.  setting 
...
  1.  is 
...
  1.  uncommented 
...
  1.  in 
...
  1.  the 
...
  1.  logging 
...
  1.  section 
...
  1.  of 
...
  1. dspace.cfg
...
  1. : 
...
  1.  Code Block
...
  1. useProxies = true
...
  2. 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: 
     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
...
  2. Configuration Control.
...
  1.  In 
...
  1.  the 
...
  1. dspace.cfg
...
  1.  set 
...
  1.  the 
...
  1.  following 
...
  1.  property 
...
  1.  key:_statistics.item.authorization.admin=true_This 
...
  1.  will 
...
  1.  require 
...
  1.  the 
...
  1.  user 
...
  1.  to 
...
  1.  sign 
...
  1.  on 
...
  1.  to 
...
  1.  see 
...
  1.  that 
...
  1.  statistics. 
...
  1.  Setting 
...
  1.  the 
...
  1.  statistics 
...
  1.  to 
...
  1.  "false" 
...
  1.  will 
...
  1.  make 
...
  1.  them 
...
  1.  publicly 
...
  1.  available. 
...
  2. Final 
...
  1.  steps.  
...
    • Perform 
...
    •  the 
...
    •  following 
...
    •  step:¬† 
...
    •  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

...
    •  Wiki Markup
      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:
...
...
...
...
  •  or 
...
  •  later 
...
  •  (standard 
...
  •  SDK 
...
  •  is 
...
  •  fine, 
...
  •  you 
...
  •  don't 
...
  •  need 
...
  •  J2EE)
...
...
...
...
  •  OR 
...
...
...
...
...
  • . 
    • If you install PostgreSQL, it's 
...
    •  recommended 
...
    •  to 
...
    •  select 
...
    •  to 
...
    •  install 
...
    •  the 
...
    •  pgAdmin 
...
    •  III 
...
    •  tool
...
...
...
...
...
...
  • . 
...
  •  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
...
...
...
Installation Steps
  1. Download the DSpace source from SourceForge and untar it (WinZip will do this)
  2. 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
  3.  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_Make sure you change all of the parameters with file paths to suit, specifically: 
...
  1.  Code Block
...
  1. 
        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

...
  2. Create the directory for the DSpace installation (e.g. 
...
  1. C:\DSpace
...
  1. )
  2.  Wiki Markup
    Generate the DSpace installation package by running the following from command line (cmd) from your _\[dspace-source\]/dspace/_ directory: 
...
  1.  Code Block
...
  1. 
mvn package

...
  1.  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: 
...
  1.  Code Block
...
  1. 
mvn -Ddb.name=oracle package

...
  2.  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:
...
  1.  Code Block
...
  1. 
ant fresh_install

...
  1. Note:
...
  1.  to 
...
  1.  see 
...
  1.  a 
...
  1.  complete 
...
  1.  list 
...
  1.  of 
...
  1.  build 
...
  1.  targets, 
...
  1.  run 
...
  1.  Code Block
...
  1. 
ant help

...
  2.  Wiki Markup
    Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory_\[dspace\]\bin\dspace create-administrator_and enter the required information 
...
  2.  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 5.5\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"/>

...
  2. Start the Tomcat service
  3. Browse to either http://localhost:8080/jspui
...
  1.  or 
...
  1. http://localhost:8080/xmlui
...
  1. . 
...
  1.  You 
...
  1.  should 
...
  1.  see 
...
  1.  the 
...
  1.  DSpace 
...
  1.  home 
...
  1.  page 
...
  1.  for 
...
  1.  either 
...
  1.  the 
...
  1.  JSPUI 
...
  1.  or 
...
  1.  XMLUI, 
...
  1.  respectively.
...
Checking Your Installation
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 Markup
    System is up and running. _User can see the DSpace home page. \[Tomcat/Jetty, firewall, IP assignment, DNS\]_
...
  •  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\]/bin/dspace test-database_
...
  •  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.
...
Common Problems
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.
  • 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-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: 
...
  •  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 
...
  • kill_ing 
...
  •  them 
...
  •  (with 
...
  •  _-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: 
...
  •  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 
...
  •  _kill_ing 
...
  •  the 
...
  •  process, 
...
  •  and 
...
  •  stopping 
...
  •  and 
...
  •  restarting 
...
  •  Tomcat.