Upgrade

This section describes how to perform an upgrade to GeoServer Enterprise 2022.3.

Before you start

Minor updates may be performed in place:

• GeoCat Recommends backing up your GEOSERVER_DATA_DIR, and the configuration conf/Catalina/localhost/geoserver.xml file.

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

• GeoCat Recommends backing up your GEOSERVER_DATA_DIR, and the configuration conf/Catalina/localhost/geoserver.xml file.

• 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:

• Upgrading existing versions

• Migrating a data directory between versions

Minor Update (Windows)

This is an essential update GeoServer Enterprise 2022.2-1.

GeoServer Enterprise 2021 Update

Release	GeoServer	Updates	Standard	Premium
GeoServer Enterprise 2022.0	2.21.0	2022	2025	2027
GeoServer Enterprise 2022.1	2.21.2	2022	2025	2027
GeoServer Enterprise 2022.2	2.21.3	2022	2025	2027
GeoServer Enterprise 2022.2-1	2.21.4	2022	2025	2027
GeoServer Enterprise 2022.3	2.22.2	2022	2025	2027

Minor upgrades can be performed in place and consist of a new web archive:

1. Login to nexus.geocat.net and browse to the enterprise folder:

   • https://nexus.geocat.net/#browse/browse:enterprise

   Navigate to the latest geoserver release and select the geoserver-standard zip archive.

   

2. Unzip this file containing:

   • windows - sample configuration files

   • GPL and LICENSE.txt open source license information

   • geoserver.war - geoserver enterprise web application used below

3. Stop the Tomcat service:

4. Open the Tomcat Program folder by using the Start menu to select Apache Tomcat ‣ Tomcat Program Directory.

   

5. Open the webapps folder, and delete the existing:

   • geoserver/ folder

   • geoserver.war web archive

6. Copy the geoserver.war file to the to tomcat webapps folder.

7. Start the Tomcat service.

   Tomcat will deploy geosever.war web application, creating geoserver folder for the running application.

8. In your web browser, navigate to localhost:8080/geoserver to verify that GeoServer Enterprise is correctly working.

   

Minor Update (Linux)

This is an essential update GeoServer Enterprise 2022.2-1.

GeoServer Enterprise 2021 Update

Release	GeoServer	Updates	Standard	Premium
GeoServer Enterprise 2022.0	2.21.0	2022	2025	2027
GeoServer Enterprise 2022.1	2.21.2	2022	2025	2027
GeoServer Enterprise 2022.2	2.21.3	2022	2025	2027
GeoServer Enterprise 2022.2-1	2.21.4	2022	2025	2027
GeoServer Enterprise 2022.3	2.22.2	2022	2025	2027

Minor upgrades can be performed in place and consist of a new web archive:

1. Login to nexus.geocat.net and browse to the enterprise folder:

   • https://nexus.geocat.net/#browse/browse:enterprise

   Navigate to the latest geoserver release and select the geoserver-standard zip archive.

   

2. Unzip this file containing:

   • windows - sample configuration files

   • GPL and LICENSE.txt open source license information

   • geoserver.war - geoserver enterprise web application used below

3. Stop the Tomcat service:

   sudo service tomcat9 stop
   

4. Navigate to the [Tomcat_folder]/webapps folder (often /var/lib/tomcat9/webapps or /opt/tomcat/latest/webapps.)

   Remove the previous web application:

   rm geoserver.war
   rm -r geoserver
   

5. Copy the geoserver.war file to the to tomcat webapps folder.

6. Start the Tomcat service:

   sudo service tomcat9 start
   

   Tomcat will deploy geosever.war web application, creating geoserver folder for the running application.

7. In your web browser, navigate to localhost:8080/geoserver to verify that GeoServer Enterprise is correctly working.

   

GeoServer Enterprise Upgrade

GeoServer Enterprise Upgrades

Release	GeoServer	Updates	Standard	Premium
GeoServer Enterprise 2022	2.21 2.22	2022	2025	2027
GeoServer Enterprise 2021	2.20 2.19	2021	2024	2026
GeoServer Enterprise 2020.5	2.18 2.17	2020	2023	2025
GeoServer Enterprise 2.14	2.14	2019	2022	2024
GeoServer Enterprise 2.13	2.13	2018	2021	2023

GeoServer Enterprise Standard is provided ready to use with popular extensions preinstalled.

GeoServer Enterprise Premium is provided as a preconfigured web archive with the extensions you have requested. If you have chosen to remove an extension please work with our staff on the my.geocat.net support portal to determine if any modifications to your data directory are required during the upgrade process.

1. Follow install instructions to setup a new environment:

   • Installation on Windows

   • Installation on Linux

2. This is a good opportunity to update to:

   • Tomcat 9

   • Java 11

