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 (optional) . As noted in the prerequisites above, Tomcat (or Jetty, etc) must run as an operating system user account that has full read/write access to the DSpace installation directory (i.e. [dspace]
). Either you must ensure the Tomcat owner also owns [dspace]
, OR you can create a new "dspace" user account, and ensure that Tomcat also runs as that account:
Code Block | ||
---|---|---|
| ||
useradd -m dspace |
Zip file. If you downloaded dspace-6.x-release.zip do the following:
Code Block | ||
---|---|---|
| ||
unzip dspace-6.x-release.zip |
.gz file. If you downloaded dspace-6.x-release.tar.gz do the following:
Code Block | ||
---|---|---|
| ||
gunzip -c dspace-6.x-release.tar.gz | tar -xf - |
.bz2 file. If you downloaded _dspace-6.x-release.tar.bz do the following:
Code Block | ||
---|---|---|
| ||
bunzip2 dspace-6.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-6.x-release to the "dspace" user. (And you may need to change the group).
Create a dspace
database user (this user can have any name, but we'll assume you name them "dspace"). This is entirely separate from the dspace
operating-system user created above:
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. Similar to the previous step, this can only be done by a "superuser" account in PostgreSQL (e.g. postgres
):
Code Block | ||
---|---|---|
| ||
createdb --username=postgres --owner=dspace --encoding=UNICODE dspace |
You will be prompted for the password of the PostgreSQL superuser (postgres
).
Finally, you MUST enable the pgcrypto extension on your new dspace database. Again, this can only be enabled by a "superuser" account (e.g. postgres
)
Code Block | ||
---|---|---|
| ||
# Login to the database as a superuser, and enable the pgcrypto extension on this database psql --username=postgres dspace -c "CREATE EXTENSION pgcrypto;" |
The "CREATE EXTENSION" command should return with no result if it succeeds. If it fails or throws an error, it is likely you are missing the required pgcrypto extension (see Database Prerequisites above).
Alternative method: How to enable pgcrypto via a separate database schema. While the above method of enabling pgcrypto is perfectly fine for the majority of users, there may be some scenarios where a database administrator would prefer to install extensions into a database schema that is separate from the DSpace tables. Developers also may wish to install pgcrypto into a separate schema if they plan to "clean" (recreate) their development database frequently. Keeping extensions in a separate schema from the DSpace tables will ensure developers would NOT have to continually re-enable the extension each time you run a "./dspace database clean
". If you wish to install pgcrypto in a separate schema here's how to do that:
Code Block | ||
---|---|---|
| ||
# Login to the database as a superuser psql --username=postgres dspace # Create a new schema in this database named "extensions" (or whatever you want to name it) CREATE SCHEMA extensions; # Enable this extension in this new schema CREATE EXTENSION pgcrypto SCHEMA extensions; # Grant rights to call functions in the extensions schema to your dspace user GRANT USAGE ON SCHEMA extensions TO dspace; # Append "extensions" on the current session's "search_path" (if it doesn't already exist in search_path) # The "search_path" config is the list of schemas that Postgres will use SELECT set_config('search_path',current_setting('search_path') || ',extensions',false) WHERE current_setting('search_path') !~ '(^|,)extensions(,|$)'; # Verify the current session's "search_path" and make sure it's correct SHOW search_path; # Now, update the "dspace" Database to use the same "search_path" (for all future sessions) as we've set for this current session (i.e. via set_config() above) ALTER DATABASE dspace SET search_path FROM CURRENT; |
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> |
NOTE: You will need to ensure the proper db.*
settings are specified in your local.cfg
file (see next step), as the defaults for all of these settings assuming a PostgreSQL database backend.
Code Block | ||
---|---|---|
| ||
db.url = jdbc:oracle:thin:@host:port/SID # e.g. db.url = jdbc:oracle:thin:@//localhost:1521/xe # NOTE: in db.url, SID is the SID of your database defined in tnsnames.ora # the default Oracle port is 1521 # You may also use a full SID definition, e.g. # db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE))) # Oracle driver and dialect db.driver = oracle.jdbc.OracleDriver db.dialect = org.hibernate.dialect.Oracle10gDialect # Specify DB username, password and schema to use db.username = db.password = db.schema = ${db.username} # For Oracle, schema is equivalent to the username of your database account, # so this may be set to ${db.username} in most scenarios |
Later, during the Maven build step, don't forget to specify mvn -Ddb.name=oracle package
[dspace-source]/dspace/config/local.cfg
configuration file (you may wish to simply copy the provided [dspace-source]/dspace/config/local.cfg.EXAMPLE
). This local.cfg file can be used to store any configuration changes that you wish to make which are local to your installation (see local.cfg configuration file documentation). ANY setting may be copied into this local.cfg file from the dspace.cfg or any other *.cfg file in order to override the default setting (see note below). For the initial installation of DSpace, there are some key settings you'll likely want to override, those are provided in the [dspace-source]/dspace/config/local.cfg.EXAMPLE
. (NOTE: Settings followed with an asterisk (*) are highly recommended, while all others are optional during initial installation and may be customized at a later time)dspace.dir*
- must be set to the [dspace] (installation) directory (NOTE: 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 (or "localhost" if you just want to run DSpace locally for now)dspace.baseUrl*
- complete URL of this server's DSpace home page (including port), 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 -
Default language for all metadata values (defaults to "en_US")db.url* -
The full JDBC URL to your database (examples are provided in the local.cfg.EXAMPLE
)
db.driver* -
Which database driver to use, based on whether you are using PostgreSQL or Oracle
db.dialect* -
Which database dialect to use, based on whether you are using PostgreSQL or Oracledb.username
* - the database username used in the previous step.db.password
* - the database password used in the previous step.db.schema
* - the database scheme to use (examples are provided in the local.cfg.EXAMPLE)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 provided However, you should be aware that ANY configuration can now be copied into your
Individual settings may also be commented out or removed in your See the Configuration Reference section for more details. |
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, install the dependencies required for building Mirage 2; Git, Node, Bower, Grunt, Ruby and Compass. The Mirage 2 developer documentation provides detailed instructions for these installations and then add the following line to the <theme name="Mirage 2" regex=".*" path="Mirage2/" /> It is important to do this before executing the maven build:
Warning: The Mirage 2 build process should NOT be run as "root". It must be run as a non-root user. For more information see: Mirage 2 Common Build Issues Note: Until recently DSpace 6.3 with Mirage2 could be built without dependencies pre-installed. This build process relied on bootstrapping a local Ruby environment from torquebox.org, the domain registration for which expired some time in early 2022. The torquebox project has not been maintained for a while which means that it is not possible to build DSpace 6.3 with Mirage2 anymore without dependencies pre-installed. A solution is being developed for 6.4, see Migrate Mirage2 Mirage 2 build from bower and compass Ruby sass to yarn npm and node-sass #8288. |
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 (XMLUI), 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 JSP-based User Interface (JSPUI), 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 the "xmlui" and "jspui" (for search & browse functionality), as well as the OAI-PMH interface. It must be installed in support of either UI.
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" reloadable="true" cachingAllowed="false"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/jspui" reloadable="true" cachingAllowed="false"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/solr" reloadable="true" cachingAllowed="false"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <Context docBase="[dspace]/webapps/oai" reloadable="true" cachingAllowed="false"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0'?> <!-- CHANGE THE VALUE OF "[app]" FOR EACH APPLICATION YOU WISH TO ADD --> <Context docBase="[dspace]/webapps/[app]" reloadable="true" cachingAllowed="false"/> |
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.)To define the root context (http://host:8080/
), name that context's directory ROOT
.
Administrator Account: Create an initial administrator account from the command line:
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)...