Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Major formatting fixes to basic install instructions (esp. configs listing)

...

  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. 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.
  3. Unpack the DSpace software. After downloading the software, based on the compression file format, choose one of the following methods to unpack your software:
    1. Zip file. If you downloaded dspace-1.6-release.zip do the following:
      Code Block
      unzip dspace-1.7-release.zip
    2. .gz file. If you downloaded dspace-1.6-release.tar.gz do the following:
      Code Block
      gunzip -c dspace-1.7-release.tar.gz | tar -xf -
    3. .bz2 file. If you downloaded _dspace-1.6-release.tar.bz2_do the following:
      Code Block
      bunzip2 dspace-1.7-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).
  4. Database Setup
    PostgreSQL:
    • A PostgreSQL 8.1-404 jdbc3 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/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html
      Code Block
      $ mvn install:install-file -Dfile=ojdbc14.jar -DgroupId=com.oracle -DartifactId=ojdbc14 -Dversion=10.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 suggested 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
      
  5. 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)
    \*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
    • 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:

      Code Block
    •  feedback.recipient = ${mail.admin}

      Refer to

    5.2.
  6. 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.)
  7. Wiki Markup
    *Installation Package:*
     As the _dspace_ UNIX user, generate the DSpace installation package in the {{\[dspace-source\]/dspace}} directory:
    Code Block
    cd [dspace-source]/dspace/
    mvn package
    Note: without
    Info
    titleDefaults 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:

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

    _3.7

    Common Problems Section.

  9. 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"
      	....
  10. Wiki Markup*Administrator Account* : Create an initial administrator account:
    Code Block
    
    \\
    {{\[dspace\]/bin/dspace create-administrator}}
  11. 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:

...