All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Unsupported Release
This documentation relates to DSpace 1.8.x, an old, unsupported version. Looking for another version? See all documentation.
As of January 2015, DSpace 1.8.x is no longer supported. We recommend upgrading to a more recent version of DSpace. See DSpace Software Support Policy.
The changes in DSpace 1.5 are significant and wide spread involving database schema upgrades, code restructuring, completely new user and programmatic interfaces, and new build system.
In the notes below [dspace]
refers to the install directory for your existing DSpace installation, and [dspace-source] to the source directory for DSpace 1.5. Whenever you see these path references, be sure to replace them with the actual path names on your local system.
The asset store ([dspace]/assetstore by default)
Your statistics scripts ([dspace]/bin/stat*) which contain customizable dates
cd [dspace-source]/dspace/; mvn package
You will find the result in [dspace-source]/dspace/target/dspace-1.5-build.dir/; inside this directory is the compiled binary distribution of DSpace.
Update dspace.cfg Several new parameters need to be added to your [dspace]/config/dspace.cfg. While it is advisable to start with a fresh DSpace 1.5 _dspace.cfg configuration file_ here are the minimum set of parameters that need to be added to an old DSpace 1.4.2 configuration.
#### Stackable Authentication Methods ##### # # Stack of authentication methods # (See org.dspace.authenticate.AuthenticationManager) # Note when upgrading you should remove the parameter: # plugin.sequence.org.dspace.eperson.AuthenticationMethod plugin.sequence.org.dspace.authenticate.AuthenticationMethod = \ org.dspace.authenticate.PasswordAuthentication ###### JSPUI item style plugin ##### # # Specify which strategy use for select the style for an item plugin.single.org.dspace.app.webui.util.StyleSelection = \ org.dspace.app.webui.util.CollectionStyleSelection ###### Browse Configuration ###### # # The following configuration will mimic the previous # behavior exhibited by DSpace 1.4.2. For alternative # configurations see the manual. # Browse indexes webui.browse.index.1 = dateissued:item:dateissued webui.browse.index.2 = author:metadata:dc.contributor.*:text webui.browse.index.3 = title:item:title webui.browse.index.4 = subject:metadata:dc.subject.*:text # Sorting options webui.itemlist.sort-option.1 = title:dc.title:title webui.itemlist.sort-option.2 = dateissued:dc.date.issued:date webui.itemlist.sort-option.3 = dateaccessioned:dc.date.accessioned:date # Recent submissions recent.submissions.count = 5 # Itemmapper browse index itemmap.author.index = author # Recent submission processor plugins plugin.sequence.org.dspace.plugin.CommunityHomeProcessor = \ org.dspace.app.webui.components.RecentCommunitySubmissions plugin.sequence.org.dspace.plugin.CollectionHomeProcessor = \ org.dspace.app.webui.components.RecentCollectionSubmissions #### Content Inline Disposition Threshold #### # # Set the max size of a bitstream that can be served inline # Use -1 to force all bitstream to be served inline # webui.content_disposition_threshold = -1 webui.content_disposition_threshold = 8388608 #### Event System Configuration #### # # default synchronous dispatcher (same behavior as traditional DSpace) event.dispatcher.default.class = org.dspace.event.BasicDispatcher event.dispatcher.default.consumers = search, browse, eperson # consumer to maintain the search index event.consumer.search.class = org.dspace.search.SearchConsumer event.consumer.search.filters = Item|Collection|Community|Bundle+Create|Modify|Modify_Metadata|Delete: Bundle+Add|Remove # consumer to maintain the browse index event.consumer.browse.class = org.dspace.browse.BrowseConsumer event.consumer.browse.filters = Item+Create|Modify|Modify_Metadata:Collection+Add|Remove # consumer related to EPerson changes event.consumer.eperson.class = org.dspace.eperson.EPersonConsumer event.consumer.eperson.filters = EPerson+Create
cp [dspace-source]/dspace/config/xmlui.xconf [dspace]/config/xmlui.xconf
cp [dspace-source]/dspace/config/item-submission.xml [dspace]/config/item-submission.xml cp [dspace-source]/dspace/config/item-submission.dtd [dspace]/config/item-submission.dtd
cp [dspace-source]/dspace/config/input-forms.xml [dspace]/config/input-forms.xml cp [dspace-source]/dspace/config/input-forms.dtd [dspace]/config/inputforms.dtd
cp [dspace-source]/dspace/config/crosswalks/sword-swap-ingest.xsl [dspace]/config/crosswalks/sword-swap-ingest.xsl cp [dspace-source]/dspace/config/crosswalks/xhtml-head-item.properties [dspace]/config/crosswalks/xhtml-head-item.properties
cp [dspace-source]/dspace/config/emails/registration_notify [dspace]/config/emails/registration_notify
For PostgreSQL psql -U [dspace-user] -f [dspace-source]/dspace/etc/database_schema_14-15.sql [database-name]
For Oracle [dspace-source]/dspace/etc/oracle/database_schema_142-15.sql contains the commands necessary to upgrade your database schema on oracle.
Apply any customizations If you have made any local customizations to your DSpace installation they will need to be migrated over to the new DSpace. Commonly these modifications are made to "JSP" pages located inside the [dspace 1.4.2]/jsp/local directory. These should be moved [dspace-source]/dspace/modules/jspui/src/main/webapp/ in the new build structure. See Customizing the JSP Pages for more information.
Update DSpace Update the DSpace installed directory with new code and libraries. Inside the [dspace-source]/dspace/target/dspace-1.5-build.dir/ directory run:
cd [dspace-source]/dspace/target/dspace-1.5-build.dir/; ant -Dconfig=[dspace]/config/dspace.cfg update
cp [dspace-source]/dspace/config/registries/sword-metadata.xml [dspace]/config/registries/sword-metadata.xml; [dspace]/bin/dsrun org.dspace.administer.MetadataImporter -f [dspace]/config/registries/sword-metadata.xml
[dspace]/bin/index-init
Update statistics scripts The statistics scripts have been rewritten for DSpace 1.5. Prior to 1.5 they were written in Perl, but have been rewritten in Java to avoid having to install Perl. First, make a note of the dates you have specified in your statistics scripts for the statistics to run from. You will find these in [dspace]/bin/stat-initial, as $start_year and $start_month. Note down these values.Copy the new stats scripts:
cp [dspace-source]/dspace/bin/stat* [dspace]/bin/
Then edit your statistics configuration file with the start details. Add the following to [dspace]/conf/dstat.cfg# the year and month to start creating reports from# - year as four digits (e.g. 2005)# - month as a number (e.g. January is 1, December is 12)start.year = 2005start.month = 1 Replace '2005' and '1' as with the values you noted down. dstat.cfg also used to contain the hostname and service name as displayed at the top of the statistics. These values are now taken from dspace.cfg so you can remove host.name and host.url from dstat.cfg if you wish. The values now used are dspace.hostname and dspace.name from dspace.cfg
Deploy web applications Copy the web applications files from your [dspace]/webapps directory to the subdirectory of your servlet container (e.g. Tomcat):
cp [dspace]/webapps/* [tomcat]/webapps/