All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
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. |
Warningnote | |||
---|---|---|---|
| |||
MaxMind has changed the terms and procedure for obtaining and using its GeoLite location database. Consequently, DSpace no longer automatically downloads the database during installation or update, and the DSpace-specific database update tool has been removed. If you wish to (continue to) record client location data in usage statistics, you will need to make new arrangements. See below. |
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 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.
...
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; |
[dspace-source]/dspace/modules/jspui/src/main/webapp/
These will have to be reimplemented.
[dspace-source]/dspace/modules/xmlui/src/main/webapp/
These will have to be reimplemented.[dspace]/config
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
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 enhanced local.cfg
configuration file. Therefore, any old build.properties
file (or similar [dspace-source]/*.properties
files) WILL BE IGNORED. Instead, you should create a new local.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 new local.cfg
can be used to override ANY setting in any other configuration file (dspace.cfg
or modules/*.cfg
). To override a default setting, simply copy the configuration into your local.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. |
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 | ||
---|---|---|
| ||
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: |
Dump your Anchor dump_solr dump_solr authority
and statistics
Solr cores. (Only when upgrading from DSpace 6 or older.)
Code Block | ||
---|---|---|
| ||
[dspace]/bin/dspace solr-export-statistics -i authority [dspace]/bin/dspace solr-export-statistics -i statistics |
The dumps 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 of solr/statistics/data
. You should ensure that you have sufficient free storage.
This is not the same as the disaster-recovery backup that was done above. These dumps will be reloaded into new, reconfigured cores later.
If you are sharding your statistics data, you will need to dump each shard separately. The index names for prior years will be statistics-YYYY
(for example: statistics-2017 statistics-2018
etc.) The current year's statistics shard is named statistics
and you should dump that one too.
Stop Tomcat (or servlet container). Take down your servlet container.
$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 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 |
dspace.cfg
(or any of the modules/*.cfg
), it's recommended to simply override the default values in your own local.cfg
. That way, your local.cfg
can serve as the record of which configurations you have actually tweaked in your DSpace, which may help to simplify future upgrades.modules/*.cfg
files had their configurations renamed to be pre-pended with the module name. As a basic example, all the configuration settings within the modules/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.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.local.cfg
file, as described above. Examples of how this might be accomplished are provided in the Configuration Reference.[dspace]/config/GeoLiteCity.dat
file is no longer maintained by its provider. You can delete it. The new file is named GeoLite2-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 of usage-statistics.dbfile
in [dspace]/config/modules/usage-statistics.cfg
(and perhaps move your custom setting to local.cfg
).dspace.cfg
and/or local.cfg
all lines referencing org.dspace.app.mediafilter.WordFilter
and uncomment all lines referencing org.dspace.app.mediafilter.PoiWordFilter
.solr.server
to point at your new Solr v7 service. It will probably become something like solr.server = https://${dspace.hostname}:8983/solr
. Also review the values ofdiscovery.search.server
oai.solr.url
solr.authority.server
solr.statistics.server
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.
Enable 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.
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" command PRIOR to upgrading your database. If your database sequences are inconsistent or incorrect, this "update-sequences" command will auto-correct them (otherwise, it will do nothing).
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 |
If you are upgrading from DSpace 6 or earlier, there are database changes which were optional but now are mandatory. Instead of (or after) the above command:
Code Block |
---|
[dspace]/bin/dspace database migrate ignored |
to apply these changes.
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 |
[dspace-src]/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/
)./dspace database migrate
)Note | ||
---|---|---|
| ||
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 in config/local.cfg or config/modules/discovery.cfg .As you have disabled automatic reindexing, make sure to manually reindex your site by running 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
Copy the new, empty Solr cores to your new Solr instance.
Code Block | ||
---|---|---|
| ||
cp -r [dspace]/solr/* [solr]/server/solr chown -R solr:solr [solr]/server/solr/authority [solr]/server/solr/oai [solr]/server/solr/search [solr]/server/solr/statistics |
Anchor | ||||
---|---|---|---|---|
|
authority
and statistics
from the dumps that you made earlier (not the disaster-recovery backup).Code Block | ||
---|---|---|
| ||
[dspace]/bin/dspace solr-import-statistics -i authority [dspace]/bin/dspace solr-import-statistics -i statistics |
This could take quite some time.
If you had sharded your statistics, you will need to load the dump of each shard separately. As when dumping, the index names will be ... statistics-2017 statistics-2018 statistics
.
Rebuild the oai
and search
cores.
Code Block | ||
---|---|---|
| ||
[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" |
usage-statistics.dbfile
in config/modules/usage-statistics.cfg
– it should point to the path where the updater puts the database. A typical value (on a Linux host) is commented out.config/
directory.Restart Tomcat (servlet container). Now restart your servlet container (Tomcat/Jetty/Resin) and test out the upgrade.
[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.
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).
[dspace]/bin/start-handle-server.bat
script is available to more easily startup your Handle Server....