Page History

...

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.

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

...

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 JDBC driver is configured as part of the default DSpace build. You no longer need to copy any PostgreSQL jars to get PostgreSQL installed.
     • Create a dspace}}database, owned by the {{dspace PostgreSQL user (you are still logged in at 'root'):

       Code Block
       createuser -U postgres -d -A -P dspace ; createdb -U dspace -E UNICODE dspace

       You will be prompted for a password for the DSpace database. (This isn't the same as the dspace user's UNIX password.)
   • Oracle:
     • Setting up oracle is a bit different now. You will need still need to get a Copy of the oracle JDBC driver, but instead of copying it into a lib directory you will need to install it into your local Maven repository. You'll need to download it first from this location: http://www.oracle.com/technologytechnetwork/softwaredatabase/tech/java/sqlj_jdbc/htdocs/jdbc_10201enterprise-edition/jdbc-112010-090769.html

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

     • Create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is required that the Oracle database use the same character set. Create a user account for DSpace (e.g. dspace,) and ensure that it has permissions to add and remove tables in the database.

     • Wiki 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)

     Info
     You can interpolate the value of one configuration variable in the value of another one. For example, to set feedback.recipient to the same value as mail.admin, the line would look like: feedback.recipient = \${mail.admin} Refer to the General Configuration section for details and examples of the above.

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

   Info
   title Defaults to PostgreSQL settings
   Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. _If you want to use Oracle instead, you should build the DSpace installation package as follows: mvn -Ddb.name=oracle package

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 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. 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:
    • JSP User Interface - (e.g.) http://dspace.myu.edu:8080/jspui
    • XML User Interface (aka. Manakin) - (e.g.) http://dspace.myu.edu:8080/xmlui
    • OAI-PMH Interface - (e.g.) http://dspace.myu.edu:8080/oai/request?verb=Identify (Should return an XML-based response)

...

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:

   Code Block
   "storage_type" = "CUSTOM" "storage_class" = "org.dspace.handle.HandlePlugin"

   This tells the Handle server to get information about individual Handles from the DSpace code.
3. Once the configuration file has been generated, you will need to go to http://hdl.handle.net/4263537/5014 to upload the generated sitebndl.zip file. The upload page will ask you for your contact information. An administrator will then create the naming authority/prefix on the root service (known as the Global Handle Registry), and notify you when this has been completed. You will not be able to continue the handle server installation until you receive further information concerning your naming authority.

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

5. Now start your handle server (as the dspace user):

   Code Block
   [dspace]/bin/start-handle-server

   Note that since the DSpace code manages individual Handles, administrative operations such as Handle creation and modification aren't supported by DSpace's Handle server.

...