Page History

...

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

...

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.

...

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.zip do the following:

      Code Block
      unzip dspace-1.8-release.zip

   2. .gz file. If you downloaded dspace-1.8-release.tar.gz do 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 -

      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 user. This is entirely separate from the dspace operating-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 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.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. Installation Package: As the dspace UNIX 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. 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:

   Anchor
   deployment deployment

   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. DSpace Configuration for Accessing Solr. In the dspace.cfg file review the following fields to make sure they are uncommented:

   Code Block
   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 header.  This feature can be enabled by ensuring the following setting is uncommented in the logging section of dspace.cfg:

   Code Block
   useProxies = true

3. Configuration Control. In the dspace.cfg set the following property key:_statistics.item.authorization.admin=true_This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available.
4. Final 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)

...

1. Download the DSpace source from SourceForge and unzip 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 Also, make sure you change all of the parameters with file paths to suit, specifically:

     Code Block
     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

4. Create the directory for the DSpace installation (e.g. C:/DSpace)
5. Generate the DSpace installation package by running the following from command line (cmd) :

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

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

     Code Block
     mvn -Ddb.name=oracle package

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

   Code Block
   ant fresh_install

   • Note: to see a complete list of build targets, run: ant help

7. Wiki Markup
   Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory:

   Code Block
   [dspace]\bin\dspace create-administrator

8. 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\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"/>

9. Start the Tomcat service
10. Browse to either http://localhost:8080/jspui or http://localhost:8080/xmlui. You should see the DSpace home page for either the JSPUI or XMLUI, respectively.

...

• GeoLiteCity Database file fails to download or install, when you run ant fresh_install: There are two common errors that may occur:
  • If your error looks like this:

    Code Block
    [get] Error getting http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz to /usr/local/dspace/config/GeoLiteCity.dat.gz BUILD FAILED /dspace-release/dspace/target/dspace-1.8.0-build.dir/build.xml:931: java.net.ConnectException: Connection timed out

    it means that you likely either (a) don't have an internet connection to download the necessary GeoLite Database file (used for DSpace Statistics), or (b) the GeoLite Database file's URL is no longer valid. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.
  • Another common message looks like this:

    Code Block
    [echo] WARNING : FAILED TO DOWNLOAD GEOLITE DATABASE FILE [echo] (Used for DSpace Solr Usage Statistics)

    Again, this means the GeoLite Database file cannot be downloaded or is unavailable for some reason. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.

...