GeoServer Extensions

The following extensions are optional. Each adds additional functionality to the GeoServer application.

Please choose the extensions that match the your desired functionality. These extensions can also be installed at a later date.

Application Schema extension

To install Application Schema support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the appschema directory.
  2. Copy the contents of the appschema directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see an entry for Application Schem DataAccess.

    ../../../../_images/appschema_storelink.png

    Application Schema in the list of vector stores

    If you don’t see this entry, the extension did not install correctly.

ArcSDE extension

To install ArcSDE support in GeoServer, you will need to copy some files to the proper location. The first set of files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the arcsde directory.
  2. Copy the contents of the arcsde directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

Because of licensing issues, two additional files are required to be installed.

  1. Copy jsde_sdk.jar and jpe_sdk.jar from the ArcSDE installation media (usually C:\Program Files\ArcGIS\ArcSDE\lib) to the same directory specified above.
  2. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see ArcSDE in the list:

    ../../../../_images/arcsde_storelink.png

    ArcSDE in the list of vector stores

    If you don’t see this entry, the extension itself did not install correctly.

Cloudwatch extension

To install Cloudwatch support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the cloudwatch directory.
  2. Copy the contents of the cloudwatch directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Access your account’s CloudWatch panel.

  2. Select geoserver in the menu on the left.

    ../../../../_images/cloudwatch_panel.png

    CloudWatch panel showing GeoServer

    If you don’t see this entry in the menu on the left, the extension did not install correctly.

  3. There should now be a list of metrics. Click on the checkboxes to add or remove them from the chart.

Clustering extension

To install Clustering support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

Note

The Clustering extension requires JDBCConfig to be installed and enabled. Refer to the instructions further down this page for installing these extensions before proceeding to install Clustering

  1. Inside the Boundless Server extensions bundle, navigate to the cluster directory.
  2. Copy the contents of the cluster directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. You should see a status line about a cluster node:

    ../../../../_images/cluster_status.png

    Clustering status

    If you don’t see this, the extension did not install correctly.

CSW extension

To install CSW support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the csw directory.
  2. Copy the contents of the csw directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. In the list of Services, you should see an entry for CSW.

    ../../../../_images/csw_servicelink.png

    CSW in the list of services

    If you don’t see this entry, the extension did not install correctly.

DB2 extension

To install DB2 support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the db2 directory.
  2. Copy the contents of the db2 directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

Because of licensing issues, two additional files are required to be installed.

  1. Copy db2jcc.jar and db2jcc_license_cu.jar from the java subdirectory of your DB2 installation directory to the same directory specified above.
  2. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see an entry for DB2.

    ../../../../_images/db2_storelink.png

    DB2 in the list of stores

    If you don’t see this entry, the extension did not install correctly.

GDAL extension

  1. In the extensions bundle, navigate to the windows directory.

  2. Run the vcredist_x86.exe file, accepting all defaults.

  3. Inside the same directory, there is a file named GDAL-server-windows.zip. Extract the contents of this archive to an appropriate directory such as C:\GDAL.

  4. Add C:\GDAL to your path:

    Note

    This example shows how to add C:\NEW_DIRECTORY to your Path. Instead of adding C:\NEW_DIRECTORY, add C:\GDAL to your Path.

    1. Open Start and type system environment.

    2. Select Edit the system environment variables.

      ../../../../_images/edit_system_enviro.png
    3. Click Environment Variables.

      ../../../../_images/click_enviro_var.png
    4. In the System Variables section, select Path.

    5. Click Edit...

      ../../../../_images/edit_path.png
    6. Add the path:

      • On Windows 2012 Server:

        1. Add the new directory (from above) to the beginning of the Path Variable value, and ensure you end it with a semicolon (‘’;’‘).

          ../../../../_images/add_path.png
        2. Click OK and then OK again.

      • On Windows 10:

        1. Click New.

        2. Type in the new directory (from above).

          ../../../../_images/win10_edit.png
        3. Click OK and then OK again.

  5. Create a new System Variable called GDAL_DATA that has the value C:\GDAL\gdal_data:

    ../../../../_images/gdal_data_win.png
  6. Verify installation by opening a Command Prompt and typing gdalinfo --version. You should see the version information of the utility.

  7. Use Start ‣ Apache Tomcat ‣ Configure Tomcat to open Apache Tomcat Properties. Switch to the Java tab.

  8. Under Java Options, add the following line:

    -Djava.library.path=C:\GDAL
    
  9. Click Apply.

    Note

    If you already have an existing -Djava.library.path= entry in your Java Options, append the new path to the end of the line, separated by a semicolon. For example:

    -Djava.library.path=C:\libjpeg-turbo\bin;C:\GDAL
    
  10. Inside the Boundless Server extensions bundle, navigate to the gdal directory.

  11. Copy the contents of the gdal directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

  12. Copy the gdal-1.11.2.jar file from C:GDAL to the same library directory as above.

  13. Stop and start the server.

