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-n.x-release. and dspace-n.x-src-release.zzz); you only need to choose one. If you want a copy of all underlying Java source code, you should download the dspace-n.x-src-release.xxxWithin each version, you have a choice of compressed file format. Choose the one that best fits your environment.
   
   1. Alternatively, you may choose to check out the latest release from the DSpace GitHub Repository.  In this case, you'd be checking out the full Java source code.  You'd also want to be sure to checkout the appropriate tag or branch. For more information on using / developing from the GitHub Repository, see: Development with Git
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-4.x-release.zip do the following:

      Code Block
      unzip dspace-4.x-release.zip

   2. .gz file. If you downloaded dspace-4.x-release.tar.gz do the following:

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

   3. .bz2 file. If you downloaded _dspace-4.x-release.tar.bz do the following:

      Code Block
      bunzip2 dspace-4.x-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 wish to change the ownership of the dspace-4.x-release to the "dspace" user. (And you may need to change the group).

4. Database Setup 
   • PostgreSQL: 

     • Create a dspace database user. This is entirely separate from the dspace operating-system user created above (you are still logged in as "root"):

       Code Block
       createuser --username=postgres --no-superuser --pwprompt dspace

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

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

       Code Block
       createdb --username=postgres --owner=dspace --encoding=UNICODE dspace

       You will be prompted for the password of the PostgreSQL superuser (postgres).

   • 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.0 -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.xml  E.g.:

       Code Block
       language html/xml
       <dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.3.0</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.

     • Uncomment and edit the Oracle database settings in [dspace-source]/build.properties (see below for more information on the build.properties file):

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

     • Later, during the Maven build step, don't forget to specify mvn -Ddb.name=oracle package

5. Initial Configuration: Edit [dspace-source]/build.properties.  This properties file contains the basic settings necessary to actually build/install DSpace for the first time (see build.properties Configuration for more detail).  In particular you'll need to set these properties -- examples or defaults are provided in the file:
   
   • dspace.install.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 for indexing purposes.  
   • default.language 
   • db.name - postgres or oracle
   • db.driver
   • db.url
   • db.username - the database username 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 "build.properties" file is provided as a convenient method of setting only those configurations necessary to install/upgrade DSpace. Any settings changed in this file, will be automatically copied over to the full "dspace.cfg" file (which is held in [dspace-source]/dspace/config/dspace.cfg).  Refer to the General Configuration section for a fuller explanation. It is also worth noting that you may choose to copy/rename the "build.properties" under a different name for different environments (e.g. "development.properties", "test.properties", and "production.properties").  You can choose which properties file you want to build DSpace with by passing a "-Denv" (environment) flag to the "mvn package" command (e.g. "mvn package -Denv=test" would build using "test.properties).  See General Configuration section for more details.

     Warning
     title Do not remove or comment out settings in build.properties
     When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings.  Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting.  Instead, if you wish to remove/disable a particular setting, just clear out its value.  For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g. mail.registration.notify=

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

   Code Block
   cd [dspace-source]/dspace/ mvn package

   Warning
   title In DSpace 4.0, the above command must be run from [dspace-source]
   In the DSpace 4.0 release, the above "mvn package" command must be run from the root source directory (i.e. [dspace-source]), otherwise you will receive build errors. This was a small (but annoying) bug in our Maven build process, which is fixed in the 4.1 release (see DS-1867)

   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

   Info
   title Defaults to building installation package with settings from "build.properties"
   Without any extra arguments, the DSpace installation package will be initialized using the settings in the [dspace-source]/build.properties file.  However, if you want it to build using a custom properties file, you may specify the "-Denv" (environment) flag as follows: mvn -Denv=test package   (would build the installation package using a custom [dspace-source]/test.properties file) mvn -Denv=local package   (would build the installation package using a custom [dspace-source]/local.properties file) See General Configuration section for more details.

8. Install 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. Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the directory [tomcat]/conf/Catalina/localhost you could add files similar to the following (but replace [dspace]with your installation location):

     Code Block
     language html/xml title DEFINE A CONTEXT FOR DSpace XML User Interface: xmlui.xml
     <?xml version='1.0'?> <Context docBase="[dspace]/webapps/xmlui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>

     Code Block
     language html/xml title DEFINE A CONTEXT PATH FOR DSpace JSP User Interface: jspui.xml
     <?xml version='1.0'?> <Context docBase="[dspace]/webapps/jspui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>

     Code Block
     language html/xml title DEFINE A CONTEXT PATH FOR DSpace OAI User Interface: oai.xml
     <?xml version='1.0'?> <Context docBase="[dspace]/webapps/oai" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>

     Code Block
     language html/xml title DEFINE ADDITIONAL CONTEXT PATHS FOR OTHER DSPACE WEB APPLICATIONS (SOLR, SWORD, LNI, etc.): \[app\].xml
     <?xml version='1.0'?> <!-- CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context docBase="[dspace]/webapps/[app]" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/>

     The name of the file (not including the suffix ".xml") will be the name of the context, so for example xmlui.xml defines the context at http://host:8080/xmlui.  To define the root context (http://host:8080/), name that context's file ROOT.xml.

     Note
     title Tomcat Context Settings in Production
     The above Tomcat Context Settings show adding the following to each <Context> element: reloadable="true" cachingAllowed="false" These settings are extremely useful to have when you are first getting started with DSpace, as they let you tweak the DSpace XMLUI (XSLTs or CSS) or JSPUI (JSPs) and see your changes get automatically reloaded by Tomcat (without having to restart Tomcat).   However, it is worth noting that the Apache Tomcat documentation recommends Production sites leave the default values in place (reloadable="false" cachingAllowed="true"), as allowing Tomcat to automatically reload all changes may result in "significant runtime overhead".  It is entirely up to you whether to keep these Tomcat settings in place.  We just recommend beginning with them, so that you can more easily customize your site without having to require a Tomcat restart.  Smaller DSpace sites may not notice any performance issues with keeping these settings in place in Production.  Larger DSpace sites may wish to ensure that Tomcat performance is more streamlined.

   • Technique B. 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.)

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)

...