Page History
...
Note | ||
---|---|---|
| ||
DSpace now requires that Solr be installed separately. The indexes have been reconfigured and must be rebuilt. See below. |
Note | ||
---|---|---|
| ||
The JSPUI and XMLUI user interfaces have been replaced with a new UI based on Angular. If you have customized the code for your user interface, you will need to re-implement your customizations. |
Warning | ||
---|---|---|
| ||
In order to minimize downtime, it is always recommended to first perform a DSpace upgrade using a Development or Test server. You should note any problems you may have encountered (and also how to resolve them) before attempting to upgrade your Production server. It also gives you a chance to "practice" at the upgrade. Practice makes perfect, and minimizes problems and downtime. Additionally, if you are using a version control system, such as subversion or git, to manage your locally developed features or modifications, then you can do all of your upgrades in your local version control system on your Development server and commit the changes. That way your Production server can just checkout your well tested and upgraded code. |
...
Refer to the Prerequisite Software section of "Installing DSpace" for more details around configuring and installing these prerequisites.
Upgrade Steps
- Ensure that your database is compatible: Starting with DSpace 6.x, there are new database requirements for DSpace (refer to the Prerequisite Software section of "Installing DSpace" for full details).
- PostgreSQL databases: PostgreSQL 9.4 or above is required and the "pgcrypto" extension must be installed.
- Notes on installing pgcrypto
- On most Linux operating systems (Ubuntu, Debian, RedHat), this extension is provided in the "postgresql-contrib" package in your package manager. So, ensure you've installed "postgresql-contrib".
- On Windows, this extension should be provided automatically by the installer (check your "[PostgreSQL]/share/extension" folder for files starting with "pgcrypto")
Enabling pgcrypto on your DSpace database. (Additional options/notes in the Installation Documentation)
Code Block # Login to your "dspace" database as a superuser psql --username=postgres dspace # Enable the pgcrypto extension on this database CREATE EXTENSION pgcrypto;
- Notes on installing pgcrypto
- Oracle databases: Oracle database have no additional requirements at this time.
- PostgreSQL databases: PostgreSQL 9.4 or above is required and the "pgcrypto" extension must be installed.
- Download DSpace 7.x: Either download DSpace 7.x from DSpace.org or check it out directly from the Github repository.
- NOTE: You will need both the services component (DSpace/DSpace in Github) and the user interface component (DSpace/dspace-angular in Github).
- NOTE: If you downloaded DSpace do not unpack it on top of your existing If you downloaded DSpace do not unpack it on top of your existing installation. Refer to Installation Instructions, Step 3 for unpacking directives.
- Merge any User Interface customizations or other customizations (if needed or desired). If you have made any local customizations to your DSpace installation they may need to be migrated over to the new DSpace.
- NOTE: If you are upgrading across many versions of DSpace at once (e.g. from 1.x.x to 7.x), you may find it easier to first upgrade DSpace, and then attempt to migrate over your various customizations. Because each major version of DSpace tends to add new configurations and features to the User Interface, older customizations may require more work to "migrate" to the latest version of DSpace. In some situations, it may even be easier to "start fresh", and just re-customize the brand new User Interface with your local color scheme, header/footer, etc.
- Customizations are typically housed in one of the following places:
- JSPUI modifications:
[dspace-source]/dspace/modules/jspui/src/main/webapp/
These will have to be reimplemented. - XMLUI modifications:
[dspace-source]/dspace/modules/xmlui/src/main/webapp/
These will have to be reimplemented. - Config modifications:
[dspace]/config
- JSPUI modifications:
For highly customized DSpace instances, note that the format of the following configuration files has changed. If you have customized these configuration files, carefully re-integrate your custom settings.
dspace/config/dspace.cfg
dspace/config/spring/api/discovery.xml
- The following property has been removed
- <property name="sortOrder" value="COUNT"/>
- And has been replaced with the following
- <property name="sortOrderSidebar" value="COUNT"/>
- <property name="sortOrderFilterPage" value="COUNT"/>
Note the presence of new class names in this file. In particular,note the removal of StandardOpenSearchGenerator
- The following property has been removed
Replace your old build.properties file with a local.cfg (REQUIRED if upgrading from DSpace 5 or previous): As of DSpace 6.0, the
build.properties
configuration file has been replaced by an enhancedlocal.cfg
configuration file. Therefore, any oldbuild.properties
file (or similar[dspace-source]/*.properties
files) WILL BE IGNORED. Instead, you should create a newlocal.cfg
file, based on the provided[dspace-source]/dspace/config/local.cfg.EXAMPLE
and use it to specify all of your locally customized DSpace configurations. This newlocal.cfg
can be used to override ANY setting in any other configuration file (dspace.cfg
ormodules/*.cfg
). To override a default setting, simply copy the configuration into yourlocal.cfg
and change its value(s). For much more information on the features of local.cfg, see the Configuration Reference documentation and the local.cfg Configuration File section on that page.Code Block cd [dspace-source] cp dspace/config/local.cfg.EXAMPLE local.cfg # Then edit the local.cfg, specifying (at a minimum) your basic DSpace configuration settings. # Optionally, you may copy any settings from other *.cfg configuration files into your local.cfg to override them. # After building DSpace, this local.cfg will be copied to [dspace]/config/local.cfg, where it will also be used at runtime.
NOTE: you should change the value of
solr.server
to point at your new Solr v7 service. It will probably become something likesolr.server = https://${dspace.hostname}:8983/solr
.Build Build DSpace. Run the following commands to compile DSpace :
Code Block cd [dspace-source]/dspace/ mvn -U clean package
The above command will re-compile the DSpace source code and build its "installer". You will find the result in
[dspace-source]/dspace/target/dspace-installer
Info title Defaults to PostgreSQL settings Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you use Oracle instead, you should build the DSpace installation package as follows:
mvn -Ddb.name=oracle -U clean package
Back up your
authority
andstatistics
Solr cores.Code Block language bash [dspace]/bin/dspace solr-export-statistics -i authority [dspace]/bin/dspace solr-export-statistics -i statistics
The backup will be written to the directory
[dspace]/solr-export
. This may take a long time and require quite a lot of storage. In particular, the statistics core is likely to be huge, perhaps double the size of the content ofsolr/statistics/data
. You should ensure that you have sufficient free storage.
If you are sharding your statistics data, TBS.Stop Tomcat (or servlet container). Take down your servlet container.
- For Tomcat, use the
$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.)
- For Tomcat, use the
Update DSpace Installation. Update the DSpace installation directory with the new code and libraries. Issue the following commands:
Code Block cd [dspace-source]/dspace/target/dspace-installer ant update
The above command will also automatically upgrade all your existing Solr indexes (e.g. for Discovery, Statistics, OAI-PMH) to the latest version. For large instances, this may take some time. But, it is important to ensure that your indexes are usable by the latest version of DSpace.
- If the Solr index upgrade fails, you may need to Manually Upgrade your Solr Indexes. See the "Troubleshooting Upgrade Issues" section below.
- Update your DSpace Configurations and/or move them to local.cfg (REQUIRED if upgrading from DSpace 5 or previous): You should review your configuration for new and changed configurations in DSpace 6.x.
- As mentioned above, DSpace 6.0 now includes a new local.cfg Configuration File. So, rather than editing the
dspace.cfg
(or any of themodules/*.cfg
), it's recommended to simply override the default values in your ownlocal.cfg
. That way, yourlocal.cfg
can serve as the record of which configurations you have actually tweaked in your DSpace, which may help to simplify future upgrades.- WARNING: in order to create this powerful ability to override configurations in your local.cfg, all
modules/*.cfg
files had their configurations
- WARNING: in order to create this powerful ability to override configurations in your local.cfg, all
- As mentioned above, DSpace 6.0 now includes a new local.cfg Configuration File. So, rather than editing the
dspace.cfg
(or any of themodules/*.cfg
), it's recommended to simply override the default values in your ownlocal.cfg
. That way, yourlocal.cfg
can serve as the record of which configurations you have actually tweaked in your DSpace, which may help to simplify future upgrades.- WARNING: in order to create this powerful ability to override configurations in your local.cfg, all
modules/*.cfg
files had their configurations renamed to be pre-pended with the module name. As a basic example, all the configuration settings within themodules/oai.cfg
configuration now start with"oai.
". Unfortunately, these means that DSpace 5.x configuration files are NOT guaranteed to be compatible with DSpace 6. For more information on configurations in DSpace 6 see our updated Configuration Reference.
- WARNING: in order to create this powerful ability to override configurations in your local.cfg, all
- Search/Browse requires Discovery: As of DSpace 6, only Discovery (Apache Solr) is supported for search/browse. Support for Legacy Search (using Apache Lucene) and Legacy Browse (using database tables) has been removed, along with all their configurations.
- XPDF media filtering no longer exists: XPDF media filtering, deprecated in DSpace 5, has been removed. If you used this, you will need to reconfigure using the remaining alternatives (e.g. PDF Text Extractor and/or ImageMagick PDF Thumbnail Generator)
- Upgrading Configurable/XML Workflow may require minor configuration updates. If you are currently running the DSpace XMLUI with Configurable/XML Workflow enabled, you may need to re-enable its configurations in the DSpace 6 configuration files prior to upgrading. As with past releases, DSpace 6 defaults to using Basic (Traditional) Workflow. Therefore, you should double check the settings required to enable Configurable Workflow in DSpace 6. Pay close attention to the fact that, to enable Configurable Workflow in DSpace 6, all BasicWorkflow settings must also be commented out (in several configs).
- It is recommended to review all configuration changes that exist in the
config
directory, and its subdirectories. It is helpful to compare your current configs against a clean checkout of your current version to see what you have customized. You might then also want to compare your current configs with the configs of the version you are upgrading to. A tool that compares files in directories such as Meld or DiffMerge is useful for this purpose.- After reviewing which configurations you've changed, we recommend moving all your customized configurations into your
local.cfg
file, as described above. Examples of how this might be accomplished are provided in the Configuration Reference.
- After reviewing which configurations you've changed, we recommend moving all your customized configurations into your
- CHANGE IN DSpace 6.3: IP Address to geographic location database has been renamed. The old
[dspace]/config/GeoLiteCity.dat
file is no longer maintained by its provider. You can delete it. The new file is namedGeoLite2-City.mmdb
by default. The upgrade process will automatically download a copy of the new database if you don't already have it. If you have configured a different name and/or location for this file, you should check the setting ofusage-statistics.dbfile
in[dspace]/config/modules/usage-statistics.cfg
(and perhaps move your custom setting tolocal.cfg
). - tm-extractors media filtering (WordFilter) no longer exists: the PoiWordFilter plugin now fulfills this function. If you still have WordFilter configured, remove from
dspace.cfg
and/orlocal.cfg
all lines referencingorg.dspace.app.mediafilter.WordFilter
and uncomment all lines referencingorg.dspace.app.mediafilter.PoiWordFilter
.
- As mentioned above, DSpace 6.0 now includes a new local.cfg Configuration File. So, rather than editing the
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 the "xmlui" and "jspui" (for search & browse functionality), as well as the OAI-PMH interface. It must be installed in support of either UI.
- "oai" = This is the DSpace OAI interface. It allows for metadata and bitstream (content-file) harvesting, supporting OAI-PMH (Protocol for Metadata Harvest) and OAI-ORE (Object Reuse and Exchange) protocols
- "rest" = This is the DSpace REST API
- "sword" = This is the DSpace SWORDv1 interface. More info on SWORD protocol and its usage.
- "swordv2" = This is the DSpace SWORDv2 interface. More info on SWORD protocol and its usage.
- "rdf" = This is the DSpace RDF interface supporting Linked (Open) Data.
PoiWordFilter
.
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):"server" = This contains all of the standard back-end services: REST, SWORD, SWORDv2, RDF, OAI. This is required.
- "rest" = This is the deprecated, old DSpace REST API. The current REST API is part of "server". It is optional. If you use applications written to the pre-v7 REST API, you will need this until you have converted them.
Enable Deploy DSpace Web Applications. If necessary, copy the web applications 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. Also move or delete superseded webapps (oai, sword, swordv2, rdf) that you may have here.
- Upgrade your database (optional, but recommended for major upgrades). As of DSpace 5 (and above), the DSpace code will automatically upgrade your database (from any prior version of DSpace). By default, this database upgrade occurs automatically when you restart Tomcat (or your servlet container). However, if you have a large repository or are upgrading across multiple versions of DSpace at once, you may wish to manually perform the upgrade (as it could take some time, anywhere from 5-15 minutes for large sites).
First, you can optionally verify whether DSpace correctly detects the version of your DSpace database. It is very important that the DSpace version is detected correctly before you attempt the migration:
Code Block [dspace]/bin/dspace database info # Look for a line at the bottom that says something like: # "Your database looks to be compatible with DSpace version ___"
In some rare scenarios, if your database's "sequences" are outdated, inconsistent or incorrect, a database migration error may occur (in your DSpace logs). While this is seemingly a rare occurance, you may choose to run the "update-sequences.sql" script PRIOR to upgrading your database. If your database sequences are inconsistent or incorrect, this "update-sequences.sql" script will auto-correct them (otherwise, it will do nothing). Be aware, if you choose to run this script, please run the "update-sequences.sql" file that corresponds to your current version of DSpace (i.e. the version you are upgrading from), as this script occasionally changes between releases. In the future, we hope to automate this step to avoid any sequence problems:
Code Block # General PostgreSQL example psql -U [database-user] -f [dspace]/etc/postgres/update-sequences.sql [database-name] # Example for a PostgreSQL database named "dspace", and a user account named "dspace" # psql -U dspace -f [dspace]/etc/postgres/update-sequences.sql dspace
Then, you can upgrade your DSpace database to the latest version of DSpace. (NOTE: check the DSpace log,
[dspace]/log/dspace.log.[date]
, for any output from this command)Code Block [dspace]/bin/dspace database migrate
The database migration should also automatically trigger your metadata/file registries to be updated (based on the config files in [dspace]/config/registries/). However, if this update was NOT triggered, you can also manually run these registry updates (they will not harm existing registry contents) as follows:
Code Block [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/dcterms-types.xml [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/dublin-core-types.xml [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/eperson-types.xml [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/local-types.xml [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/sword-metadata.xml [dspace]/bin/dspace registry-loader -metadata [dspace]/config/registries/workflow-types.xml
- If the database upgrade process fails or throws errors, then you likely have manually customized your database structure (and/or backported later DSpace features to an older version of DSpace). In this scenario, you may need to do some manual migrations before the automatic migrations will succeed. The general process would be something like this:
- Revert back to your current DSpace database
- Manually upgrade just your database past the failing migration. For example, if you are current using DSpace 1.5 and the "V1.6" migration is failing, you may need to first manually upgrade your database to 1.6 compatibility. This may involve either referencing the upgrade documentation for that older version of DSpace, or running the appropriate SQL script from under
[dspace-src]/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/
) - Then, re-run the migration process from that point forward (i.e. re-run
./dspace database migrate
)
- More information on the "database" command can be found in Database Utilities documentation.
Note title By default, your site will be automatically reindexed after a database upgrade If any database migrations are run (even during minor release upgrades), then by default DSpace will automatically reindex all content in your site. This process is run automatically in order to ensure that any database-level changes are also immediately updated within the search/browse interfaces. See the notes below under "Restart Tomcat (servlet container)" for more information.
However, you may choose to skip automatic reindexing. Some sites choose to run the reindex process manually in order to better control when/how it runs.
To disable automatic reindexing, setdiscovery.autoReindex = false
inconfig/local.cfg
orconfig/modules/discovery.cfg
.As you have disabled automatic reindexing, make sure to manually reindex your site by running
[dspace]/bin/dspace discovery -b
(This must be run after restarting Tomcat)WARNING: It is not recommended to skip automatic reindexing, unless you will manually reindex at a later time, or have verified that a reindex is not necessary. Forgetting to reindex your site after an upgrade may result in unexpected errors or instabilties.
Sites with Oracle database backends (and Configurable Workflow enabled) may need to run a "repair" on your database.
In version 6.3, we fixed an Oracle migration issue related to Configurable (XML) Workflow. See DS-3788.
If you are upgrading an Oracle-based site to 6.3 from 6.0, 6.1 or 6.2 AND had Configurable Workflow already enabled, then you will need to manually "repair" your database to align it with the latest schema. This does not affect PostgreSQL-based backends or any sites that are upgrading from 5.x or below.
Simply run the following to repair your Oracle database:
[dspace]/bin/dspace database repair
- Install new Solr cores and rebuild your indexes. (Only necessary if upgrading from 6.x or below)
Copy the new, empty Solr cores to your new Solr instance.
Code Block language bash cp -r [dspace]/solr/* [solr]/server/solr/configsets chown -R solr:solr [solr]/server/solr/configsets/authority [solr]/server/solr/configsets/oai [solr]/server/solr/configsets/search [solr]/server/solr/configsets/statistics
Restore
authority
andstatistics
from backup.Code Block language bash [dspace]/bin/dspace solr-import-statistics -i authority [dspace]/bin/dspace solr-import-statistics -i statistics
This could take quite some time.
Rebuild the
oai
andsearch
cores.Code Block language bash [dspace]/bin/dspace oai import [dspace]/bin/dspace index-discovery
If you have a great deal of content, this could take a long time.
Update Handle Server Configuration. If you are using the built-in Handle server, you'll need to add the follow to the server_config section of your config.dct file:
Code Block "enable_txn_queue" = "no"
Restart Tomcat (servlet container). Now restart your servlet container (Tomcat/Jetty/Resin) and test out the upgrade.
- Upgrade of database: If you didn't manually upgrade your database in the previous step, then your database will be automatically upgraded to the latest version. This may take some time (seconds to minutes), depending on the size of your repository, etc. Check the DSpace log (
[dspace]/log/dspace.log.[date]
) for information on its status. Reindexing of all content for search/browse: If your database was just upgraded (either manually or automatically), all the content in your DSpace will be automatically re-indexed for searching/browsing. As the process can take some time (minutes to hours, depending on the size of your repository), it is performed in the background; meanwhile, DSpace can be used as the index is gradually filled. But, keep in mind that not all content will be visible until the indexing process is completed. Again, check the DSpace log (
[dspace]/log/dspace.log.[date]
) for information on its status.- If you wish to skip automatic reindexing, please see the Note above under the "Upgrade your Database" step.
- Upgrade of database: If you didn't manually upgrade your database in the previous step, then your database will be automatically upgraded to the latest version. This may take some time (seconds to minutes), depending on the size of your repository, etc. Check the DSpace log (
Check your cron / Task Scheduler jobs. In recent versions of DSpace, some of the scripts names have changed.
Check the Scheduled Tasks via Cron documentation for details. Especially pay attention to the Solr Index optimization commands, which ideally should be run regularly (as noted in the previous step).
- WINDOWS NOTE: If you are running the Handle Server on a Windows machine, a new
[dspace]/bin/start-handle-server.bat
script is available to more easily startup your Handle Server.
...