All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
Create the DSpace user. This needs to be the same user that Tomcat (or Jetty etc.) will run as. e.g. as root run:
Code Block |
---|
useradd -m dspace |
Zip file. If you downloaded dspace-5.x-release.zip do the following:
Code Block |
---|
unzip dspace-5.x-release.zip |
.gz file. If you downloaded dspace-5.x-release.tar.gz do the following:
Code Block |
---|
gunzip -c dspace-5.x-release.tar.gz | tar -xf - |
.bz2 file. If you downloaded _dspace-5.x-release.tar.bz do the following:
Code Block |
---|
bunzip2 dspace-5.x-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 wish to change the ownership of the dspace-5.x-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 (you are still logged in as "root"):
Code Block |
---|
createuser --username=postgres --no-superuser --pwprompt dspace |
You will be prompted (twice) for a password for the new dspace
user. Then you'll be prompted for the password of the PostgreSQL superuser (postgres
).
Create a dspace
database, owned by the dspace
PostgreSQL user (you are still logged in as 'root'):
Code Block |
---|
createdb --username=postgres --owner=dspace --encoding=UNICODE dspace |
You will be prompted for the password of the PostgreSQL superuser (postgres
).
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 a lib directory you will need to install it into your local Maven repository. (You'll need to download it first from this location: http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html.) Run the following command (all on one line):
Code Block |
---|
mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.4.0 -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.xml E.g.:
Code Block | ||
---|---|---|
| ||
<dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.4.0</version> </dependency> |
Uncomment and edit the Oracle database settings in [dspace-source]/build.properties (see below for more information on the build.properties file):
Code Block |
---|
db.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:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE))) |
[dspace-source]/build.properties
. This properties file contains the basic settings necessary to actually build/install DSpace for the first time (see build.properties Configuration for more detail). In particular you'll need to set these properties -- examples or defaults are provided in the file:dspace.install.dir
- must be set to the [dspace] (installation) directory (On Windows be sure to use forward slashes for the directory path! For example: "C:/dspace" is a valid path for Windows.)dspace.hostname
- fully-qualified domain name of web server.dspace.baseUrl
- complete URL of this server's DSpace home page but without any context eg. /xmlui, /oai, etc.dspace.name
- "Proper" name of your server, e.g. "My Digital Library".solr.server
- complete URL of the Solr server. DSpace makes use of Solr for indexing purposes. default.language
db.driver
db.url
db.username
- the database username used in the previous step.db.password
- the database password used 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.mail.feedback.recipient
- mailbox for feedback mail.mail.admin
- mailbox for DSpace site administrator.mail.alert.recipient
- mailbox for server errors/alerts (not essential but very useful!)mail.registration.notify
- mailbox for emails when new users register (optional)
Info |
---|
The "build.properties" file is provided as a convenient method of setting only those configurations necessary to install/upgrade DSpace. Any settings changed in this file, will be automatically copied over to the full "dspace.cfg" file (which is held in It is also worth noting that you may choose to copy/rename the "build.properties" under a different name for different environments (e.g. "development.properties", "test.properties", and "production.properties"). You can choose which properties file you want to build DSpace with by passing a "-Denv" (environment) flag to the "mvn package" command (e.g. "mvn package -Denv=test" would build using "test.properties). See General Configuration section for more details. |
Warning | ||
---|---|---|
| ||
When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings. Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting. Instead, if you wish to remove/disable a particular setting, just clear out its value. For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g.
|
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.)
Build the Installation Package: As the dspace UNIX user, generate the DSpace installation package.
Code Block |
---|
cd [dspace-source] 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: |
Info | ||
---|---|---|
| ||
Mirage 2 is a responsive theme for the XML User Interface, added as a new feature in DSpace 5. It has not yet replaced the Mirage 1 theme as the XMLUI default theme. To enable Mirage 2, add the following to the <theme name="Mirage 2" regex=".*" path="Mirage2/" /> It is important to do this before executing the maven build. Mirage 2 is not yet activated in the default "mvn package" build. To include it as part of the build, run: mvn package -Dmirage2.on=true The speed of this specific step of the build can be increased by installing local copies of the specific dependencies required for building Mirage 2. The Mirage 2 developer documentation provides detailed instructions for these installations. After the installation of these dependencies, you can choose to run: mvn package -Dmirage2.on=true -Dmirage2.deps.included=false |
Info | ||
---|---|---|
| ||
Without any extra arguments, the DSpace installation package will be initialized using the settings in the
See General Configuration section for more details. |
Install DSpace: As the dspace UNIX user, install DSpace to [dspace]
:
Code Block |
---|
cd [dspace-source]/dspace/target/dspace-installer ant fresh_install |
Info |
---|
To see a complete list of build targets, run: |
Decide which DSpace Web Applications you want to install. DSpace comes with a variety of web applications (in [dspace]/
webapps), each of which provides a different "interface" to your DSpace. Which ones you install is up to you, but there are a few that we highly recommend (see below):
"xmlui" = This is the XML-based User Interface, based on Apache Cocoon. It comes with a variety of out-of-the-box themes, including Mirage 1 (the default) and Mirage 2 (based on Bootstrap). Between the "xmlui" and "jspui", you likely only need to choose one.
"jspui" = This is the JSPUI-based User Interface, which is based on Bootstrap. Between the "xmlui" and "jspui", you likely only need to choose one.
"solr" (required) = This is Apache Solr web application, which is used by both the "xmlui" and "jspui" for search & browse functionality. It must be installed in support of either UI.
mvn package -Pdspace-lni
Anchor | ||||
---|---|---|---|---|
|
Technique A. Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the directory [tomcat]/conf/Catalina/localhost
you could add files similar to the following (but replace [dspace]
with your installation location):
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/xmlui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/jspui" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
Code Block | ||
---|---|---|
| ||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/solr" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/oai" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
Code Block | ||
---|---|---|
| ||
<?xml version='1.0'?> <!-- CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context docbasedocBase="[dspace]/webapps/[app]" debug="0" reloadable="true" cachingAllowed="false" allowLinking="true"/> |
The name of the file (not including the suffix ".xml") will be the name of the context, so for example xmlui.xml
defines the context at http://host:8080/xmlui
. To define the root context (http://host:8080/
), name that context's file ROOT.xml
.
Note | ||
---|---|---|
| ||
The above Tomcat Context Settings show adding the following to each reloadable="true" cachingAllowed="false" These settings are extremely useful to have when you are first getting started with DSpace, as they let you tweak the DSpace XMLUI (XSLTs or CSS) or JSPUI (JSPs) and see your changes get automatically reloaded by Tomcat (without having to restart Tomcat). However, it is worth noting that the Apache Tomcat documentation recommends Production sites leave the default values in place ( It is entirely up to you whether to keep these Tomcat settings in place. We just recommend beginning with them, so that you can more easily customize your site without having to require a Tomcat restart. Smaller DSpace sites may not notice any performance issues with keeping these settings in place in Production. Larger DSpace sites may wish to ensure that Tomcat performance is more streamlined. |
cp -R [dspace]/webapps/* [tomcat]/webapps*
(This will copy all the web applications to Tomcat). cp -R [dspace]/webapps/jspui [tomcat]/webapps*
(This will copy only the jspui web application to Tomcat.)Initialize the DSpace Database (optional): While this step is optional (as the DSpace database will auto-initialize itself on first startup), it's always good to verify one last time that your database connection is working properly. To initialize the database run: (for more information on "database migrate" see Database Utilities)
Code Block |
---|
[dspace]/bin/dspace database migrate |
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)...