3. Make a backup of your existing GEOSERVER_DATA_DIRECTORY prior to use.

4. This release changes from Log4j 1.2 properties logging profiles to Log4j 2 xml logging profiles.

   When the application first starts up the built-in logging profiles are replaced with new Log4j 2 xml files.

5. Only if you made custom logging profile:

   • Your existing Log4j 1.2 properties logging profiles remain unchanged and can be used with Log4j 2.

   • If you edited any of the built-in log4j 1.2 properties logging profiles your changes will be overwritten during the migration to Log4j 2 xml files (and the previous content saved to a bak backup file).

     To recover a customized logging configuration rename the bak backup to a new file with properties extension.

Migrating from GeoServer Distribution

It is straight forward to migrate from the GeoServer Community Distribution to GeoServer Enterprise.

Migration guidance for specific versions of GeoServer are noted below, along with timeframe for community updates and GeoCat support information.

Migrate Guidance

Version	Guidance	Updates	Standard	Premium
GeoServer 2.21		February 2023	2025	2027
GeoServer 2.20		September 2022 October 2021	2024	2026
GeoServer 2.19		February 2022 March 2021	2024	2026
GeoServer 2.18		August 2021 September 2020	2023	2025
GeoServer 2.17	End of ArcSDE support	February 2021 April 2020	2023	2025
GeoServer 2.16		August 2020|br| September 2019	2022	2024
GeoServer 2.15	Java 8 LTS minimum Java 11 LTS supported	February 2020 March 2019	2022	2024
GeoServer 2.14	REST API geometry bindings changed, recommend re-testing automation scripts.	July 2019 September 2018	2021	2023
GeoServer 2.13		December 2018 March 2018	2021	2023
GeoServer 2.12	REST API ported to spring-framework, recommend re-testing automation scripts.	August 2018 October 2017	2020	2022
GeoServer 2.11		February 2018 March 2017	2020	2022
GeoServer 2.10		August 2017 October 2016	2019	2021
GeoServer 2.9	Java 8 required	January 2017 May 2016	2019	2021
GeoServer 2.8	End of Java 7 Support	August 2016 September 2015	2018	2020

To migrate from GeoServer distribution to GeoServer Enterprise:

1. Locate your GEOSERVER_DATA_DIR:

   • Binary: data_dir

   • WAR: webapps/geoserver/data

   • Windows: C:\ProgramData\GeoServer\Data

   • Windows: C:\Program Files\GeoServer\data_dir

   • Linux: /usr/share/geoserver

   Make a backup of your data directory:

   cd /usr/share
   zip -r data.zip geoserver
   

2. Check for any configuration settings recorded in:

   • Windows: bin/setenv.bat

   • Linux: bin/setenv.sh

   • Linux: /etc/default/tomcat7 service, using a``JAVA_OPTS`` environmental variable

   • Windows Service: Apache Tomcat 9.0 Tomcat Properties, where Java Options are located on the Java tab.

   During upgrade any custom settings noted here can be applied to your new system following: Set Java startup options.

