From ffe22552139f1b954b07558f4cae29dc552cdd11 Mon Sep 17 00:00:00 2001 From: Mark Diggory Date: Tue, 19 Feb 2008 04:48:26 +0000 Subject: [PATCH] Updates to the documentation based on feedback from the test-a-thon. Corrections to Maven based build and installation on Windows. Changed Copyright to be under The DSpace Foundation. git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@2687 9c30dcfa-912a-0410-8fc2-9e0234be79fd --- dspace/docs/appendix.html | 6 +- dspace/docs/application.html | 2 +- dspace/docs/architecture.html | 2 +- dspace/docs/business.html | 2 +- dspace/docs/configure.html | 2 +- dspace/docs/directories.html | 2 +- dspace/docs/functional.html | 2 +- dspace/docs/history.html | 2 +- dspace/docs/index.html | 2 +- dspace/docs/install.html | 497 ++++++++++++++++------------------ dspace/docs/introduction.html | 2 +- dspace/docs/storage.html | 2 +- dspace/docs/submission.html | 2 +- dspace/docs/update.html | 2 +- 14 files changed, 249 insertions(+), 278 deletions(-) diff --git a/dspace/docs/appendix.html b/dspace/docs/appendix.html index 6d5564dad0..73fa3d0c1c 100644 --- a/dspace/docs/appendix.html +++ b/dspace/docs/appendix.html @@ -586,6 +586,10 @@ - ¹ Used by system: do not remove + ¹ Used by system: do not remove + +
+ Copyright © 2002-2008 The DSpace Foundation +
\ No newline at end of file diff --git a/dspace/docs/application.html b/dspace/docs/application.html index c514b01979..faf288ee94 100644 --- a/dspace/docs/application.html +++ b/dspace/docs/application.html @@ -1059,7 +1059,7 @@ dsrun org.dspace.administer.CommunityFiliator -r -p parentID -c childID
- Copyright © 2002-2005 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/architecture.html b/dspace/docs/architecture.html index 91411b5224..bf26260bb7 100644 --- a/dspace/docs/architecture.html +++ b/dspace/docs/architecture.html @@ -133,6 +133,6 @@ Management
Copyright © -2002-2004 MIT and Hewlett Packard
+2002-2008 The DSpace Foundation diff --git a/dspace/docs/business.html b/dspace/docs/business.html index 4d22dd6ae0..b7269fbaf2 100644 --- a/dspace/docs/business.html +++ b/dspace/docs/business.html @@ -1191,7 +1191,7 @@ action --hasAgent--> User
- Copyright © 2002-2004 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/configure.html b/dspace/docs/configure.html index 1e871bfc0b..4074e9ee26 100644 --- a/dspace/docs/configure.html +++ b/dspace/docs/configure.html @@ -2184,7 +2184,7 @@ customisations demand regular full indexing you should set up a regular script t
- Copyright © 2002-2004 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/directories.html b/dspace/docs/directories.html index e742c0f512..11062c10b0 100644 --- a/dspace/docs/directories.html +++ b/dspace/docs/directories.html @@ -226,7 +226,7 @@
- Copyright © 2002-2005 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/functional.html b/dspace/docs/functional.html index f89c03c7e9..f04c09dc99 100644 --- a/dspace/docs/functional.html +++ b/dspace/docs/functional.html @@ -642,7 +642,7 @@ of new items are also available for collections and communities.

- Copyright © 2002-2006 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/history.html b/dspace/docs/history.html index 7ddcd7cdae..3c73c14c7c 100644 --- a/dspace/docs/history.html +++ b/dspace/docs/history.html @@ -548,6 +548,6 @@ error) expire.)
-
Copyright © 2002-2006 MIT and Hewlett Packard
+
Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/index.html b/dspace/docs/index.html index 166e71444b..e24cacc4f1 100644 --- a/dspace/docs/index.html +++ b/dspace/docs/index.html @@ -180,7 +180,7 @@
- Copyright © 2002-2006 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
diff --git a/dspace/docs/install.html b/dspace/docs/install.html index 1d1d3af9bc..3c988dd726 100644 --- a/dspace/docs/install.html +++ b/dspace/docs/install.html @@ -4,7 +4,7 @@ DSpace System Documentation: Installation - +

DSpace System Documentation: Installation

