Skip to content

Upgrade

In this section you will find information about how to upgrade a previous installation of GeoNetwork Enterprise.

Before you start

Minor updates may be performed in place:

  • GeoCat recommends backing up your database and data directory.

For major updates or migrating from an earlier version of GeoNetwork:

  • GeoCat recommends backing up your database and data directory.
  • We do not recommend upgrading on a production server. Instead perform a new installation and transfer your data and settings to the new machine.

References:

Minor Update

Release GeoNetwork Updates Standard Premium
GeoNetwork Enterprise 2023.3 4.2.11 2023 2026 2028
GeoNetwork Enterprise 2023.2 4.2.10 2023 2026 2028
GeoNetwork Enterprise 2023.1 4.2.8 2023 2026 2028
GeoNetwork Enterprise 2023.0 4.2.7 2023 2026 2028

Major Upgrade

Before upgrading to GeoNetwork Enterprise 2023, read the Migration guide.

See the sections Download Geonetwork Enterprise and Deploy Geonetwork Enterprise to download GeoNetwork Enterprise 2023.3 and deploy it.

Release GeoNetwork Updates Standard Premium
GeoNetwork Enterprise 2023 4.2 2023 2026 2028
GeoNetwork Enterprise 2022 3.12 2022 2025 2027
GeoNetwork Enterprise 2020.5 3.10 2020 2023 2025
GeoNetwork Enterprise 2019.5 3.6 2019 2022 2024
GeoNetwork Enterprise 3.4 3.4 2018 2021 2023
GeoNetwork Enterprise 3.2 3.2 2017 2020 2022

GeoNetwork Enterprise 2023.x includes a feature that encrypts the passwords that are stored in the database for the mail server, harvesters, etc.

The first time the application is started, a file named encryptor.properties is created in the application data directory, which the application uses to decrypt passwords.

It's recommended to make a backup copy of this file, because if it's lost, the application will not be able to decrypt the passwords. You can find the exact file path in the log file:

2022-03-02 13:36:32,299 INFO  [geonetwork.encryptor] - Generating a new random password for the database password encryptor
2022-03-02 13:36:32,299 INFO  [geonetwork.encryptor] - Password database encryptor initialized - Keep the file /opt/tomcat/webapps/geonetwork/data/config/encryptor.properties safe and make a backup. When upgrading to a newer version of GeoNetwork the file must be restored, otherwise GeoNetwork will not be able to decrypt passwords already stored in the database.

If you have already backed up the application data directory, as recommended, this file is already included in the backup.

Migration guide

GeoNetwork Enterprise 2023.3 is based on GeoNetwork opensource 4.2.x. This version of GeoNetwork has switched the search engine to use ElasticSearch instead of Lucene, as in previous versions. See how to Install Elasticsearch.

Considerations before upgrading

GeoNetwork opensource 4.2.x has changed some services:

  • The q, xml.search query end-points are not supported. See how to use the new search end-point.
  • Virtual CSW end-points are replaced by sub-portals. See Portal configuration.
  • Metadata notifier manager / to notify external services when metadata has updated. Extensions can be developed to support similar features.
  • The advanced search form has been simplified in favour of facet filters.

Warning

If you have applications using these services, please review the related documentation to update your applications, before upgrading to GeoNetwork Enterprise 2023.

GeoNetwork opensource 4.2.x also doesn't have support for some services:

  • Only the CSW search protocol has been migrated for now (ie. OAI-PMH, RDF, Z39.50/SRU, OpenSearch, ... are not available in this version). This means that GeoNetwork Enterprise 2023 can only be harvested using the CSW protocol.
  • Deprecated services have been removed. Check the swagger API to view the available services. See GeoNetwork API.

Warning

If you require these services, you should not upgrade to GeoNetwork Enterprise 2023 and instead use GeoNetwork Enterprise 2022.

Migration steps

Important

We highly recommend to test the migration process in a test server, before upgrading your production server.

  1. Check the Requirements to install the required components.
  2. Do a backup up of your database and data directory.
  3. Download Geonetwork Enterprise.
  4. Deploy Geonetwork Enterprise.

Important

Before starting up the application, check if the database table guf_userfeedbacks_guf_rating is empty. In this case it is necessary to edit the file WEB-INF/classes/setup/sql/migrate/v402/migrate-default.sql by commenting the following line with the characters --, to avoid an error during the database migration:

-- ALTER TABLE guf_userfeedbacks_guf_rating ADD COLUMN GUF_UserFeedback_uuid varchar(255);

Troubleshooting

During the first startup after an update, GeoNetwork performs a database migration adjusting any tables to reflect all changes required.

Scripts used:

  • initial setup: WEB-INF/classes/setup/sql/create/
  • initial data: classes/setup/sql/data/
  • migration: classes/setup/sql/migrate/

Table structure is also adjusted to reflect any changes to the GeoNetwork data model. To monitor these changes add the following to log4j2.xml:

<!-- Set hdm2ddl to information to see database setup -->
<Logger name="org.hibernate.tool.hbm2ddl" level="info" additivity="false">
  <AppenderRef ref="Console"/>
  <AppenderRef ref="File"/>
</Logger>