All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Info |
---|
In the notes below |
Anchor | ||||
---|---|---|---|---|
|
Note | ||
---|---|---|
| ||
In DSpace 3.0 there have been a few significant changes to how you upgrade and configure DSpace. Notably:
|
Before you start your upgrade, it is strongly recommended that you create a backup of your DSpace instance. Backups are easy to recover from; a botched install/upgrade is very difficult if not impossible to recover from. The DSpace specific things to backup are: configs, source code modifications, database, and assetstore. On your server that runs DSpace, you might additionally consider checking on your cron/scheduled tasks, servlet container, and database.
Make a complete backup of your system, including:
Database: Make a snapshot/dump of the database. For the PostgreSQL database use Postgres' pg_dump command. For example:
Code Block |
---|
pg_dump -U [database-user] -f [backup-file-location] [database-name] |
[dspace]/assetstore
by default, and any other assetstores configured in the [dspace]/config/dspace.cfg
"assetstore.dir" and "assetstore.dir.#" settings)[dspace]/config
.[dspace-source]/dspace/modules/jspui/src/main/webapp/
[dspace-source]/dspace/modules/xmlui/src/main/webapp/
[dspace]/config
[dspace-source]/build.properties
). This new configuration file allows for an easier way to quickly configure your primary DSpace settings before building DSpace. It provides a subset of the most important configurations you may wish to make for your DSpace installation. Any settings changed in this build.properties
file are automatically copied over to the final dspace.cfg
file during the "Build DSpace" process (in the next step). For more information on the build.properties file, see "The build.properties Configuration Properties File" section of the Configuration Reference documentation.
Build DSpace. Run the following commands to compile DSpace:
Code Block |
---|
cd [dspace-source]/dspace/ mvn -U clean package |
You will find the result in [dspace-source]/dspace/target/dspace-[version]-build.dir
. Inside this directory is the compiled binary distribution of DSpace. Before rebuilding DSpace ('package'), the above command will clean out any previously compiled code ('clean') and ensure that your local DSpace JAR files are updated from the remote maven repository.
$CATALINA_HOME/shutdown.sh
script. (Many Unix-based installations will have a startup/shutdown script in the /etc/init.d
or /etc/rc.d
directories.)Update the DSpace installed directory with the new code and libraries. Issue the following commands:
Code Block |
---|
cd [dspace-source]/dspace/target/dspace-[version]-build.dir ant update |
[dspace-source]/dspace/etc/postgres/database_schema_18-3.sql
[dspace-source]/dspace/etc/oracle/database_schema_18-3.sql
[dspace]/config/dspace.cfg
and all configurations under [dspace]/config/modules/
. This configuration settings can also be modified at any time in the future. You'd just need to restart Tomcat for any settings to take effect.
Refresh Browse and Search Indexes. To do this, run the following command from your DSpace install directory (as the dspace user):
Code Block |
---|
[dspace]/bin/dspace index-init |
Refresh Discovery: If you are using Discovery (Solr) for search/browse, you will also need to refresh Discovery indexes by running the following command:
Code Block |
---|
[dspace]/bin/dspace update-discovery-index -f |
Update OAI-PMH indexes. DSpace 3.0 comes with a brand new OAI 2.0 Server which uses a Solr backend by default. As such, it needs to have its indexes updated on a regular basis. To update the OAI 2.0 indexes, you should run the following command:
Code Block |
---|
[dspace]/bin/dspace oai import |
Note | ||
---|---|---|
| ||
This same ' |
Info | ||
---|---|---|
| ||
If you are using OAI-PMH, but do not yet have the Solr webapp ( (1) EITHER Modify the default OAI 2.0 config file ( (2) OR install/enable Tomcat to use the DSpace Solr webapp ( |
Change LDAPHierarchicalAuthentication to LDAPAuthentication. If you were using the LDAPHierarchicalAuthentication method in DSpace 1.8.x, you need to change your authentication plugin to LDAPAuthentication. The functionality from LDAPHierarchicalAuthentication is now part of LDAPAuthentication. This change should be made in [dspace]/config/modules/authentication.cfg
in the plugin.sequence.org.dspace.authenticate.AuthenticationMethod
property. LDAP configuration in [dspace]/config/modules/authentication-ldap.cfg
remains the same, so you won't need to change anything. The only case (which should apply to a minority of users) when you do need to update your configuration is if you were using anonymous search (i.e. you were using LDAPHierarchicalAuthentication, but you didn't have search.user
and search.password
set); if that applies to you, edit [dspace]/config/modules/authentication-ldap.cfg
and set:
Code Block |
---|
search.anonymous = true |
A new feature in 3.0 is that you can now put users into DSpace groups based on a part of their DN in LDAP. See the new login.groupmap.*
options in Authentication Plugins#ConfiguringLDAPAuthentication.
Deploy Web Applications. If necessary, copy the web applications files from your [dspace]/webapps
directory to the subdirectory of your servlet container (e.g. Tomcat):
Code Block |
---|
cp -R [dspace]/webapps/* [tomcat]/webapps/ |
See the installation guide for full details.