To verify that the GDAL native library extension has been installed properly:

  1. Navigate to the GeoServer web application and login using the admin credentials.

  2. Navigate to the GeoServer Detailed Status Page at http://localhost:8080/geoserver/rest/about/status.

  3. Verify that the GDAL extension is available (Enabled and Available both set to true):

    ../../../../_images/gdal_rest.png

    GDAL available

    If you don’t see this exactly as displayed, the extension did not install correctly.

  4. Click Stores then Add new store.

  5. In the list of Raster Data Stores, you should see extra raster formats, such as MrSID, EHdr, and NITF.

    ../../../../_images/gdal_storelinks.png

    GDAL formats in the list of raster stores

    If you don’t see these entries, the extension did not install correctly.

GeoMesa extension

To install GeoMesa support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Suite extensions bundle (BoundlessSuite-ext.zip).

  1. The GeoMesa extension depends on the GDAL extension, so install that first.
  2. Inside the Boundless Suite extensions bundle, navigate to the geomesa directory.
  3. Copy the contents of the geomesa directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  4. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. You should see a menu titled GeoMesa.

    ../../../../_images/geomesa_menu.png

    GeoMesa menu

    If you don’t see this menu, the extension did not install correctly.

  3. Click Stores then Add new store.

  4. In the list of Vector Data Stores, you should see an entry for Accumulo (GeoMesa).

    ../../../../_images/geomesa_storelink.png

    GeoMesa in the list of raster stores

    If you don’t see this entry, the extension did not install correctly.

GRIB extension

To install GRIB support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the grib directory.
  2. Copy the contents of the grib directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Raster Data Stores, you should see an entry for GRIB.

    ../../../../_images/grib_storelink.png

    GRIB in the list of raster stores

    If you don’t see this entry, the extension did not install correctly.

GeoServices REST Extension

