Installation on Windows

To install GeoServer Enterprise in MS Windows, follow these steps.

Java Runtime Environment

GeoServer Enterprise requires a Java 8 runtime Environment.

OpenJDK is now the lead project for the Java ecosystem. As an open-source company GeoCat is pleased to see OpenJDK supported by a number of different distributions.

To install the OpenJDK JRE, follow these steps:

  1. Navigate to the AdoptOpenJDK download page

  2. Select OpenJDK 8 (LTS) as the version to download.

    ../_images/openjdk8.png

  3. Select Windows as your Operating System.

    ../_images/openjdkwindows.png

  4. Select the corresponding architecture for your system in the Architecture field.

    ../_images/openjdkarchitecture.png

  5. Click on the available JRE zip file download link for the above selected options, to download the OpenJDK prebuilt binary.

    ../_images/openjdkdownloadlink.png

  6. In your system, create a folder called java under your Program files folder.

  7. Extract the content of the downloaded zip file into that folder. Your folder structure under the Program Files folder should now look like this:

    ../_images/jdkfilestructure.png

  8. Open the Windows System configuration by going to Start Menu ‣ Control Panel ‣ System and then click on the Advanced system settings link. Move to the Advanced tab.

    ../_images/winsystemsettings.png

  9. Click on the Environment variables button.

    ../_images/winenvvariables.png

  10. In the System variables section, click on New to create a new variable. Enter the following values to configure the new variable:

    ../_images/winjavahome.png

  11. Edit the Path variable by selecting it and clicking on Edit.

    ../_images/winpathvariable.png

  12. Click on New to add a new line to the variable and enter %JAVA_HOME%bin to add the Java JRE folder to your system PATH.

    ../_images/winpathvariable2.png

  13. Close the Environment variables and Windows System configuration dialog.

  14. To ensure that Java is now correctly installed, open a console and type java -version. The output should look something like this:

    > java -version
openjdk version "1.8.0_242"
OpenJDK Runtime Environment (AdoptOpenJDK)(build 1.8.0_242-b08)
OpenJDK 64-Bit Server VM (AdoptOpenJDK)(build 25.242-b08, mixed mode)

Apache Tomcat

Apache Tomcat is the leading open source application server.

GeoServer Enterprise supports Apache Tomcat 8.5.x or 9.0.x.

To install Tomcat, follow these steps:

  1. Visit the Apache Tomcat Download page.

  2. Under Binary Distirbutions download 32-bit/64-bit Windows Service Installer (pgp, sha512).

    ../_images/tomcat_download.png

  3. Run the installer file.

    • Choose Components page, select the Native and Service Startup, and Manager options.

      ../_images/tomcatinstalloptions.png

    • Configuration page: provide Tomcat Administrator Login credentials:

      User Name

      admin

      Password:

      tomcat (example)

      Roles

      manager-gui
      ../_images/wintomcatconfiguration.png

  4. Once installed, Tomcat has to be correctly configured to provide a better performance when running GeoServer Enterprise. The first thing to configure are its Java Virtual Machine runtime parameters.

    Open the Tomcat Properties dialog by selecting the Apache Tomcat ‣ Configure Tomcat menu entry in the Windows Start menu. Move to the Java tab.

    ../_images/tomcatproperties.png

    • Add the highlighted lines below to Java Options:

      -Dcatalina.home=C:\Program Files\Apache Software Foundation\Tomcat 9.0
-Dcatalina.base=C:\Program Files\Apache Software Foundation\Tomcat 9.0
-Djava.io.tmpdir=C:\Program Files\Apache Software Foundation\Tomcat 9.0\temp
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf\logging.properties
-XX:SoftRefLRUPolicyMSPerMB=36000
-XX:-UsePerfData
-Dorg.geotools.referencing.forceXY=true

    • Set the memory options to:

      Initial memory pool:

      512 MB

      Maximum memory pool:

      1536 MB

    Restart the service for these changes to take effect.

Note

Optional

Environment variables can be managed using the optional bin/setup.bat file:

  • JAVA_HOME

  • CATALINA_OPTS: additional Java startup options used when launching Tomcat

SET CATALINA_OPTS="-XX:SoftRefLRUPolicyMSPerMB=36000 -XX:-UsePerfData -Dorg.geotools.referencing.forceXY=true"

Data Directory

GeoServer places all its required configuration files in a so-called data directory. It’s recommended to change its default location and set up a new one explicitely. To do so, follow these steps:

  1. Create a folder to hold your GeoServer Enterprise configuration:

    • C:\ProgramData\GeoServer\

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

    Navigate to the latest geoserver release, we have a choice of two ready to use data directories to download:

    • geoserver-data-standard - services setup, includes sample layers

    • geoserver-data-default - services setup only

    ../_images/nexus-download.png

    Locate latest geoserver data zip archives

  3. Unzip, and copy the data folder to C:\ProgramData\GeoServer\data.

  4. Create the tilecache folder.

    • C:\ProgramData\GeoServer\tilecache

  5. Update the Tomcat configuration with this data directory location.

    • Open the Tomcat folder, by selecting the Apache Tomcat ‣ Tomcat Program Directory menu entry in the Windows Start menu.

    • Navigate to the conf\catalina\localhost subfolder.

    • In the localhost folder, create a geoserver.xml file, with the following content:

      <Context docBase="geoserver.war">
  <Parameter name="GEOSERVER_DATA_DIR"
             value="C:\ProgramData\GeoServer\data" override="false"/>
  <Parameter name="GEOSERVER_REQUIRE_FILE"
             value="C:\ProgramData\GeoServer\data\global.xml" override="false"/>
  <Parameter name="GEOWEBCACHE_CACHE_DIR"
             value="C:\ProgramData\GeoServer\tilecache" override="false"/>
</Context>

Note

Starting with an empty data directory

GeoServer can also be configured to start with an empty folder, GeoServer will generate configuration files to this folder the first time it runs:

  • Create an empty folder C:\ProgramData\GeoServer\data

  • Remove the GEOSERVER_REQUIRE_FILE startup check for global.xml:

    <Parameter name="GEOSERVER_REQUIRE_FILE"
   value="/var/opt/geoserver/data/global.xml" override="false"/>

This approach is often used in automated workflow where GeoServer is configured via REST API scripts.

GeoServer Enterprise

To install GeoServer on your existing Tomcat instance, follow these steps:

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

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

    ../_images/nexus-download.png

  2. Unzip this file containing:

    • windows - sample configuration files

    • geoserver.war - geoserver enterprise web application

    • GPL and LICENSE.txt open source license information

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

    ../_images/tomcatprogramfolder.png

  4. Open the webapps folder.

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

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

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

    ../_images/gserunning.png