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

Prerequisite Software

...

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.6-release.zip

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

      Code Block
      gunzip -c dspace-1.6-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.6-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:
   1. 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.
   2. 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:
   3. 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$ mvn install:install-file -Dfile=ojdbc14.jar -DgroupId=com.oracle \ -DartifactId=ojdbc14 -Dversion=10.2.0.2.0 -Dpackaging=jar -DgeneratePom=true
   4. 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.

   5. 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:*{*}{_}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 like:

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

   Refer to 5.2. General Configuration 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

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

   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. Wiki Markup

   *Deploy Web Applications*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" ....

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)
      In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which you created with create-administrator above) and access the administration UI in either the JSP or XML user interface.

...

# Send out subscription e-mails at 01:00 every day
0 1 * * *  [dspace]/bin/dspace sub-daily
# Run the media filter at 02:00 every day
0 2 * * *  [dspace]/bin/dspace filter-media
# Run the checksum checker at 03:00
0 3 * * *  [dspace]/bin/dspace checker -lp
# Mail the results to the sysadmin at 04:00
0 4 * * *  [dspace]/bin/dsrundspace org.dspace.checker.DailyReportEmailerchecker-emailer -c

Naturally you should change the frequencies to suit your environment.

...

# Run stat analysis
0 1 * * * [dspace]/bin/dspace stat-general
0 1 * * * [dspace]/bin/dspace stat-monthly
0 2 * * * [dspace]/bin/dspace stat-report-general
0 2 * * * [dspace]/bin/dspace stat-report-monthly

Obviously, you should choose execution times which are most useful to you, and you should ensure that the report scripts run a short while after the analysis scripts to give them time to complete (a run of around 8 months worth of logs can take around 25 seconds to complete); the resulting reports will let you know how long analysis took and you can adjust your cron times accordingly.

...

If you need to update the handle prefix on items created before the CNRI registration process you can run the _\[dspace\]/bin/dspace update-handle-prefix script_. You may need to do this if you loaded items prior to CNRI registration (e.g. setting up a demonstration system prior to migrating it to production). The script takes the current and new prefix as parameters. For example:

...

• Java SDK 1.5 or later (standard SDK is fine, you don't need J2EE)
• PostgreSQL 8.x for Windows OR Oracle 9 or later.
  • If you install PostgreSQL, it's recommended to select to install the pgAdmin III tool¬†tool
• Apache Ant 1.6.2 or later. Unzip the package in C: _ and add _ C:\apache-ant-1.6.2\bin to the PATH environment variable. For Ant to work properly, you should ensure that JAVA_HOME is set.
• Jakarta Tomcat 5.x or later
• Apache Maven 2.0.8 or later

...

1. Download the DSpace source from SourceForge and untar 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_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. Wiki Markup
   Generate the DSpace installation package by running the following from command line (cmd) from your _\[dspace-source\]/dspace/_ directory:

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

   Code Block
   ant help

7. Wiki Markup
   Create an administrator account, by running the following from your _\[dspace\]_ (e.g. _C:\DSpace_) directory_\[dspace\]\bin\dsrun org.dspace.administer.CreateAdministratordspace create-administrator_and enter the required information 

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 5.5\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 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.

...