Page History

...

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.8-release.zipdo the following:

      Code Block
      unzip dspace-1.8-release.zip

   2. .gz file. If you downloaded dspace-1.8-release.tar.gzdo the following:

      Code Block
      gunzip -c dspace-1.8-release.tar.gz | tar -xf -

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

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

      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
   
   • Also see notes above
   • 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 user. This is entirely separate from the dspaceoperating-system user created above.

       Code Block
       createuser -U postgres -d -A -P dspace

       You will be prompted for the password of the PostgreSQL superuser (postgres). Then you'll be prompted (twice) for a password for the new dspace user.

     • Create a dspace database, owned by the dspace PostgreSQL user (you are still logged in at 'root'):

       Code Block
       createdb -U dspace -E UNICODE dspace

       You will be prompted for the password of the DSpace database user. (This isn't the same as the dspace user's UNIX password.)

   • Oracle:
     

     • Setting up DSpace to use Oracle is a bit different now. You will need still need to get a copy of the Oracle JDBC driver, but instead of copying it into a lib directory you will need to install it into your local Maven repository. (You'll need to download it first from this location: http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html.) Run the following command (all on one line):

       Code Block
       mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.3 -Dpackaging=jar -DgeneratePom=true

     • You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your Oracle version - update the version in [dspace-source]/pom.xmlE.g.:

       Code Block
       <dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.3</version> </dependency>

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

     • Edit the [dspace-source]/dspace/config/dspace.cfgdatabase settings:

       Code Block
       db.name = oracle db.driver = oracle.jdbc.OracleDriver db.url = jdbc:oracle:thin:@host:port/SID

       Where SID is the SID of your database defined in tnsnames.ora, default Oracle port is 1521.
       Alternatively, you can use a full SID definition, e.g.:

       Code Block
       db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE)))

5. Initial Configuration: Edit [dspace-source]/build.properties, in particular you'll need to set these properties, examples or defaults are provided in the file:
   
   • dspace.dir - must be set to the [dspace] (installation) directory.  (On Windows be sure to use forward slashes for the directory path!  For example: "C:/dspace/" is a valid path for Windows.)
   • dspace.hostname - fully-qualified domain name of web server.
   • dspace.baseUrl - complete URL of this server's DSpace home page but without any context eg. /xmlui, /oai, etc.
   • dspace.name - "Proper" name of your server, e.g. "My Digital Library".
   • solr.server - complete URL of the Solr server. DSpace makes use of Solr http://lucene.apache.org/solr/ for indexing purposes.  
   • default.language 
   • db.name - postgres or oracle
   • db.driver
   • db.url
   • db.username - the database password used in the previous step
   • db.password - the database password used 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.
   • mail.feedback.recipient - mailbox for feedback mail.
   • mail.admin - mailbox for DSpace site administrator.
   • mail.alert.recipient - mailbox for server errors/alerts (not essential but very useful!)

   • mail.registration.notify- mailbox for emails when new users register (optional)

     Info
     The main DSpace configuration is held in [dspace-source]/dspace/config/dspace.cfg, the build.properties file is provided as a convenient method of setting a small subset of the configuration. Refer to the General Configuration section for a fuller explanation.

6. 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. Installation Package: As the dspaceUNIX user, generate the DSpace installation package.

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

   Anchor
   deployment deployment

   Please note that in the first instance you should refer to the appropriate documentation for your Web Server of choice, the following instructions are meant as a handy guide. You have two choices or techniques for having Tomcat/Jetty/Resin serve up your web applications:
   
   
   • 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.)

   • 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" ....

     Alternatively...

     Code Block

     <!-- DEFINE A CONTEXT PATH FOR DSpace XML User Interface --> <Context path="/xmlui" docBase="[dspace]/webapps/xmlui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> <!-- 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"/> <!-- DEFINE ADDITIONAL CONTEXT PATHS FOR OTHER DSPACE WEB APPLICATIONS (SOLR, SWORD, LNI, etc.). CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context path="/[app]" docbase="[dspace]/webapps/[app]" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>

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)

...

• Download the DSpace source from SourceForge and unzip it (WinZip will do this)
• If you install PostgreSQL, it's recommended to select to install the pgAdmin III tool. It provides a nice User Interface for interacting with PostgreSQL databases.
• For all path separators use forward slashes (e.g. "/"). For example: "C:/dspace/" is a valid Windows path.  But, be warned that "C:\dspace" IS INVALID and will cause errors.

Checking Your Installation

...