hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-23 09:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates to the documentation based on feedback from the test-a-thon.

Browse Source 
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
This commit is contained in:
Mark Diggory
2008-02-19 04:48:26 +00:00
parent 0a677d7b03
commit ffe2255213
14 changed files with 249 additions and 278 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
dspace/docs/appendix.html
View File

@@ -586,6 +586,10 @@
</tbody>
</table>
<a name="note2">&sup1; Used by system: do not remove</a>
<a name="note2">&sup1; Used by system: do not remove</a>
<address>
Copyright &copy; 2002-2008 The DSpace Foundation
</address>
</body>
</html>

2
dspace/docs/application.html
View File

@@ -1059,7 +1059,7 @@ dsrun org.dspace.administer.CommunityFiliator -r -p parentID -c childID
<hr>
<address>
Copyright &copy; 2002-2005 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</address>
</body>
</html>

2
dspace/docs/architecture.html
View File

@@ -133,6 +133,6 @@ Management</a></li>
</ul>
<hr>
<address> Copyright &copy;
2002-2004 MIT and Hewlett Packard </address>
2002-2008 The DSpace Foundation </address>
</body>
</html>

2
dspace/docs/business.html
View File

@@ -1191,7 +1191,7 @@ action --hasAgent--> User</PRE>
<HR>
<ADDRESS>
Copyright &copy; 2002-2004 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>

2
dspace/docs/configure.html
View File

@@ -2184,7 +2184,7 @@ customisations demand regular full indexing you should set up a regular script t
<hr>
<address>
Copyright &copy; 2002-2004 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</address>
</body>
</html>

2
dspace/docs/directories.html
View File

@@ -226,7 +226,7 @@
<HR>
<ADDRESS>
Copyright &copy; 2002-2005 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>

2
dspace/docs/functional.html
View File

@@ -642,7 +642,7 @@ of new items are also available for collections and communities.</p>
<hr>
<address>
Copyright &copy; 2002-2006 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</address>
</body>
</html>

2
dspace/docs/history.html
View File

@@ -548,6 +548,6 @@ error)</li>
expire.)</li>
</ul>
<hr>
<address> Copyright &copy; 2002-2006 MIT and Hewlett Packard </address>
<address> Copyright &copy; 2002-2008 The DSpace Foundation </address>
</body>
</html>

2
dspace/docs/index.html
View File

@@ -180,7 +180,7 @@
<HR>
<ADDRESS>
Copyright &copy; 2002-2006 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>

497
dspace/docs/install.html
View File

