All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Since some users might want to get their test version up and running as fast as possible, offered below is an unsupported outline of getting DSpace to run quickly in a Unix-based environment using the DSpace source release.
Warning |
---|
Only experienced unix admins should even attempt the following without going to the detailed Installation Instructions |
Code Block |
---|
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
ant fresh_install
cp -r [dspace]/webapps/* [tomcat]/webapps
/etc/init.d/tomcat start
[dspace]/bin/dspace create-administrator |
...
Warning | ||
---|---|---|
| ||
DSpace does not currently support Java 7, as there is a known issue with Java 7 and Lucene/SOLR (which DSpace uses for search & browse functionality). For more details, see this article on the Apache site: "WARNING: Index corruption and crashes in Apache Lucene Core / Apache Solr with Java 7" as well as this Java bug report: 7073868 |
Note | ||
---|---|---|
| ||
Only Oracle's Java has been tested with each release and is known to work correctly. Other flavors of Java may pose problems. |
...
Note | ||
---|---|---|
| ||
DSpace 1.7.x required usage of Maven 2.2.x, as it did not build properly when using Maven 2.0.x or Maven 3.x. This was a known issue (see DS-788). However, DSpace 1.8.x resolved this issue so that DSpace now builds properly with Maven 2.2.x or above. |
...
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 existing 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 following location: http://maven.apache.org/download.html
...
...
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_ 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
...
...
Wiki Markup |
---|
You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your Oracle version - update the version in _\[dspace-source\]/pom.xml_ E.g.: |
Code Block |
---|
<dependency>
<groupId>com.oracle</groupId>
<artifactId>ojdbc6</artifactId>
<version>11.2.0.3</version>
</dependency>
|
Wiki Markup |
---|
You need to set the following in _\[dspace\]/config/dspace.cfg_ (or its _\[dspace-src\]_ equivalent): |
Code Block |
---|
db.driver = oracle.jdbc.OracleDriver
db.url = jdbc:oracle:thin:@database.host:1521/SID
|
Code Block |
---|
db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE)))
|
Code Block |
---|
db.username = your_oracle_username
db.password = your_oracle_password
|
...
...
Modifications
in
* *_\[tomcat
\]/conf/server.xml
{_}*:
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:
Code Block |
---|
<!-- 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"/>
|
You may change the port from 8080 by editing it in the file above, and by setting the variable CONNECTOR_PORT in server.xml.
...
...
...
...
...
...
...
...
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:
...
[dspace
\]
}}. This is the location where 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.[dspace-source
\]
}} . This is the location 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
}}. Normally it is the directory where all of your "build" commands will be run. [dspace
\]/webapps
}} by default. However, if you are using Tomcat, you may decide to copy your DSpace web applications from {{\applications from [dspace
\]/webapps/
}} to {{\[tomcat
\]/webapps/
}} (with {{\[tomcat
\]
}} being wherever you installed Tomcat‚ also known as {{$CATALINA_HOME
}}).
[dspace-source
\]
}} _and_ {{\[dspace
\]
}} _directories are always separate\!_This method gets you up and running with DSpace quickly and easily. It is identical in both the Default Release and Source Release distributions.
Create the DSpace user. This needs to be the same user that Tomcat (or Jetty etc.) will run as. e.g. as rootrun:
Code Block |
---|
useradd -m dspace |
Zip file. If you downloaded dspace-1.8-release.zipdo the following:
Code Block |
---|
unzip dspace-1.8-release.zip |
.gz file. If you downloaded dspace-1.8-release.tar.gzdo the following:
Code Block |
---|
gunzip -c dspace-1.8-release.tar.gz | tar -xf - |
.bz2 file. If you downloaded _dspace-1.8-release.tar.bz2_do the following:
Code Block |
---|
bunzip2 dspace-1.8-release.tar.bz | tar -xf - |
- |
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).
Create a dspace
database user. This is entirely separate from the dspace
operating-system user created above.
Code Block |
---|
createuser -U postgres -d -A -P dspace |
You will be prompted for the password of the PostgreSQL superuser (postgres
). Then you'll be prompted (twice) for a password for the new dspace
user.
Create a dspace
database, owned by the dspace
PostgreSQL user (you are still logged in at 'root'):
Code Block |
---|
createdb -U dspace -E UNICODE dspace |
You will be prompted for the password of the DSpace database user. (This isn't the same as the dspace user's UNIX password.)
Setting up DSpace to use Oracle is a bit different now. You will need still need to get a copy of the Oracle JDBC driver, but instead of copying it into
athe lib directory you will need to install it into your local Maven repository. (You'll need to download it first from this location: http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html.) Run the following command (all on one line):
Code Block |
---|
mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.3 -Dversion=11-Dpackaging=jar -DgeneratePom=true |
You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your Oracle version - update the version in [dspace-source]/pom.xmlE.g.:
Code Block |
---|
<dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.2.0 -Dpackaging=jar -DgeneratePom=true3</version> </dependency> |
Edit
the
_\[dspace-source
\]/dspace/config/dspace.cfg
_database
settings:
Code Block |
---|
db.name = oracle db.name = oracle db.url driver = oracle.jdbc.OracleDriver db.url = jdbc:oracle:thin:@host:port/SID |
Where SID is the SID of your database defined in tnsnames.ora, default Oracle port is 1521.
Alternatively, you can use a full SID definition, e.g.:
Code Block |
---|
db.url = jdbc:oracle:thin:@//host:port/dspace db.driver = oracle.jdbc.OracleDriver (description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE))) |
Also set the username and password of the database you created in step 3:
Code Block |
---|
db.username = your_oracle_username
db.password = your_oracle_password
|
[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)
Info |
---|
You can interpolate the value of one configuration variable in the value of another one. For example, to set feedback.recipient to the same value as mail.admin, the line would look like: |
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.)
Installation Package: As the dspaceUNIX user, generate the DSpace installation package.
Code Block |
---|
cd [dspace-source]/dspace/
mvn package
|
Info | ||
---|---|---|
| ||
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: | ||
* |
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 ant fresh_install |
Info |
---|
To see a complete list of build targets, run: |
Anchor | ||||
---|---|---|---|---|
|
cp -R
\ [dspace
\]/webapps/
\*
\ [tomcat
\]/webapps
\*
}} (This will copy all the web applications to Tomcat).
\\
{{cp \cp -R
\ [dspace
\]/webapps/jspui
\ [tomcat
\]/webapps
\*
}} (This will copy only the jspui web application to Tomcat.)unmigrated-wiki-markupTechnique
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" .... |
Administrator Account:Create an initial administrator account:
Code Block |
---|
[dspace]/bin/dspace create-administrator |
http://dspace.myu.edu:8080/jspui
http://dspace.myu.edu:8080/xmlui
http://dspace.myu.edu:8080/oai/request?verb=Identify
(Should return an XML-based response)...
In order to deploy a multilingual version of DSpace you have to configure two parameters in _\[dspace-source\]/config/dspace.cfg:_ Wiki Markup
default.locale = en
webui.supported.locales = en, de
...
The following sections show how to set up the most commonly-used Java Servlet containers to support HTTP over SSL.
...
...
Create a Java keystore for your server with the password changeit, and install your server certificate under the alias "tomcat". This assumes the certificate was put in the file server.pem:
Code Block |
---|
$JAVA_HOME/bin/keytool -import -noprompt -v -storepass changeit -keystore $CATALINA_BASE/conf/keystore -alias tomcat -file myserver.pem |
Install the CA (Certifying Authority) certificate for the CA that granted your server cert, if necessary. This assumes the server CA certificate is in ca.pem:
Code Block |
---|
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit -trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias ServerCA -file ca.pem |
Optional – ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the configuration section for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in client1.pem:
Code Block |
---|
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit -trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1 -file client1.pem |
Now add another Connector tag to your server.xmlTomcat configuration file, like the example below. The parts affecting or specific to SSL are shown in bold. (You may wish to change some details such as the port, pathnames, and keystore password)
Code Block |
---|
<Connector port="8443" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" disableUploadTimeout="true" acceptCount="100" debug="0" scheme="https" secure="true" sslProtocol="TLS" keystoreFile="conf/keystore" keystorePass="changeit" clientAuth="true" - ONLY if using client X.509 certs for authentication! truststoreFile="conf/keystore" trustedstorePass="changeit" /> |
Also, check that the default Connector is set up to redirect "secure" requests to the same port as your SSL connector, e.g.:
Code Block |
---|
<Connector port="8080" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443" acceptCount="100" debug="0" /> |
Create a new key pair under the alias name "tomcat". When generating your key, give the Distinguished Name fields the appropriate values for your server and institution. CN should be the fully-qualified domain name of your server host. Here is an example:
Code Block |
---|
$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize
1024 \
-keystore $CATALINA_BASE/conf/keystore -storepass changeit
-validity 365 \
-dname 'CN=dspace.myuni.edu, OU=MIT Libraries, O=Massachusetts
Institute of Technology, L=Cambridge, S=MA, C=US'
|
Then, create a CSR (Certificate Signing Request) and send it to your Certifying Authority. They will send you back a signed Server Certificate. This example command creates a CSR in the file tomcat.csr
Code Block |
---|
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-certreq -alias tomcat -v -file tomcat.csr
|
Before importing the signed certificate, you must have the CA's certificate in your keystore as a trusted certificate. Get their certificate, and import it with a command like this (for the example mitCA.pem):
Code Block |
---|
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-import -alias mitCA -trustcacerts -file mitCA.pem
|
Finally, when you get the signed certificate from your CA, import it into the keystore with a command like the following example: (cert is in the file signed-cert.pem)
Code Block |
---|
$JAVA_HOME/bin/keytool -keystore $CATALINA_BASE/conf/keystore
-storepass changeit \
-import -alias tomcat -trustcacerts -file signed-cert.pem
|
Since you now have a signed server certificate in your keystore, you can, obviously, skip the next steps of installing a signed server certificate and the server CA's certificate.
Create a Java keystore for your server with the password changeit, and install your server certificate under the alias "tomcat". This assumes the certificate was put in the file server.pem:
Code Block |
---|
$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore
$CATALINA_BASE/conf/keystore -storepass changeit
|
When answering the questions to identify the certificate, be sure to respond to "First and last name" with the fully-qualified domain name of your server (e.g. test-dspace.myuni.edu). The other questions are not important.
Optional – ONLY if you need to accept client certificates for the X.509 certificate stackable authentication module See the configuration section for instructions on enabling the X.509 authentication method. Load the keystore with the CA (certifying authority) certificates for the authorities of any clients whose certificates you wish to accept. For example, assuming the client CA certificate is in client1.pem:
Code Block |
---|
$JAVA_HOME/bin/keytool -import -noprompt -storepass changeit
-trustcacerts -keystore $CATALINA_BASE/conf/keystore -alias client1
-file client1.pem
|
...
...
If you choose Apache HTTPD as your primary HTTP server, you can have it forward requests to the Tomcat servlet container via Apache Jakarta Tomcat Connector. This can be configured to work over SSL as well. First, you must configure Apache for SSL; for Apache 2.0 see Apache SSL/TLS Encryption for information about using mod_ssl.
If you are using X.509 Client Certificates for authentication: add these configuration options to the appropriate httpd configuration file, e.g. ssl.conf, and be sure they are in force for the virtual host and namespace locations dedicated to DSpace:
Code Block |
---|
## SSLVerifyClient can be "optional" or
"require"
SSLVerifyClient optional
SSLVerifyDepth 10
SSLCACertificateFile
path-to-your-client-CA-certificate
SSLOptions StdEnvVars ExportCertData
|
...
A Handle server runs as a separate process that receives TCP requests from other Handle servers, and issues resolution requests to a global server or servers if a Handle entered locally does not correspond to some local content. The Handle protocol is based on TCP, so it will need to be installed on a server that can broadcast and receive TCP on port 2641.
To configure your DSpace installation to run the handle server, run the following command:
Code Block |
---|
[dspace]/bin/dspace make-handle-config [dspace]/handle-server |
Ensure
that
_\[dspace
\]/handle-server
_matches
whatever
you
have
in
_dspace.cfg
_for
the
_handle.dir
_property.
Edit
the
resulting
_\[dspace
\]/handle-server/config.dct
_file
to
include
the
following
lines
in
the
_"server_config"
_clause:
Code Block |
---|
"storage_type" = "CUSTOM" "storage_class" = "org.dspace.handle.HandlePlugin" |
This tells the Handle server to get information about individual Handles from the DSpace code.
Now start your handle server (as the dspace user):
Code Block |
---|
[dspace]/bin/start-handle-server |
Note that since the DSpace code manages individual Handles, administrative operations such as Handle creation and modification aren't supported by DSpace's Handle server.
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: Wiki Markup
Code Block |
---|
[dspace]/bin/dspace update-handle-prefix 123456789 1303 |
...
Sitemaps allow DSpace to expose its content without the crawlers having to index every page. HTML sitemaps provide a list of all items, collections and communities in HTML format, whilst Google sitemaps provide the same information in gzipped XML format.unmigrated-wiki-markup
To generate the sitemaps, you need to run _\[dspace\]/bin/dspace generate-sitemaps_ This creates the sitemaps in _\[dspace\]/sitemaps/_
The sitemaps can be accessed from the following URLs:
...
When running _\[dspace\]/bin/dspace generate-sitemaps_ the script informs Google that the sitemaps have been updated. For this update to register correctly, you must first register your Google sitemap index page (_/dspace/sitemap_) with Google at [http://www.google.com/webmasters/sitemaps/|http://www.google. com/webmasters/sitemaps/|http://www.google.com/webmasters/sitemaps/]. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set _http.proxy.host_ and _http.proxy.port_ in _\[dspace\]/config/dspace.cfg_
The URL for pinging Google, and in future, other search engines, is configured in _\[dspace-space\]/config/dspace.cfg_ using the _sitemap.engineurls_ setting where you can provide a comma-separated list of URLs to 'ping'. Wiki Markup
You can generate the sitemaps automatically every day using an additional cron job:
Code Block |
---|
# Generate sitemaps
0 6 * * * [dspace]/bin/dspace generate-sitemaps
|
...
DSpace uses the Apache Solr application underlaying the statistics. There is no need to download any separate software. All the necessary software is included. To understand all of the configuration property keys, the user should refer to DSpace Statistic Configuration for Statistics for detailed configuration information.
DSpace Configuration for Accessing Solr. In the dspace.cfgfile review the following fields to make sure they are uncommented:
Code Block |
---|
solr.log.server = ${dspace.baseUrl}/solr/statistics solr.dbfile = ${dspace.dir}/config/GeoLiteCity.dat solr.spiderips.urls = http://iplists.com/google.txt, \ http://iplists.com/inktomi.txt, \ http://iplists.com/lycos.txt, \ http://iplists.com/infoseek.txt, \ http://iplists.com/altavista.txt, \ http://iplists.com/excite.txt, \ http://iplists.com/misc.txt, \ http://iplists.com/non_engines.txt |
DSpace logging configuration for Solr. If your DSpace instance is protected by a proxy server, in order for Solr to log the correct IP address of the user rather than of the proxy, it must be configured to look for the X-Forwarded-For header. This feature can be enabled by ensuring the following setting is uncommented in the logging section of dspace.cfg:
Code Block |
---|
useProxies = true |
Perform the following step:
Code Block |
---|
cd [dspace-source]/dspace
mvn package
cd [dspace-source]/dspace/target/dspace-<version>-build
ant -Dconfig=[dspace]/config/dspace.cfg update
cp -R [dspace]/webapps/* [TOMCAT]/webapps
|
Wiki Markup |
If
you
only
need
to
build
the
statistics,
and
don't
make
any
changes
to
other
web
applications,
you
can
replace
the
copy
step
above
with:
_cp
\-R
\[dspace
\]/webapps/solr
\[TOMCAT
\]/webapps
_...
The GeoLite Database file (at \ [dspace\]/config/GeoLiteCity.dat) is used by the [DSpace Statistics|#DSpace Statistics] engine to generate location/country based reports. (_Note: If you are not using DSpace Statistics, this file is not needed._)
In most cases, this file is installed automatically when you run ant fresh_install
. However, if the file cannot be downloaded & installed automatically, you may need to manually install it.
...
You have two options to install/update this file:
...
Attempt
to
re-run
the
automatic
installer
from
your
DSpace
Source
Directory
(
\[dspace-source
\]).
This
will
attempt
to
automatically
download
the
database
file,
unzip
it
and
install
it
into
the
proper
location:
Code Block |
---|
ant update_geolite |
ant
\ -Dgeolite=
\[full-URL-of-geolite
\]
update_geolite
}}[dspace
\]/config/GeoLiteCity.dat
}}....
Note: Use forward slashes / for path separators, though you can still use drive letters, e.g.: dspace.dir = C:/DSpaceAlso, 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 |
Generate the DSpace installation package by running the following from command line (cmd) :
Code Block |
---|
cd [dspace-source]/dspace/
mvn package
|
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 |
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/
_directory:
Code Block |
---|
ant fresh_install |
ant help
Create
an
administrator
account,
by
running
the
following
from
your
_\[dspace
\]
_(e.g.
_C:\DSpace
_)
directory:
Code Block |
---|
[dspace]\bin\dspace create-administrator |
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 XML User Interface -->
<Context path="/xmlui" docBase="[dspace]/webapps/xmlui" debug="0"
reloadable="true" cachingAllowed="false"
allowLinking="true"/>
<!-- 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"/>
<!-- DEFINE ADDITIONAL CONTEXT PATHS FOR OTHER DSPACE WEB APPLICATIONS (SOLR, SWORD, LNI, etc.).
CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD -->
<Context path="/[app]" docbase="[dspace]/webapps/[app]" debug="0"
reloadable="true" cachingAllowed="false"
allowLinking="true"/>
|
...
The administrator needs to check the installation to make sure all components are working. Here is list of checks to be performed. In brackets after each item, it the associated component or components that might be the issue needing resolution.
In any software project of the scale of DSpace, there will be bugs. Sometimes, a stable version of DSpace includes known bugs. We do not always wait until every known bug is fixed before a release. If the software is sufficiently stable and an improvement on the previous release, and the bugs are minor and have known workarounds, we release it to enable the community to take advantage of those improvements.
...
ant fresh_install
: There are two common errors that occur.If your error looks like this:
Code Block |
---|
[java] 2004-03-25 15:17:07,730 INFO org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database [java] 2004-03-25 15:17:08,816 FATAL org.dspace.storage.rdbms.InitializeDatabase @ Caught exception: [java] org.postgresql.util.PSQLException: Connection refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. [java] at org.postgresql.jdbc1.AbstractJdbc1Connection.openConnection(AbstractJd bc1Connection.java:204) [java] at org.postgresql.Driver.connect(Driver.java:139) |
Wiki Markup |
it
usually
means
you
haven't
yet
added
the
relevant
configuration
parameter
to
your
PostgreSQL
configuration
(see
above),
or
perhaps
you
haven't
restarted
PostgreSQL
after
making
the
change.
Also,
make
sure
that
the
_db.username
_and
_db.password
_properties
are
correctly
set
in
_\[dspace
\]/config/dspace.cfg
_.
An
easy
way
to
check
that
your
DB
is
working
OK
over
TCP/IP
is
to
try
this
on
the
command
line:
Code Block |
---|
psql -U dspace -W -h localhost |
Enter the dspace database password, and you should be dropped into the psql tool with a dspace=> prompt.
Another common error looks like this:
Code Block |
---|
[java] 2004-03-25 16:37:16,757 INFO org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database [java] 2004-03-25 16:37:17,139 WARN org.dspace.storage.rdbms.DatabaseManager @ Exception initializing DB pool [java] java.lang.ClassNotFoundException: org.postgresql.Driver [java] at java.net.URLClassLoader$1.run(URLClassLoader.java:198) [java] at java.security.AccessController.doPrivileged(Native Method) [java] at java.net.URLClassLoader.findClass(URLClassLoader.java:186) |
Wiki Markup |
This
means
that
the
PostgreSQL
JDBC
driver
is
not
present
in
_\[dspace
\]/lib
_.
See
above.
ant fresh_install
: There are two common errors that may occur:If your error looks like this:
Code Block |
---|
[get] Error getting http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz to /usr/local/dspace/config/GeoLiteCity.dat.gz BUILD FAILED /dspace-release/dspace/target/dspace-1.8.0-build/build.xml:931: java.net.ConnectException: Connection timed out |
it means that you likely either (a) don't have an internet connection to download the necessary GeoLite Database file (used for DSpace Statistics), or (b) the GeoLite Database file's URL is no longer valid. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.
Another common message looks like this:
Code Block |
---|
[echo] WARNING : FAILED TO DOWNLOAD GEOLITE DATABASE FILE [echo] (Used for DSpace Solr Usage Statistics) |
Again, this means the GeoLite Database file cannot be downloaded or is unavailable for some reason. You should be able to resolve this issue by following the "Manually Installing/Updating GeoLite Database File" instructions above.
ps -ef | grep java
and look for Tomcat's Java processes. If they stay around after running Tomcat's shutdown.sh script, trying running kill
on them (or kill -9
if necessary), then starting Tomcat again.ps -ef | grep postgres
You might see some processes like this:
Code Block |
---|
dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace 127.0.0.1 idle in transaction |
This is normal. DSpace maintains a 'pool' of open database connections, which are re-used to avoid the overhead of constantly opening and closing connections. If they're 'idle' it's OK; they're waiting to be used.
However sometimes, if something went wrong, they might be stuck in the middle of a query, which seems to prevent other connections from operating, e.g.:
Code Block |
---|
dspace 16325 1997 0 Feb 14 ? 0:00 postgres: dspace dspace 127.0.0.1 SELECT |
This means the connection is in the middle of a SELECT operation, and if you're not using DSpace right that instant, it's probably a 'zombie' connection. If this is the case, try running kill
on the process, and stopping and restarting Tomcat.