@@ -18,150 +18,169 @@ +
  • Installation
    • +
  • Advanced Installation Options
  • Windows Installation
  • Known Bugs
  • Common Problems
    • -

    +

    Prerequisite Software

    The list below describes the third-party components and tools you'll need to run a DSpace server. These are just guidelines. Since DSpace is built on open source, standards-based tools, there are numerous other possibilities and setups.

    Also, please note that the configuration and installation guidelines relating to a particular tool below are here for convenience. You should refer to the documentation for each individual component for complete and up-to-date details. Many of the tools are updated on a frequent basis, and the guidelines below may become out of date.

    - -
      -

    1. UNIX-like OS (Linux, HP/UX etc) or Microsoft Windows (see full Windows Instructions for full set of Windows prerequisites)

      2. - -

    2. Java SDK 1.5 or later (standard SDK is fine, you don't need J2EE)

      3. - -

    3. Apache Ant 1.6.2 or later (Java make-like tool)

      4. - -
    4. -

      PostgreSQL 7.3 or later, an open source relational database, or Oracle 9 or higher.

      - -
        -
      • -

        PostgreSQL

        - -

        Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+. For 7.x, be sure to compile with the following options to the 'configure' script:

        - - 
        --enable-multibyte --enable-unicode --with-java
        - -

        Once installed, you need to enable TCP/IP connections (DSpace uses JDBC). For 7.x, edit postgresql.conf (usually in /usr/local/pgsql/data or /var/lib/pgsql/data), and add this line:

        - - 
        tcpip_socket = true
        - -

        For 8.0+, in postgresql.conf uncomment the line starting:

        - - 
        listen_addresses = 'localhost'
        - -

        Then tighten up security a bit by editing pg_hba.conf and adding this line:

        - - 
        host  dspace  dspace  127.0.0.1  255.255.255.255  md5
        - -

        Then restart PostgreSQL.

        -
        • - -
      • -

        Oracle

        - -

        You will need to 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. You will also need to create a user account for DSpace (e.g. dspace,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.

        - -

        NOTE: DSpace uses sequences to generate unique object IDs - beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script etc/update-sequences.sql.

        - -

        ALSO NOTE: Everything is fully functional, although Oracle limits you to 4k of text in text fields such as item metadata or collection descriptions.

        - -

        For people interested in switching from Postgres to Oracle, I know of no tools that would do this automatically. You will need to recreate the community, collection, and eperson structure in the Oracle system, and then use the item export and import tools to move your content over.

        -
        • -
      - +

      UNIX-like OS or Microsoft Windows

      +
        +
      • UNIX-like OS (Linux, HP/UX etc) : Many distributions of Linux/Unix come with some of the dependencies below pre installed or easily installed via updates, you should consult your particular distributions documentation to determine what is already available.
        +
        • - -

      • Jakarta Tomcat 4.x or later. DSpace will also run on an equivalent, such as Jetty or Caucho Resin.

        - -

        Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called 'dspace'.

        - -

        You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its default file encoding for international character support. So ensure in your startup scripts (etc) that the following environment variable is set:

        - - 
        JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
        - -

        You also need to alter Tomcat's default configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a configuration option to the <Connector> element in [tomcat]/config/server.xml:

        - - 
        URIEncoding="UTF-8"
        - -

        e.g. if you're using the default Tomcat config, it should read:

        - - 
        <!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
+      
      • Microsoft Windows: (see full Windows Instructions for full set of prerequisites)
        • 
+
      +

      Java JDK 5 or later (standard SDK is fine, you don't need J2EE)

      +

      DSpace now required Java 5 or greater because of usage of new language capabilities introduced in 5 that make coding easier and cleaner.

      +

      Java 5 or later can be downloaded from the following location: http://java.sun.com/javase/downloads/index.jsp

      +

      Apache Maven 2.0.8 or later (Java build tool)

      +

      Maven is necessary in the first stage of the build process to assemble the installation package for your DSpace instance. It gives you the flexibility to customize DSpace using the exisitng Maven projects found in the [dspace-source]/dspace/modules directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes.

      +

      Maven can be downloaded from the the following location: http://maven.apache.org/download.html

      +

      Apache Ant 1.6.2 or later (Java build tool)

      +

      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.

      +

      Ant can be downloaded from the following location: http://ant.apache.org

      +

      Relational Database: (PostgreSQL or Oracle).

      +
        +
      • +

        PostgreSQL 7.3 or greater

        +

        PostgreSQL can be downloaded from the following location: http://www.postgresql.org/
        +
        +         Its highly recommended that you try to work with Postgres 8.x or greater, however, 7.3 or greater should still work. Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+. For 7.x, be sure to compile with the following options to the 'configure' script:

        +
        • + 
      • --enable-multibyte --enable-unicode --with-java
        +

        Once installed, you need to enable TCP/IP connections (DSpace uses JDBC). For 7.x, edit postgresql.conf (usually in /usr/local/pgsql/data or /var/lib/pgsql/data), and add this line:

        + 
        tcpip_socket = true
        +

        For 8.0+, in postgresql.conf uncomment the line starting:

        + 
        listen_addresses = 'localhost'
        +

        Then tighten up security a bit by editing pg_hba.conf and adding this line:

        + 
        host  dspace  dspace  127.0.0.1  255.255.255.255  md5
        +

        Then restart PostgreSQL.

        +
        • +
      • +

        Oracle 9 or greater

        +

        Details on aquiring Oracle can be downloaded from the following location: http://www.oracle.com/database/
        +
        + You will need to 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. You will also need to create a user account for DSpace (e.g. dspace,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.

        +

        NOTE: DSpace uses sequences to generate unique object IDs - beware Oracle sequences, which are said to lose their values when doing a database export/import, say restoring from a backup. Be sure to run the script etc/update-sequences.sql.

        +

        ALSO NOTE: Everything is fully functional, although Oracle limits you to 4k of text in text fields such as item metadata or collection descriptions.

        +

        For people interested in switching from Postgres to Oracle, I know of no tools that would do this automatically. You will need to recreate the community, collection, and eperson structure in the Oracle system, and then use the item export and import tools to move your content over.

        +
        • +
      +

      Servlet Engine: (Jakarta Tomcat 4.x, Jetty, Caucho Resin or equivalent).

      +
        +
      • Jakarta Tomcat 4.x or later.
        +
        + Tomcat can be dowloaded from the following location: http://tomcat.apache.org
        +
        + Note that DSpace will need to run as the same user as Tomcat, so you might want to install and run Tomcat as a user called 'dspace'.
        +
        + You need to ensure that Tomcat has a) enough memory to run DSpace and b) uses UTF-8 as its default file encoding for international character support. So ensure in your startup scripts (etc) that the following environment variable is set: + 
        JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
        + You also need to alter Tomcat's default configuration to support searching and browsing of multi-byte UTF-8 correctly. You need to add a configuration option to the <Connector> element in [tomcat]/config/server.xml: + 
        URIEncoding="UTF-8"
        + e.g. if you're using the default Tomcat config, it should read: + 
        <!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
 <Connector port="8080"
            maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
            enableLookups="false" redirectPort="8443" acceptCount="100"
            connectionTimeout="20000" disableUploadTimeout="true"
            URIEncoding="UTF-8" />
        - -

        Jetty and Resin are configured for correct handling of UTF-8 by default.

        • - -

      • Apache Maven 2 (Java project build manager)

        -

        Maven is necessary to build the installation package for DSpace, and apply any custom interface "overlay" changes.

        -
        • - -
    - -

    Installation Options

    +
  • Jetty or Caucho Resin
    +
    + DSpace will also run on an equivalent servlet Engine, such as Jetty (http://www.mortbay.org/jetty/index.html) or Caucho Resin (http://www.caucho.com/).
    +
    + Jetty and Resin are configured for correct handling of UTF-8 by default.
    • + + +

     

    +

    Installation Options

    Overview of Install Options

    -

    With the advent of a new Maven-based build architecture in DSpace 1.5.x, - you now have a few options in how you may wish to install and manage your - local installation of DSpace. There are now two different methods to installing - DSpace software. Which path you choose may be entirely dependent on your - institution's DSpace resources and technical knowledge:

    -

    -

    -

    - -

    Overview of DSpace Directories

    +

    With the advent of a new Apache Maven 2 based build architecture in DSpace 1.5.x, + you now have two options in how you may wish to install and manage your local installation of DSpace. If you've used DSpace 1.4.x, please + recognize that the initial build proceedure has changed to allow for more customization. You will find the later 'Ant based' stages of the + installation proceedure familiar. Maven is used to resolve the dependencies of DSpace online from the 'Maven Central Repository' server.

    +

    Its important to note that the strategies are identical in terms of the list of proceedures required to complete the build process, the only difference being that the Source Release includes "more modules" that will be built given their presence in the distribution package.

    + +

    Both approaches provide you with the same control over how DSpace + builds itself (especially in terms of adding completely custom/3rd-party DSpace + "modules" you wish to use). Both methods allow you the ability to create more complex user interface "overlays" in Maven. + An interface "overlay" allows you to only manage your local custom code (in your local CVS or SVN), + and automatically download the rest of the interface code from the maven central repository whenever + you build DSpace. This reduces the amount of out-of-the-box + DSpace interface code maintained in your local CVS/SVN.

    +

    Overview of DSpace Directories

    Before beginning an installation, it is important to get a general understanding of the DSpace directories and the names by which they are generally referred. @@ -170,12 +189,17 @@ you may be referring to.)

    DSpace uses three separate directory trees. Although you don't need to know all the details -of them in order to install DSpace, you do need to know they exist and also know how they're referred to in this document:

    -

      +of them in order to install DSpace, you do need to know they exist and also know how they're referred to in this document: + +
      1. the installation directory, referred to as [dspace]. This is the location where - all the DSpace configuration files, command line scripts, documentation and webapps exist.
        2. + 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. the source directory, referred to as [dspace-source]. This is the location - where DSpace was initially downloaded to.
        3. + 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. 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, @@ -188,11 +212,9 @@ of them in order to install DSpace, you do need to know they exist and also know Note that the [dspace-source] and [dspace] directories are always separate!

        -

        Quick Installation Method

        +

        Installation

        - This method gets you up and running with DSpace quickly and easily. However, you should be aware - that it provides you with pre-compiled DSpace Java code. This means that if you are wanting to - change any of the underlying DSpace Java code, you should use the Maven-based Installation Method instead. + This method gets you up and running with DSpace quickly and easily. It is identical in both the Default Release and Source Release distributions.
        1. @@ -200,21 +222,15 @@ of them in order to install DSpace, you do need to know they exist and also know 
          useradd -m dspace
          2. -
        2. -

          Download the latest DSpace release and unpack it. - Although there are two available releases (dspace-1.x.tar.gz and dspace-1.x-src.tar.gz), +

        3. Download the latest DSpace release and unpack it. + Although there are two available releases (dspace-1.x-release.zip and dspace-1.x-src-release.zip), 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.tar.gz release. -

          - - 
          gunzip -c dspace-1.x.tar.gz | tar -xf -
          + the dspace-1.x-src-release.zip release. + 
          unzip dspace-1.x-release.zip

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

          - + remainder of these instructions.

        4. @@ -222,8 +238,8 @@ of them in order to install DSpace, you do need to know they exist and also know

          Postgres:

          1. -

            Copy the PostgreSQL JDBC driver (.jar file) into -[dspace-source]/dspace/lib. If you compiled PostgreSQL yourself, it'll be in postgresql-7.x.x/src/interfaces/jdbc/jars/postgresql.jar. Alternatively you can download it directly from the PostgreSQL JDBC site. Make sure you get the recommended driver for the version of PostgreSQL you're running.

            2. +

            A PostgreSQL 8.1-404 jdbc3 driver is configure as part of the default DSpace build. You no longer need to copy any postgres jars to get postgres installed.

            +

          2. Create a dspace database, owned by the dspace PostgreSQL user:

            @@ -236,11 +252,15 @@ createdb -U dspace -E UNICODE dspace

            Oracle:

            1. -

              Copy the Oracle JDBC driver into [dspace-source]/dspace/lib.

              -
              2. -
            2. +

              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
              +

              +
              3. +

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

              -
              4. +

            4. Edit the [dspace-source]/dspace/config/dspace.cfg database settings:

              db.name   = oracle
@@ -249,51 +269,54 @@ db.driver = oracle.jdbc.OracleDriver

            5. Go to [dspace-source]/dspace/etc/oracle and copy the contents to their parent directory, overwriting the versions in the parent: - 

              cd [dspace-source]/dspace/etc/oracle
 cp * ..

              You now have Oracle-specific .sql files in your etc directory, and your dspace.cfg is modified to point to your Oracle database.

              6. -

            +
          +

          5. -
        5. -

          Edit [dspace-source]/dspace/config/dspace.cfg, in particular you'll need to set these properties: +

        6. 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.dir -- must be set to the [dspace] (installation) directory. -
          dspace.url -- complete URL of this server's DSpace home page. +
          + dspace.url -- complete URL of this server's DSpace home page. -
          dspace.hostname -- fully-qualified domain name of web server. +
          + dspace.hostname -- fully-qualified domain name of web server. -
          dspace.name -- "Proper" name of your server, e.g. "My Digital Library". +
          + dspace.name -- "Proper" name of your server, e.g. "My Digital Library".
          + db.password -- the database password you entered in the previous step. -
          db.password -- the database password you entered in the previous step. +
          + mail.server -- fully-qualified domain name of your outgoing mail server. -
          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.from.address -- the "From:" address to put on email sent by DSpace. +
          + mail.admin -- mailbox for DSpace site administrator. -
          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) +
          + 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: 

              feedback.recipient = ${mail.admin}
          -See the dspace.cfg file for examples. - +See the dspace.cfg file for examples.
          +
          7. -
        7. -

          Create the directory for the DSpace installation (i.e. [dspace]). As root (or a user with appropriate permissions), run:

          - +
        8. Create the directory for the DSpace installation (i.e. [dspace]). As root (or a user with appropriate permissions), run: 
          mkdir [dspace]
 chown dspace [dspace]
          @@ -303,13 +326,16 @@ chown dspace [dspace]

        9. As the dspace UNIX user, generate the DSpace installation package in the [dspace-source]/dspace/target/dspace-[version].dir/ directory:

          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, +

          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:

          - 
          mvn -Ddb.name=oracle package
          - + 
          mvn -Ddb.name=oracle package
+

        10. As the dspace UNIX user, initialize the DSpace database and install DSpace to [dspace]:

          @@ -338,18 +364,13 @@ ant fresh_install 
          cp -r [dspace]/webapps/dspace-jspui [tomcat]/webapps
 cp -r [dspace]/webapps/dspace-oai [tomcat]/webapps
          -
          11. -
        11. -

          Create an initial administrator account:

          - +
        12. Create an initial administrator account: 
          [dspace]/bin/create-administrator
          13. -
        13. -

          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!

          - +
        14. 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/dspace-jspui
            • @@ -359,84 +380,9 @@ cp -r [dspace]/webapps/dspace-oai [tomcat]/webapps
        -

        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.

        +

        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.

        -

        Maven-based Installation Method

        - -

        This method allows you to build your own custom version of DSpace using Apache Maven 2. - If you are not wanting to custom any of DSpace's Java API, or just want to get up and running quickly, - it is recommend that you use the Quick Installation Method instead.

        - -

        Additional Prerequisites -

          -
        • Subversion (SVN) - Necessary to checkout the DSpace source code from SourceForge SVN
          • -
        -

        - -

        Build & Install Steps -

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

          - - 
          useradd -m dspace
          -
          2. -
        2. -

          Create the source directory for the DSpace modules to reside (i.e. [dspace-source]). As root (or a user with appropriate permissions), run:

          - - 
          mkdir [dspace-source]
-chown dspace [dspace-source]
          - -

          (Assuming the dspace UNIX username.)

          -
          3. -
        3. -

          Checkout the DSpace Source code from SourceForge SVN into [dspace-source]. For example:

          - - 
          svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5 [dspace-source]
          - -

          If you wish, you can choose to only checkout the source code for the specific DSpace "modules" - which you want to install. However, you must always checkout the 'dspace' module, as - it is the module which builds DSpace. For example, if you only want to install the XML-UI and the OAI-PMH interface - you can perform the following checkouts:

          - - 
          svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace [dspace-source]
-svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-xmlui [dspace-source]
-svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5/dspace-oai [dspace-source]	  	
-
          - -

          In order, you are checking out the 'dspace' module (builds DSpace), - 'dspace-xmlui' module (provides XML-UI), and 'dspace-oai' module (provides OAI-PMH).

          - -

          In the end, you should have a folder structure similar to the following in [dspace-source]: -

            -
          • [dspace-source] -
              -
            • dspace/ - DSpace 'build' and configuration module
              • -
            • dspace-api/ - DSpace Java API module
              • -
            • dspace-jspui/ - DSpace JSP-UI module
              • -
            • dspace-oai/ - DSpace OAI-PMH interface module
              • -
            • dspace-xmlui/ - DSpace XML-UI module
              • -
            -
            • -
          -
          4. -
        4. -

          Note: Although we won't go into this in detail, you can also create your own - completely custom Maven-based modules in your [dspace-source] directory. - To build your custom modules into DSpace, you would need to modify the 'dspace' - module's pom.xml (Project Object Model) to look for those custom modules, and - then re-build your DSpace installation package. Look - at the Maven Documentation or - DSpace Wiki for more hints and tricks.

          -
          5. -

        5. Once you've downloaded the appropriate DSpace modules into [dspace-source], you can follow the steps in the - Quick Installation Method above to finish installing and configuring DSpace. - Just remember that you can skip downloading the Latest DSpace Release from - SourceForge, as you've already downloaded it via Maven.

          -
          6. -
        -

        - -

        Useful Maven References +

        Useful Maven References

        • Maven Homepage - The place to go for all things Maven...it also includes links to the below resources.
        • Maven User Centre - Basic documentation and Tutorials for Maven. Also has a Project Object Model (POM) reference.
          • @@ -786,8 +732,8 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \

        • Java SDK 1.5 or later (standard SDK is fine, you don't need J2EE)

        • PostgreSQL 8.x for Windows. This comes with an installer application now, so Cygwin is no longer required. Make sure the ODBC + JDBC options are selected, as well as the pgAdmin III tool

        • Apache Ant 1.6.x. 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+

          -

        +

      4. Jakarta Tomcat 5.x+

        +

        Installation Steps

        @@ -797,8 +743,10 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \

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

        6. +
      6. Create a database called dspace owned by the user dspace, with UTF-8 encoding
        +
        + +

      7. 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: @@ -815,8 +763,26 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \ handle.dir

      8. Create the directory for the DSpace installation (e.g. C:\DSpace)

        9. -

      9. Run:

        ant fresh_install

        10. -

      10. Create an administrator account, e.g. assuming C:\dspace is where your DSpace installation is:

        C:\dspace\bin\dsrun org.dspace.administer.CreateAdministrator

        +
      11. Generate the DSpace installation package in the [dspace-source]/dspace/target/dspace-[version].dir/ directory: + 
        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:

        + 
        mvn -Ddb.name=oracle package
+
        +
      12. +

        As the dspace UNIX user, initialize the DSpace database and install DSpace to [dspace]:

        + 
        cd [dspace-source]/dspace/target/dspace-[version].dir/
+ant fresh_install
        +

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

        + 
        ant help
        +
        13. +

      13. Create an administrator account, e.g. assuming C:\dspace is where your DSpace installation is: +

        [dspace]\bin\dsrun org.dspace.administer.CreateAdministrator

        and enter the required information

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

          @@ -834,7 +800,8 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \

        • Start the Tomcat service

        • Browse http://localhost:8080/dspace. You should see the DSpace home page

          • -

      +
    +

    Checking Your Installation

    diff --git a/dspace/docs/introduction.html b/dspace/docs/introduction.html index 6f1734c11b..6e2a8253f0 100644 --- a/dspace/docs/introduction.html +++ b/dspace/docs/introduction.html @@ -49,7 +49,7 @@
    - Copyright © 2002-2005 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
    diff --git a/dspace/docs/storage.html b/dspace/docs/storage.html index 7f3d87068c..6cb13c713e 100644 --- a/dspace/docs/storage.html +++ b/dspace/docs/storage.html @@ -254,7 +254,7 @@ srb.parentdir.1 = mysrbdspaceassetstore
    - Copyright © 2002-2005 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
    diff --git a/dspace/docs/submission.html b/dspace/docs/submission.html index 778dc1851c..ef9ab6ad1f 100644 --- a/dspace/docs/submission.html +++ b/dspace/docs/submission.html @@ -715,7 +715,7 @@
    - Copyright © 2002-2007 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation
    diff --git a/dspace/docs/update.html b/dspace/docs/update.html index fb2d41c3a6..cb570a8b89 100644 --- a/dspace/docs/update.html +++ b/dspace/docs/update.html @@ -893,7 +893,7 @@ ant -Dconfig=[dspace]/config/dspace.cfg update
    - Copyright © 2002-2004 MIT and Hewlett Packard + Copyright © 2002-2008 The DSpace Foundation