3. Check if conf/web.xml has enabled Cross-Origin Resource Sharing (CORS):

   <filter>
     <filter-name>CorsFilter</filter-name>
     <filter-class>org.apache.catalina.filters.CorsFilter</filter-class>
   </filter>
   <filter-mapping>
     <filter-name>CorsFilter</filter-name>
     <url-pattern>/*</url-pattern>
   </filter-mapping>
   

   To enable CORS for your new system: Cross-Origin Resource Sharing (CORS).

3. Follow the GeoSever Enterprise installation instructions:

   • Installation on Linux

   • Installation on Windows

   Transfer your backup (the file :data.zip above) for use when setting up the GEOSERVER_DATA_DIR.

   The file will be unpacked into the recommended location:

   • Linux: /var/opt/geoserver/data

   • Windows: C:\ProgramDataGeoServer\Data

   This GEOSERVER_DATA_DIR configuration will be updated in place as GeoServer starts up.

Migrating from Boundless Suite

As a reseller of the now discontinued Boundless Suite we would like to offer migration guidance to GeoServer Enterprise.

Planning a migrating to GeoServer Enterprise Premium should be conducted with the assistance of staff on the my.geocat.net support portal to ensure your pre-configured web archive as the extensions you require.

Boundless Suite / OpenGeo Suite Version Reference

Version	GeoServer	Environment	Date
Boundless Suite 1.2.0	GeoServer 2.15	Java 8 / Java 11 / Tomcat 9	2019
Boundless Suite 1.1.1	GeoServer 2.13	Java 8 / Tomcat 8.5	2018
Boundless Suite 1.0.0	GeoServer 2.12	Java 8 / Tomcat 8.5	2018
Boundless Suite 4.10	GeoServer 2.11	Java 8 / Tomcat 8.0	2017
OpenGeo Suite 4.9	GeoServer 2.9	Java 8 / Tomcat 8.0	2016
OpenGeo Suite 4.8	GeoServer 2.8	Java 7 / Tomcat 7	2016
OpenGeo Suite 4.7	GeoServer 2.7	Java 7 / Tomcat 7	2015

Linux Package Migration Guidance

linux package	migration guidance
suite-composer	Use of geocat bridge, improved GeoServer style editor
suite-dashboard	not-available
suite-docs	Latest GeoServer Enterprise documentation
suite-geoserver	GeoServer Enterprise Standard
suite-geowebcache	download standalone geowebacache
suite-quickview	Recommend GeoNetwork Enterprise Map viewer
suite-wpsbuilder	Recommend QGIS WPS Client plugin
tomcat8	Recommend tomcat provided by your linux distribution
postgresql-9.3-postgis-2.1	Recommend postgresql and postgis provided by your linux distribution

GeoServer Extensions Migration Guidance

boundless-server-gs-app-schema	GeoServer Enterprise Premium
boundless-server-gs-arcsde	Unavailable
boundless-server-gs-cloudwatch
boundless-server-gs-cluster
boundless-server-gs-csw	GeoServer Enterprise Premium
boundless-server-gs-db2	GeoServer Enterprise Premium
boundless-server-gs-gdal	GeoServer Enterprise Premium
boundless-server-gs-geomesa-accumulo
boundless-server-gs-grib
boundless-server-gs-gsr
boundless-server-gs-inspire	GeoServer Enterprise Premium
boundless-server-gs-jdbcconfig
boundless-server-gs-jdbcstore
boundless-server-gs-jp2k
boundless-server-gs-mongodb	GeoServer Enterprise Premium
boundless-server-gs-netcdf	GeoServer Enterprise Premium
boundless-server-gs-netcdf-out	GeoServer Enterprise Premium
boundless-server-gs-oracle	GeoServer Enterprise Premium
boundless-server-gs-printing	GeoServer Enterprise Premium
boundless-server-gs-script	Unavailable
boundless-server-gs-spatialstatistics
boundless-server-gs-sqlserver	GeoServer Enterprise Premium
boundless-server-gs-vectortiles	GeoServer Enterprise Premium

Keep in mind that some components such as jdbcconfig and jdbcstore fall outside of GeoCat Enterprise service-level agreement.

• We do not recommend upgrading on a production server. Instead perform a migration to new GeoServer Enterprise installation and transfer your data and settings to the new machine.

  OpenGeo Suite was distributed as a series of packages resulting in a non-standard Tomcat environment making upgrading in-place impractical.

To migrate from Boundless Suite:

1. Locate your GEOSERVER_DATA_DIR:

   • Windows: C:\ProgramData\Boundless\geoserver\data\Data

   • Windows: C:\ProgramData\Boundless\OpenGeo\geoserver

   • Linux: /var/opt/boundless/geoserver/data

   • Linux: /var/lib/opengeo/geoserver

   Make a backup of your data directory:

   cd /var/lib/opengeo
   zip -r data.zip geoserver
   

2. Check for any configuration settings recorded in:

   • /etc/default/tomcat7 service, locate OPENGEO_OPTS:

     OPENGEO_OPTS="-Djava.awt.headless=true -Xms256m -Xmx768m -Xrs -XX:PerfDataSamplingInterval=500 -Dorg.geotools.referencing.forceXY=true
     

   During upgrade any custom settings noted here can be applied to your new system following: Set Java startup options.

3. Check if conf/web.xml has enabled Cross-Origin Resource Sharing (CORS):

   <filter>
     <filter-name>CorsFilter</filter-name>
     <filter-class>org.apache.catalina.filters.CorsFilter</filter-class>
   </filter>
   <filter-mapping>
     <filter-name>CorsFilter</filter-name>
     <url-pattern>/*</url-pattern>
   </filter-mapping>
   

   To enable CORS for your new system: Cross-Origin Resource Sharing (CORS).

4. Follow the GeoSever Enterprise installation instructions:

   • Installation on Linux

   • Installation on Windows

   Transfer your backup (the file :data.zip above) for use when setting up the GEOSERVER_DATA_DIR.

   The file will be unpacked into the recommended location:

   • Linux: /var/opt/geoserver/data

   • Windows: C:\ProgramDataGeoServer\Data

   This GEOSERVER_DATA_DIR configuration will be updated in place as GeoServer starts up.

5. Migrate PostgreSQL / PostGIS database.

   If you made use of Boundless Suite PostGIS database, migrate to the new system following the PostGIS Dump/Restore” instructions.