To install :ref:GeoServices REST <intro.extensions.gsr>` support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the gsr directory.
  2. Copy the contents of the gsr directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Navigate to http://localhost:8080/geoserver/gsr/services/. You should see a list of services based on your workspaces. If you get a 404 or other error, the extension did not install properly.

INSPIRE extension

To install INSPIRE support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the inspire directory.
  2. Copy the contents of the inspire directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Under Services, click WMS.

  3. Scroll to the bottom of the page and look for a section titled INSPIRE.

    ../../../../_images/inspire_config.png

    INSPIRE in the list of WMS configuration options

    If you don’t see this entry, the extension did not install correctly.

JDBCConfig extension

To install JDBCConfig support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the jdbcconfig directory.

  2. Copy the contents of the jdbcconfig directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

  3. Restart the server.

  4. On startup, JDBCConfig will create a configuration directory jdbcconfig in the GeoServer data directory. Verify this directory exists.

    Note

    If unsure of the location of the GeoServer data directory, log in to the GeoServer web interface and click Server Status. The location of the Data directory will be displayed at the top.

  5. Stop the server.

  6. In the jdbcconfig directory, edit the jdbcconfig.properties file to enable JDBCConfig. Be sure to set enabled, initdb, and import to true. Provide the connection information for an empty database. For more information, refer to JDBCConfig Configuration in the GeoServer documentation.

    Warning

    Setting up a database for the data directory is a one-way process. It is not currently possible to export the configuration back to a file-based data directory.

  7. Restart the server again. This time JDBCConfig will connect to the specified database, initialize it, import the old catalog into it, and take over from the old catalog. Subsequent start ups will skip the initialize and import steps unless you re-enable them in jdbcconfig.properties.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. You should see a status line about JDBCConfig:

    ../../../../_images/jdbcconfig_status.png

    JDBCConfig status

    If you don’t see this, the extension did not install correctly.

JDBCStore extension

To install JDBCStore support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the jdbcstore directory.

  2. Copy the contents of the jdbcstore directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

  3. Restart the server.

  4. On startup, JDBCStore will create a configuration directory jdbcstore in the GeoServer data directory. Verify this directory exists.

    Note

    If unsure of the location of the GeoServer data directory, log in to the GeoServer web interface and click Server Status. The location of the Data directory will be displayed at the top.

    Note

    If you are using JDBCConfig alongside JDBCStore, be sure to configure it before configuring JDBCStore.

  5. Stop the server.

  6. In the jdbcstore directory, edit the jdbcstore.properties file to enable JDBCStore. Be sure to set enabled, initdb, and import to true. Provide the connection information for an empty database. For more information, refer to JDBCStore Configuration in the GeoServer documentation.

  7. Restart the server again. This time JDBCStore will connect to the specified database, initialize it, import the old GeoServer data directory into it, and take over from the old GeoServer data directory. Subsequent start ups will skip the initialize and import steps unless you re-enable them in jdbcstore.properties.

To verify that the extension has been installed properly:

  1. Open your GeoServer data directory.

    Note

    If unsure of the location of the GeoServer data directory, log in to the GeoServer web interface and click Server Status. The location of the Data directory will be displayed at the top.

  2. Open the file logs/geoserver.log. The last two lines should look similar to:

    2016-09-12 22:05:19,315 INFO [geoserver.jdbcloader] - JDBCConfig using JDBC DataSource Optional.of(jdbc:postgresql://localhost:5432/gsdata)
    2016-09-12 22:05:19,560 INFO [jdbcstore.internal] - Initializing Resource Store Database.
    

    If this is not the case, the extension did not install correctly.

JPEG 2000 extension

To install JPEG 2000 support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the jp2k directory.
  2. Copy the contents of the jp2k directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Raster Data Stores, you should see an entry for JP2K (Direct).

    ../../../../_images/jp2k_storelink.png

    JPEG 2000 in the list of raster stores

    If you don’t see this entry, the extension did not install correctly.

MongoDB extension

To install MongoDB support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the mongodb directory.
  2. Copy the contents of the mongodb directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see an entry for MongoDB.

    ../../../../_images/mongodb_storelink.png

    MongoDB in the list of vector stores

    If you don’t see this entry, the extension did not install correctly.

NetCDF extension

Note

There are different extensions for NetCDF: one for reading data, one for providing output formats (writing data), and one for providing NetCDF 4 specifically as an output format (writing data).

Data store support

To install NetCDF support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the netcdf directory.
  2. Copy the contents of the netcdf directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the data store extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Raster Data Stores, you should see an entry for NetCDF.

    ../../../../_images/netcdf_storelink.png

    NetCDF in the list of raster stores

    If you don’t see this entry, the extension did not install correctly.

NetCDF output format

To install NetCDF output support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the netcdf-out directory.
  2. Copy the contents of the netcdf-out directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the output format extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Global under Settings.

  3. Toward the bottom, you should see a section titled NetCDF Output Settings.

    ../../../../_images/netcdf-out_config.png

    NetCDF output settings in the list of raster stores

    If you don’t see this entry, the extension did not install correctly.

NetCDF 4 output format

To output specifically in NetCDF 4 format, you must install the NetCDF output format extension and also the native NetCDF library. The instructions for the latter are below.

  1. In the extensions bundle, navigate to the windows directory.
  2. Run the netCDF4.4.1-NC4-32.exe installer, making sure to select Add netCDF to the system PATH for all users, but accepting all other defaults
../../../../_images/netcd4_path_win.png
  1. Open a Command Prompt and type ncdump. You should see the following output:
../../../../_images/ncdf4-cmd-win.png
  1. Use Start ‣ Apache Tomcat ‣ Configure Tomcat to open Apache Tomcat Properties. Switch to the Java tab.

  2. Under Java Options, add the following line (changing the path to your installation as necessary):

    -Djna.library.path=C:\Program Files (x86)\netCDF 4.4.1\bin
    
../../../../_images/ncdf4-config-win.png
  1. Click Apply.
  2. Stop and start the server.

To verify that the NetCDF native library extension has been installed properly:

  1. Navigate to the GeoServer web application and login using the admin credentials.

  2. Navigate to the GeoServer Detailed Status Page at http://localhost:8080/geoserver/rest/about/status.

  3. Search for “NetCDF Output” on the page and verify that the binary is available.

    ../../../../_images/ncdf4-status.png

    NetCDF 4 output settings

Oracle extension

To install Oracle support in GeoServer, you will need to copy some files to the proper location. The first set of files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the oracle directory.
  2. Copy the contents of the oracle directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

Because of licensing issues, an additional file is required to be installed.

  1. Copy the Oracle JDBC driver from your Oracle installation to the same directory specified above. This file, often named ojdbc##.jar, can be found either on the installation media or by doing a search on the system that includes Oracle.
  2. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see three entries that mention Oracle:

    ../../../../_images/oracle_storelink.png

    Oracle in the list of vector stores

    If you don’t see all three entries, then the Oracle JDBC driver was not copied to the correct location. The file must be copied to the same directory as the rest of the extension files.

    If you don’t see any entries, the extension itself did not install correctly.

Printing extension

To install Printing support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the printng directory.
  2. Copy the contents of the printng directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

Scripting extension

To install the Scripting extension in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the script directory.
  2. Copy the contents of the script directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Open your GeoServer data directory.

    Note

    If unsure of the location of the GeoServer data directory, log in to the GeoServer web interface and click Server Status. The location of the Data directory will be displayed at the top.

  2. There should be a directory called scripts created. This is where scripts can be created.

    If you don’t see this directory or these files, the extension did not install correctly.

SQL Server extension

To install SQL Server support in GeoServer, you will need to copy some files to the proper location. The first set of files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the sqlserver directory.
  2. Copy the contents of the sqlserver directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.

Because of licensing issues, additional files are required to be installed. These files can be found as part of the Microsoft JDBC Drivers for SQL Server archive available from Microsoft.

  1. Copy sqljdbc4.jar to the same directory specified above.
  2. Copy sqljdbc_auth.dll and sqljdbc_xa.dll to C:\Windows\System32.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Stores then Add new store.

  3. In the list of Vector Data Stores, you should see Microsoft SQL Server in the list:

    ../../../../_images/sqlserver_storelink.png

    SQL Server in the list of vector stores

    If you don’t see this entry, the extension itself did not install correctly.

Vector tiles extension

To install Vector tiles support in GeoServer, you will need to copy some files to the proper location. The files to be copied are inside the Boundless Server extensions bundle (BoundlessSuite-ext.zip).

  1. Inside the Boundless Server extensions bundle, navigate to the vectortiles directory.
  2. Copy the contents of the vectortiles directory into the library directory (WEB-INF\lib) of your GeoServer instance. For example, if your GeoServer application is located at C:\Program Files\Tomcat\webapps\geoserver, copy the files to C:\Program Files\Tomcat\webapps\geoserver\WEB-INF\lib.
  3. Restart the server.

To verify that the extension has been installed properly:

  1. Log in to the GeoServer web interface.

  2. Click Layers and select a layer.

  3. Click the Tile Caching tab.

  4. Scroll down to the section on Tile Formats. In addition to the standard GIF/PNG/JPEG formats, you should see the following:

    • application/json;type=geojson
    • application/json;type=topojson
    • application/x-protobuf;type=mapbox-vector
    ../../../../_images/vectortiles_tileformats1.png

    Vector tiles tile formats

    If you don’t see these options, the extension did not install correctly.