@@ -4,7 +4,7 @@
<TITLE>DSpace System Documentation: Installation</TITLE>
<LINK REL=StyleSheet HREF="style.css" TYPE="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" >
</HEAD>
</HEAD>
<BODY>
<H1>DSpace System Documentation: Installation</H1>
@@ -18,150 +18,169 @@
<UL>
<LI><A HREF="install.html#options">Overview of Install Options</A></LI>
<LI><A HREF="install.html#directories">Overview of DSpace Directories</A></LI>
<LI><A HREF="install.html#installsteps">Quick Installation Method</A></LI>
<LI><A HREF="install.html#maveninstall">Maven-based Installation Method</A></LI>
</UL>
<LI><A HREF="install.html#installsteps">Installation</A></LI>
</UL>
</LI>
<LI><A HREF="install.html#advancedinstall">Advanced Installation Options</A></LI>
<li><a href="install.html#windows">Windows Installation</a></li>
<LI><A HREF="install.html#knownbugs">Known Bugs</A></LI>
<LI><A HREF="install.html#problems">Common Problems</A></LI>
</UL>
</P>
</P>
<H2><A NAME="prerequisite">Prerequisite Software</A></H2>
<P>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.</P>
<P>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.</P>
<ol>
<li><P>UNIX-like OS (Linux, HP/UX etc) or Microsoft Windows (see full <a href="#windows">Windows Instructions</a> for full set of Windows prerequisites)</P> </li>
<li><P><A HREF="http://java.sun.com/">Java SDK 1.5</A> or later (standard SDK is fine, you don't need J2EE)</P></li>
<li><P><A HREF="http://ant.apache.org/">Apache Ant 1.6.2</A> or later (Java make-like tool)</P></li>
<li>
<P><A HREF="http://www.postgresql.org/">PostgreSQL 7.3</A> or later, an open source relational database, or <a href="http://www.oracle.com/database/">Oracle 9 or higher</A>.</P>
<UL>
<LI>
<P><strong>PostgreSQL</strong></P>
<P>Unicode (specifically UTF-8) support must be enabled. This is enabled by default in 8.0+. For 7.<em>x</em>, be sure to compile with the following options to the '<code>configure</code>' script:</P>
<PRE>--enable-multibyte --enable-unicode --with-java</PRE>
<P><A NAME="enabletcpip"></a>Once installed, you need to enable TCP/IP connections (DSpace uses JDBC). For 7.<em>x</em>, edit <code>postgresql.conf</code> (usually in <code>/usr/local/pgsql/data</code> or <code>/var/lib/pgsql/data</code>), and add this line:</P>
<PRE>tcpip_socket = true</PRE>
<P>For 8.0+, in <code>postgresql.conf</code> uncomment the line starting:</P>
<PRE>listen_addresses = 'localhost'</PRE>
<P>Then tighten up security a bit by editing <code>pg_hba.conf</code> and adding this line:</P>
<PRE>host dspace dspace 127.0.0.1 255.255.255.255 md5</PRE>
<P>Then restart PostgreSQL.</P>
</LI>
<LI>
<P><strong>Oracle</strong></P>
<p>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. <code>dspace</code>,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.</p>
<P><STRONG>NOTE:</STRONG> 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 <code>etc/update-sequences.sql</code>.</P>
<P><STRONG>ALSO NOTE:</STRONG> Everything is fully functional, although Oracle limits you to 4k of text in text fields such as item metadata or collection descriptions.</P>
<P>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.</P>
</LI>
</UL>
<h3>UNIX-like OS or Microsoft Windows </h3>
<ul>
<li>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.<br>
<br>
</li>
<li><P><A HREF="http://jakarta.apache.org/tomcat/">Jakarta Tomcat 4.x</A> or later. DSpace will also run on an equivalent, such as <A HREF="http://www.mortbay.org/jetty/index.html">Jetty</A> or <A HREF="http://www.caucho.com/">Caucho Resin</A>. </P>
<P>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 '<code>dspace</code>'.</P>
<P>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:</P>
<PRE>JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"</PRE>
<P>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 <code>&lt;Connector&gt;</code> element in <code><i>[tomcat]</i>/config/server.xml</code>:</P>
<PRE>URIEncoding="UTF-8"</PRE>
<P>e.g. if you're using the default Tomcat config, it should read:</P>
<PRE>&lt;!-- Define a non-SSL HTTP/1.1 Connector on port 8080 --&gt;
<li>Microsoft Windows: (see full <a href="#windows">Windows Instructions</a> for full set of prerequisites)</li>
</ul>
<h3>Java JDK 5 or later (standard SDK is fine, you don't need J2EE)</h3>
<p>DSpace now required Java 5 or greater because of usage of new language capabilities introduced in 5 that make coding easier and cleaner.</p>
<p>Java 5 or later can be downloaded from the following location: <a href="http://java.sun.com/javase/downloads/index.jsp">http://java.sun.com/javase/downloads/index.jsp</a></p>
<h3>Apache Maven 2.0.8 or later (Java build tool)</h3>
<p>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 <code>[dspace-source]/dspace/modules</code> directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes.</p>
<p>Maven can be downloaded from the the following location: <a href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a></p>
<h3>Apache Ant 1.6.2 or later (Java build tool)</h3>
<p>Apache Ant is still required for the second stage of the build process. It is used once the installation package has been constructed in <code>[dspace-source]/dspace/target/dspace-&lt;version&gt;-build.dir</code> and still uses some of the familiar ant build targets found in the 1.4.x build process.</p>
<p>Ant can be downloaded from the following location: <A HREF="http://ant.apache.org/">http://ant.apache.org</A> </p>
<h3>Relational Database: (PostgreSQL or Oracle).</h3>
<UL>
<LI>
<P><strong>PostgreSQL 7.3 or greater</strong></P>
<P>PostgreSQL can be downloaded from the following location: <A HREF="http://www.postgresql.org/">http://www.postgresql.org/<br>
<br>
</A>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.<em>x</em>, be sure to compile with the following options to the '<code>configure</code>' script: </P>
</LI>
<LI><PRE>--enable-multibyte --enable-unicode --with-java</PRE>
<P><A NAME="enabletcpip"></a>Once installed, you need to enable TCP/IP connections (DSpace uses JDBC). For 7.<em>x</em>, edit <code>postgresql.conf</code> (usually in <code>/usr/local/pgsql/data</code> or <code>/var/lib/pgsql/data</code>), and add this line:</P>
<PRE>tcpip_socket = true</PRE>
<P>For 8.0+, in <code>postgresql.conf</code> uncomment the line starting:</P>
<PRE>listen_addresses = 'localhost'</PRE>
<P>Then tighten up security a bit by editing <code>pg_hba.conf</code> and adding this line:</P>
<PRE>host dspace dspace 127.0.0.1 255.255.255.255 md5</PRE>
<P>Then restart PostgreSQL.</P>
</LI>
<LI>
<P><strong>Oracle 9 or greater</strong></P>
<p> Details on aquiring Oracle can be downloaded from the following location: <a href="http://www.oracle.com/database/">http://www.oracle.com/database/</a><br>
<br>
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. <code>dspace</code>,) and ensure that it has permissions to add and remove tables in the database. Refer to the Quick Installation for more details.</p>
<P><STRONG>NOTE:</STRONG> 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 <code>etc/update-sequences.sql</code>.</P>
<P><STRONG>ALSO NOTE:</STRONG> Everything is fully functional, although Oracle limits you to 4k of text in text fields such as item metadata or collection descriptions.</P>
<P>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.</P>
</LI>
</UL>
<h3>Servlet Engine: (Jakarta Tomcat 4.x, Jetty, Caucho Resin or equivalent). </h3>
<ul>
<li><strong>Jakarta Tomcat 4.x or later.</strong><br>
<br>
Tomcat can be dowloaded from the following location: <a href="http://tomcat.apache.org/whichversion.html">http://tomcat.apache.org</a><br>
<br>
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 '<code>dspace</code>'.<br>
<br>
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:
<PRE>JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"</PRE>
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 <code>&lt;Connector&gt;</code> element in <code><i>[tomcat]</i>/config/server.xml</code>:
<PRE>URIEncoding="UTF-8"</PRE>
e.g. if you're using the default Tomcat config, it should read:
<PRE>&lt;!-- Define a non-SSL HTTP/1.1 Connector on port 8080 --&gt;
&lt;Connector port="8080"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" redirectPort="8443" acceptCount="100"
connectionTimeout="20000" disableUploadTimeout="true"
<strong>URIEncoding="UTF-8"</strong> /&gt;</PRE>
<P>Jetty and Resin are configured for correct handling of UTF-8 by default.</P>
</li>
<li><P><A HREF="http://maven.apache.org/">Apache Maven 2</A> (Java project build manager)</P>
<P>Maven is necessary to build the installation package for DSpace, and apply any custom interface "overlay" changes.</P>
</li>
</ol>
<H2><A NAME="installoptions">Installation Options</A></H2>
<li><strong>Jetty or Caucho Resin</strong><br>
<br>
DSpace will also run on an equivalent servlet Engine, such as Jetty (<A HREF="http://www.mortbay.org/jetty/index.html">http://www.mortbay.org/jetty/index.html</A>) or Caucho Resin (<A HREF="http://www.caucho.com/">http://www.caucho.com/)</A>.<br>
<br>
Jetty and Resin are configured for correct handling of UTF-8 by default.</li>
</ul>
<p>&nbsp;</p>
<H2><A NAME="installoptions">Installation Options</A></H2>
<H3><A NAME="options">Overview of Install Options</A></H3>
<p>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:</p>
<p>
<ul>
<li><A href="#installsteps">Quick Installation Method</A>
<ul>
<li>As its name implies, this installation method is the quickest
and easiest. This method will be very familiar to you
if you've used DSpace 1.4.x or below, as it mirrors the old path
of installing and managing DSpace</li>
<li>This method allows you to customize DSpace configurations (in dspace.cfg)
or user interfaces, using basic pre-built interface "overlays". However, it will not allow you to customize or change the
underlying DSpace Java API, as <em>all Java code comes pre-compiled.</em></li>
<li><strong>This method is highly recommended for those who are new to DSpace,
may not have as much technical staff for DSpace at their institutions,
or do not wish to make changes to the underlying DSpace Java API.</strong></li>
</ul>
</li>
<li><A href="#maveninstall">Maven-based Installation Method</A>
<ul>
<li>This installation method requires much more familiarity with
how
<A HREF="http://maven.apache.org/">Apache Maven 2</A> works.
This method provides your institution with more control over how DSpace
builds itself (especially in terms of adding completely custom/3rd-party DSpace
"modules" you wish to use). However, this route also requires that you (or someone at
your institution) learn the basics of how to use Maven, and potentially how to create
your own Maven Project Object Model (POM).</li>
<li>This method allows 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 DSpace SVN whenever
you build DSpace. This means you wouldn't have to manage any of the out-of-the-box
DSpace interface code in your local CVS/SVN.</li>
<li><strong>This method is recommended for those who have technical staff at their
institutions devoted to DSpace, wish to create new DSpace modules or customize
the DSpace Java API, or just want to learn more about how Maven works.</strong></li>
</ul>
</li>
</ul>
</p>
<H3><A NAME="directories">Overview of DSpace Directories</A></H3>
<p>With the advent of a new Apache <A HREF="http://maven.apache.org/">Maven 2</A> 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. </p>
<p>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 &quot;more modules&quot; that will be built given their presence in the distribution package.</p>
<ul>
<li><A name="defaultRelease">Default Release ( dspace-&lt;version&gt;-release.zip )<br>
<br>
</A>
<ul>
<li><strong>This distribution will be adequate for most cases of running a DSpace instance. </strong><strong>It is intended to be the quickest way to get DSpace installed and running while still allowing for customization of the themes and branding of your DSpace instance.</strong><br>
</li>
<li>This method allows you to customize DSpace configurations (in dspace.cfg)
or user interfaces, using basic pre-built interface "overlays".<br>
</li>
<li>It downloads &quot;precompiled&quot; libraries for the core dspace-api, supporting servlets, taglibraries, aspects and themes for the dspace-jspui, dspace-xmlui and other webservice/applications.<br>
</li>
<li>This approach exposes the parts of the application that the DSpace commiters would prefer to see customized. All other modules are downloaded from the 'Maven Central Repository'.</li>
</ul>
<blockquote>
<p>The directory structure for this release is the following:</p>
<ul>
<li><code><i>[dspace-source]</i></code>
<ul>
<li><code>dspace/</code> - DSpace 'build' and configuration module</li>
<li><code>pom.xml</code> - DSpace Parent Project definition<strong><br>
<br>
</strong></li>
</ul>
</li>
</ul>
</blockquote>
</li>
<li><A name="sourceRelease">Source Release ( dspace-&lt;version&gt;-src-release.zip )</A>
<br>
<br>
<ul>
<li><strong>This method is recommended for those who wish to develop DSpace further or alter its underlying capabilities to a greater degree.</strong><br>
<br>
</li>
<li>It contains &quot;all&quot; dspace code for the core dspace-api, supporting servlets, taglibraries, aspects and themes for the dspace-jspui, dspace-xmlui and other webservice/applications.<br>
<br>
</li>
<li>Provides all the same capabilities as the normal release.</li>
</ul>
<blockquote>
<p>The directory structure for this release is more detailed:</p>
<ul>
<li><code><i>[dspace-source]</i></code>
<ul>
<li><code>dspace/</code> - DSpace 'build' and configuration module</li>
<li><code>dspace-api/</code> - Java API source module</li>
<li><code>dspace-jspui/</code> - JSP-UI source module</li>
<li><code>dspace-oai/</code> - OAI-PMH source module</li>
<li><code>dspace-xmlui/</code> - XML-UI source module</li>
<li><code>dspace-lni/</code> - Lightweight Network Interface source module</li>
<li><code>dspace-sword/</code> - Sword deposit service source module</li>
<li><code>pom.xml</code> - DSpace Parent Project definition</li>
</ul>
</li>
</ul>
<p>&nbsp;</p>
</blockquote>
</li>
</ul>
<p>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.</p>
<H3><A NAME="directories">Overview of DSpace Directories</A></H3>
<p>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.)</p>
<p>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:<p>
<ol>
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:
<ol>
<li><strong>the installation directory</strong>, referred to as <i><code>[dspace]</code></i>. This is the location where
all the DSpace configuration files, command line scripts, documentation and webapps exist.</li>
DSpace is installed and running off of it is the location that gets defined in the dspace.cfg as &quot;dspace.dir&quot;. It is where all the DSpace configuration files, command line scripts, documentation and webapps will be installed to.<br>
<br>
</li>
<li><strong>the source directory</strong>, referred to as <i><code>[dspace-source]</code></i>. This is the location
where DSpace was initially downloaded to.</li>
where the DSpace release distribution has been unzipped into. It usually has the name of the archive that you expanded such as <em>dspace-&lt;version&gt;-release</em> or<em> dspace-&lt;version&gt;-src-release</em>. It is the directory where all of your &quot;build&quot; commands will be run.<br>
<br>
</li>
<li><strong>the web deployment directory</strong>. This is the directory that contains
your DSpace web application(s). In DSpace 1.5.x and above, this corresponds
to <i><code>[dspace]/webapps</code></i> 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
<em>Note that the <code>[dspace-source]</code> and <code>[dspace]</code> directories are always separate!</em></p>
<H3><A NAME="installsteps">Quick Installation Method</A></H3>
<H3><A NAME="installsteps">Installation</A></H3>
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 <A href="#maveninstall">Maven-based Installation Method</A> instead.
This method gets you up and running with DSpace quickly and easily. It is identical in both the <a href="#defaultRelease">Default Release</a> and <A href="#sourceRelease">Source Release</A> distributions.
<ol>
<li>
@@ -200,21 +222,15 @@ of them in order to install DSpace, you do need to know they exist and also know
<PRE>useradd -m dspace</PRE>
</li>
<li>
<P>Download the <A HREF="http://sourceforge.net/projects/dspace/">latest DSpace release</A> and unpack it.
Although there are two available releases (<code>dspace-1.x.tar.gz</code> and <code>dspace-1.x-src.tar.gz</code>),
<li>Download the <A HREF="http://sourceforge.net/projects/dspace/">latest DSpace release</A> and unpack it.
Although there are two available releases (<code>dspace-1.x-release.zip</code> and <code>dspace-1.x-src-release.zip</code>),
you only need to choose one. If you want a copy of all underlying Java source code, you should download
the <code>dspace-1.x-src.tar.gz</code> release.
</P>
<PRE>gunzip -c dspace-1.x.tar.gz | tar -xf -</PRE>
the <code>dspace-1.x-src-release.zip</code> release.
<PRE>unzip dspace-1.x-release.zip</PRE>
<P>For ease of reference, we will refer to the location of this unzipped version
of the DSpace release as <code><i>[dspace-source]</i> in the
remainder of these instructions.</code>
</P>
remainder of these instructions.</code> </P>
</li>
<li>
@@ -222,8 +238,8 @@ of them in order to install DSpace, you do need to know they exist and also know
<p><strong>Postgres: </strong>
<ol type="i">
<li>
<p><a name="pgdriver"></a>Copy the PostgreSQL JDBC driver (<code>.jar</code> file) into
<code><i>[dspace-source]</i>/dspace/lib</code>. If you compiled PostgreSQL yourself, it'll be in <code>postgresql-7.x.x/src/interfaces/jdbc/jars/postgresql.jar</code>. Alternatively you can download it directly from <a href="http://jdbc.postgresql.org/download.html">the PostgreSQL JDBC site</a>. Make sure you get the recommended driver for the version of PostgreSQL you're running.</p></li>
<p><a name="pgdriver"></a> 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.</p>
</li>
<li>
<p>Create a <code>dspace</code> database, owned by the <code>dspace</code> PostgreSQL user:</p>
@@ -236,11 +252,15 @@ createdb -U dspace -E UNICODE dspace</pre>
<p><strong>Oracle:</strong>
<ol type="i">
<li>
<p>Copy the Oracle JDBC driver into <code><i>[dspace-source]</i>/dspace/lib</code>.</p>
</li>
<li>
<p>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: <a href="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html">http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201.html</a><br>
<br>
<code>$ mvn install:install-file -Dfile=ojdbc14.jar -DgroupId=com.oracle \<br>
-DartifactId=ojdbc14 -Dversion=10.2.0.2.0 -Dpackaging=jar -DgeneratePom=true</code><br>
</p>
</li>
<li>
<p>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. <code>dspace</code>,) and ensure that it has permissions to add and remove tables in the database.</p>
</li>
</li>
<li>
<p>Edit the <code><i>[dspace-source]</i>/dspace/config/dspace.cfg</code> database settings:</p>
<pre>db.name = oracle
@@ -249,51 +269,54 @@ db.driver = oracle.jdbc.OracleDriver</pre>
</li>
<li>
<p>Go to <code><i>[dspace-source]</i>/dspace/etc/oracle</code> and copy the contents to their parent directory, overwriting the versions in the parent:
<pre>cd [dspace-source]/dspace/etc/oracle
cp * ..</pre>
<p>You now have Oracle-specific <code>.sql</code> files in your <code>etc</code> directory, and your dspace.cfg is modified to point to your Oracle database.</p>
</li>
</ol></p>
</ol>
</p>
</li>
<li>
<P>Edit <code><i>[dspace-source]</i>/dspace/config/dspace.cfg</code>, in particular you'll need to set these properties:
<li>Edit <code><i>[dspace-source]</i>/dspace/config/dspace.cfg</code>, in particular you'll need to set these properties:
<br><code>dspace.dir</code> -- must be set to the <code>[dspace]</code> (installation) directory.
<br>
<code>dspace.dir</code> -- must be set to the <code>[dspace]</code> (installation) directory.
<br><code>dspace.url</code> -- complete URL of this server's DSpace home page.
<br>
<code>dspace.url</code> -- complete URL of this server's DSpace home page.
<br><code>dspace.hostname</code> -- fully-qualified domain name of web server.
<br>
<code>dspace.hostname</code> -- fully-qualified domain name of web server.
<br><code>dspace.name</code> -- "Proper" name of your server, e.g. "My Digital Library".
<br>
<code>dspace.name</code> -- "Proper" name of your server, e.g. "My Digital Library". <br>
<code>db.password</code> -- the database password you entered in the previous step.
<br><code>db.password</code> -- the database password you entered in the previous step.
<br>
<code>mail.server</code> -- fully-qualified domain name of your outgoing mail server.
<br><code>mail.server</code> -- fully-qualified domain name of your outgoing mail server.
<br>
<code>mail.from.address</code> -- the "From:" address to put on email sent by DSpace. <br>
<code>feedback.recipient</code> -- mailbox for feedback mail.
<br><code>mail.from.address</code> -- the "From:" address to put on email sent by DSpace.
<br>
<code>mail.admin</code> -- mailbox for DSpace site administrator.
<br><code>feedback.recipient</code> -- mailbox for feedback mail.
<br><code>mail.admin</code> -- mailbox for DSpace site administrator.
<br><code>alert.recipient</code> -- mailbox for server errors/alerts (not essential but very useful!)
<br><code>registration.notify</code> -- mailbox for emails when new users register (optional)
<br>
<code>alert.recipient</code> -- mailbox for server errors/alerts (not essential but very useful!)
<br>
<code>registration.notify</code> -- mailbox for emails when new users register (optional)
<p>
<b>NOTE:</b> You can interpolate the value of one configuration variable
in the value of another one. For example, to set <code>feedback.recipient</code>
to the same value as <code>mail.admin</code>, the line would look like:
<pre> feedback.recipient = ${mail.admin}</pre>
See the <code>dspace.cfg</code> file for examples.
See the <code>dspace.cfg</code> file for examples. <br>
<br>
</li>
<li>
<P>Create the directory for the DSpace installation (i.e. <code>[dspace]</code>). As <em>root</em> (or a user with appropriate permissions), run:</P>
<li>Create the directory for the DSpace installation (i.e. <code>[dspace]</code>). As <em>root</em> (or a user with appropriate permissions), run:
<PRE>mkdir <i>[dspace]</i>
chown dspace <i>[dspace]</i></PRE>
@@ -303,13 +326,16 @@ chown dspace <i>[dspace]</i></PRE>
<li>
<P>As the <code>dspace</code> UNIX user, generate the DSpace installation package in the <code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir/</code> directory:</P>
<pre>cd <i>[dspace-source]</i>/dspace/
mvn package</pre>
<P>Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you want to use Oracle instead,
<P>Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. <br>
<br>
If you want to use Oracle instead,
you should build the DSpace installation package as follows:</P>
<PRE>mvn -Ddb.name=oracle package</PRE>
<PRE>mvn -Ddb.name=oracle package
</PRE>
<li>
<P>As the <code>dspace</code> UNIX user, initialize the DSpace database and install DSpace to <code><i>[dspace]</i></code>:</P>
@@ -338,18 +364,13 @@ ant fresh_install</pre>
<PRE>cp -r <i>[dspace]</i>/webapps/dspace-jspui <i>[tomcat]</i>/webapps
cp -r <i>[dspace]</i>/webapps/dspace-oai <i>[tomcat]</i>/webapps</PRE>
</li>
<LI>
<p>Create an initial administrator account:</p>
<LI>Create an initial administrator account:
<pre><i>[dspace]</i>/bin/create-administrator</pre>
</LI>
<LI>
<P>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!</P>
<LI>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!
<P>Base URLs of DSpace Web Applications:</P>
<UL>
<li><em>JSP User Interface</em> - (e.g.) http://dspace.myu.edu:8080/dspace-jspui</li>
@@ -359,84 +380,9 @@ cp -r <i>[dspace]</i>/webapps/dspace-oai <i>[tomcat]</i>/webapps</PRE>
</LI>
</ol>
<p>In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which you created with <code>create-administrator</code> above) and access the administration UI in either the JSP or XML user interface.</P>
<p>In order to set up some communities and collections, you'll need to login as your DSpace Administrator (which you created with <code>create-administrator</code> above) and access the administration UI in either the JSP or XML user interface.</P>
<H3><A NAME="maveninstall">Maven-based Installation Method</A></H3>
<P>This method allows you to build your own custom version of DSpace using <A HREF="http://maven.apache.org/">Apache Maven 2</A>.
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 <A href="#installsteps">Quick Installation Method</A> instead.</P>
<P><strong>Additional Prerequisites</strong>
<ul>
<li><A href="http://subversion.tigris.org/">Subversion (SVN)</A> - Necessary to checkout the DSpace source code from SourceForge SVN</li>
</ul>
</P>
<P><strong>Build &amp; Install Steps</strong>
<ol>
<li>
<P>Create the DSpace user. This needs to be the same user that Tomcat (or Jetty etc) will run as. e.g. as root run:</P>
<PRE>useradd -m dspace</PRE>
</li>
<li>
<P>Create the source directory for the DSpace modules to reside (i.e. <code>[dspace-source]</code>). As <em>root</em> (or a user with appropriate permissions), run:</P>
<PRE>mkdir <i>[dspace-source]</i>
chown dspace <i>[dspace-source]</i></PRE>
<P>(Assuming the <code>dspace</code> UNIX username.)</P>
</li>
<li>
<P>Checkout the DSpace Source code from SourceForge SVN into <code>[dspace-source]</code>. For example:</P>
<PRE>svn co https://dspace.svn.sourceforge.net/svnroot/dspace/tags/dspace-1_5 [dspace-source]</PRE>
<P>If you wish, you can choose to <em>only</em> checkout the source code for the specific DSpace "modules"
which you want to install. However, you must <em>always</em> checkout the <code>'dspace'</code> 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:</P>
<PRE>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]
</PRE>
<P>In order, you are checking out the <code>'dspace'</code> module (builds DSpace),
<code>'dspace-xmlui'</code> module (provides XML-UI), and <code>'dspace-oai'</code> module (provides OAI-PMH).</P>
<P>In the end, you should have a folder structure similar to the following in <code><i>[dspace-source]</i></code>:
<ul>
<li><code><i>[dspace-source]</i></code>
<ul>
<li><code>dspace/</code> - DSpace 'build' and configuration module</li>
<li><code>dspace-api/</code> - DSpace Java API module</li>
<li><code>dspace-jspui/</code> - DSpace JSP-UI module</li>
<li><code>dspace-oai/</code> - DSpace OAI-PMH interface module</li>
<li><code>dspace-xmlui/</code> - DSpace XML-UI module</li>
</ul>
</li>
</ul>
</li>
<li>
<P>Note: Although we won't go into this in detail, you can also create your own
completely custom Maven-based modules in your <code><i>[dspace-source]</i></code> directory.
To build your custom modules into DSpace, you would need to modify the <code>'dspace'</code>
module's <code>pom.xml</code> (Project Object Model) to look for those custom modules, and
then re-build your DSpace installation package. Look
at the <a href="http://maven.apache.org/">Maven Documentation</a> or
<a href="http://wiki.dspace.org/">DSpace Wiki</a> for more hints and tricks.</P>
</li>
<li><P>Once you've downloaded the appropriate DSpace modules into <code><i>[dspace-source]</i></code>, you can follow the steps in the
<A href="#installsteps">Quick Installation Method</A> above to finish installing and configuring DSpace.
Just remember that you can <em>skip</em> downloading the Latest DSpace Release from
SourceForge, as you've already downloaded it via Maven.</P>
</li>
</ol>
</P>
<P><strong>Useful Maven References</strong>
<P><strong>Useful Maven References</strong>
<ul>
<li><A HREF="http://maven.apache.org/">Maven Homepage</A> - The place to go for all things Maven...it also includes links to the below resources.</li>
<li><A HREF="http://maven.apache.org/users/">Maven User Centre</A> - Basic documentation and Tutorials for Maven. Also has a Project Object Model (POM) reference.</li>
@@ -786,8 +732,8 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
<li><p><a href="http://java.sun.com/">Java SDK 1.5</a> or later (standard SDK is fine, you don't need J2EE)</p></li>
<li><p><a href="http://www.postgresql.org/ftp/">PostgreSQL 8.x for Windows</a>. 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<p></li>
<li><p><a href="http://ant.apache.org/">Apache Ant 1.6.x</a>. Unzip the package in <code>C:\</code> and add <code>C:\apache-ant-1.6.2\bin</code> to the <code>PATH</code> environment variable. For Ant to work properly, you should ensure that <code>JAVA_HOME</code> is set.</p></li>
<li><p><a href="http://tomcat.apache.org/">Jakarta Tomcat 5.x+<p></a>
</ul></p>
<li><p><a href="http://tomcat.apache.org/">Jakarta Tomcat 5.x+<p>
</a></ul></p>
<h3>Installation Steps</h3>
@@ -797,8 +743,10 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
<li><p>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:
<ul>
<li>Create a 'Login Role' (user) called <code>dspace</code> with the password <code>dspace</code></li>
<li>Create a database called <code>dspace</code> owned by the user <code>dspace</code>, with UTF-8 encoding
</ul></p></li>
<li>Create a database called <code>dspace</code> owned by the user <code>dspace</code>, with UTF-8 encoding <br>
<br>
</ul>
</p></li>
<li><p>Update paths in <code>[dspace-source]\dspace\config\dspace.cfg</code>. <strong>Note:</strong> Use forward slashes / for path separators, though you can still use drive letters, e.g.:
<p><code>dspace.dir = C:/DSpace</code><p>
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</pre></p></p>
</li>
<li><p>Create the directory for the DSpace installation (e.g. <code>C:\DSpace</code>)</p></li>
<li><p>Run:<p><code>ant fresh_install</code></p></p></li>
<li><p>Create an administrator account, e.g. assuming <code>C:\dspace</code> is where your DSpace installation is:<p><code>C:\dspace\bin\dsrun org.dspace.administer.CreateAdministrator</code></p>
<li>Generate the DSpace installation package in the <code><i>[dspace-source]</i>/dspace/target/dspace-[version].dir/</code> directory:
<pre>cd <i>[dspace-source]</i>/dspace/
mvn package</pre>
<P>Note: without any extra arguments, the DSpace installation package is initialized for PostgreSQL. <br>
<br>
If you want to use Oracle instead,
you should build the DSpace installation package as follows:</P>
<PRE>mvn -Ddb.name=oracle package
</PRE>
<li>
<P>As the <code>dspace</code> UNIX user, initialize the DSpace database and install DSpace to <code><i>[dspace]</i></code>:</P>
<pre>cd <i>[dspace-source]</i>/dspace/target/dspace-[version].dir/
ant fresh_install</pre>
<P><strong>Note:</strong> to see a complete list of build targets, run</P>
<pre>ant help</pre>
</li>
<li><p>Create an administrator account, e.g. assuming <code>C:\dspace</code> is where your DSpace installation is:
<p><code><em>[dspace]</em>\bin\dsrun org.dspace.administer.CreateAdministrator</code></p>
<p>and enter the required information</p></p></li>
<li><p>Copy the Web application directories from <code>[dspace]\webapps\</code> to Tomcat's webapps dir, which should be somewhere like <code>C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps</code></p>
<ul>
@@ -834,7 +800,8 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
</li>
<li><p>Start the Tomcat service</p></li>
<li><p>Browse <code>http://localhost:8080/dspace</code>. You should see the DSpace home page</p></li>
</ol></p>
</ol>
</p>
<H2><A NAME="checking">Checking Your Installation</A></H2>

2
dspace/docs/introduction.html
View File

@@ -49,7 +49,7 @@
<HR>
<ADDRESS>
Copyright &copy; 2002-2005 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>

2
dspace/docs/storage.html
View File

@@ -254,7 +254,7 @@ srb.parentdir.1 = mysrbdspaceassetstore
<hr>
<address>
Copyright &copy; 2002-2005 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</address>
</body>
</html>

2
dspace/docs/submission.html
View File

@@ -715,7 +715,7 @@
<HR>
<ADDRESS>
Copyright &copy; 2002-2007 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>

2
dspace/docs/update.html
View File

@@ -893,7 +893,7 @@ ant -Dconfig=<i>[dspace]</i>/config/dspace.cfg update</PRE></LI>
<HR>
<ADDRESS>
Copyright &copy; 2002-2004 MIT and Hewlett Packard
Copyright &copy; 2002-2008 The DSpace Foundation
</ADDRESS>
</BODY>
</HTML>