GeoServer

https://docs.geoserver.org/latest/en/user/
Admin
GeoServer is an open source software server written in Java that allows users to share, edit, and...
Tokens:1,401,720
Snippets:8,770
Trust Score:9.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### Run GeoServer container with extensions installed

Source: https://docs.geoserver.org/latest/en/user/installation/docker/

Starts the container with INSTALL_EXTENSIONS=true and STABLE_EXTENSIONS set to a comma-separated list of extension names. The container downloads and installs the specified extensions during startup.

```bash
docker run -it -p 8080:8080 \
  --env INSTALL_EXTENSIONS=true \
  --env STABLE_EXTENSIONS="ysld,ogcapi-features" \
  docker.osgeo.org/geoserver:3.1.x
```

--------------------------------

### Example ogr2ogrLocation for Windows FWTools

Source: https://docs.geoserver.org/latest/en/user/extensions/ogr/

Example of setting the full path to the ogr2ogr executable when it is not in the default path, as on a Windows box with FWTools installed.

```xml
<ogr2ogrLocation>c:\Programmi\FWTools2.2.8\bin\ogr2ogr.exe</ogr2ogrLocation>
```

--------------------------------

### Configure data directory loader with system properties

Source: https://docs.geoserver.org/latest/en/user/datadirectory/setting/

Example of setting CATALINA_OPTS to enable the loader and use 4 threads when starting GeoServer.

```bash
# Start GeoServer with customized loader settings
CATALINA_OPTS="${CATALINA_OPTS} -DGEOSERVER_DATA_DIR_LOADER_ENABLED=true -DGEOSERVER_DATA_DIR_LOADER_THREADS=4"
```

--------------------------------

### Start a full backup: response with execution id

Source: https://docs.geoserver.org/latest/en/user/community/backuprestore/usagerest/

Example response from the backup POST request. Shows the execution id (0), status STARTED, progress 1/8, and the archive file path. Use the id to poll status and download the archive.

```json
{
  "backup": {
    "execution": {
      "id": 0,
      "status": "STARTED",
      "progress": "1/8",
      "archiveFile": "/var/backups/geoserver/backup1.zip",
      "overwrite": true,
      "options": {
        "option": ["OVERWRITE=true"]
      }
    }
  }
}
```

--------------------------------

### offset Parameter Example

Source: https://docs.geoserver.org/latest/en/user/extensions/monitoring/query/

Example of using the offset parameter to specify where in the result set to start returning records.

```http
requests.html?count=100&offset=500
```

--------------------------------

### Start GeoServer

Source: https://docs.geoserver.org/latest/en/user/installation/linux/

Change into the geoserver/bin directory and execute the startup.sh script to start GeoServer.

```bash
cd geoserver/bin
sh startup.sh
```

--------------------------------

### Start GeoServer with monitor and monitor-kafka extensions

Source: https://docs.geoserver.org/latest/en/user/community/monitor-kafka/usage/

Run this Maven command from the src/web/app directory to start GeoServer with the monitor and monitor-kafka extensions. Initializes the data directory and starts GeoServer.

```bash
mvn jetty:run -P monitor,monitor-kafka
```

--------------------------------

### Example gdalData for Windows FWTools

Source: https://docs.geoserver.org/latest/en/user/extensions/ogr/

Example of setting the GDAL data directory when GDAL_DATA is not set, as on a Windows box with FWTools installed.

```xml
<gdalData>c:\Programmi\FWTools2.2.8\data</gdalData>
```

--------------------------------

### to Parameter Examples

Source: https://docs.geoserver.org/latest/en/user/extensions/monitoring/query/

Examples of using the to parameter to specify an inclusive upper bound on the request start timestamp, with precision to any desired level.

```http
requests.html?to=2010-07-24T00:00:00
```

```http
requests.html?to=2010-07-24
```

--------------------------------

### Example settings in /etc/default/geoserver

Source: https://docs.geoserver.org/latest/en/user/production/linuxscript/

Create this file to set environment variables for the GeoServer init script. Adjust the values to match your environment, such as the user, data directory, GeoServer home, Java home, and Java options.

```bash
USER=geoserver
GEOSERVER_DATA_DIR=/home/$USER/data_dir
GEOSERVER_HOME=/home/$USER/geoserver
JAVA_HOME=/usr/lib/jvm/java-6-sun
JAVA_OPTS="-Xms128m -Xmx512m"

```

--------------------------------

### from Parameter Examples

Source: https://docs.geoserver.org/latest/en/user/extensions/monitoring/query/

Examples of using the from parameter to specify an inclusive lower bound on the request start timestamp, with precision to any desired level.

```http
requests.html?from=2010-07-23T16:16:44
```

```http
requests.html?from=2010-07-23
```

--------------------------------

### Example output of ogr2ogr --help (FWTools 2.2.8)

Source: https://docs.geoserver.org/latest/en/user/extensions/ogr/

Example output from running ogr2ogr --help using the FWTools 2.2.8 distribution. It lists the usage and supported output formats.

```text
Usage: ogr2ogr [--help-general] [-skipfailures] [-append] [-update] [-gt n]
            [-select field_list] [-where restricted_where] 
            [-sql <sql statement>] 
            [-spat xmin ymin xmax ymax] [-preserve_fid] [-fid FID]
            [-a_srs srs_def] [-t_srs srs_def] [-s_srs srs_def]
            [-f format_name] [-overwrite] [[-dsco NAME=VALUE] ...]
            [-segmentize max_dist]
            dst_datasource_name src_datasource_name
            [-lco NAME=VALUE] [-nln name] [-nlt type] [layer [layer ...]]

-f format_name: output file format name, possible values are:
  -f "ESRI Shapefile"
  -f "MapInfo File"
  -f "TIGER"
  -f "S57"
  -f "DGN"
  -f "Memory"
  -f "BNA"
  -f "CSV"
  -f "GML"
  -f "GPX"
  -f "KML"
  -f "GeoJSON"
  -f "Interlis 1"
  -f "Interlis 2"
  -f "GMT"
  -f "SQLite"
  -f "ODBC"
  -f "PostgreSQL"
  -f "MySQL"
  -f "Geoconcept"
-append: Append to existing layer instead of creating new if it exists
-overwrite: delete the output layer and recreate it empty
-update: Open existing output datasource in update mode
-select field_list: Comma-delimited list of fields from input layer to
                    copy to the new layer (defaults to all)
-where restricted_where: Attribute query (like SQL WHERE)
-sql statement: Execute given SQL statement and save result.
-skipfailures: skip features or layers that fail to convert
-gt n: group n features per transaction (default 200)
-spat xmin ymin xmax ymax: spatial query extents
-segmentize max_dist: maximum distance between 2 nodes.
                      Used to create intermediate points
-dsco NAME=VALUE: Dataset creation option (format specific)
-lco  NAME=VALUE: Layer creation option (format specific)
-nln name: Assign an alternate name to the new layer
-nlt type: Force a geometry type for new layer.  One of NONE, GEOMETRY,
     POINT, LINESTRING, POLYGON, GEOMETRYCOLLECTION, MULTIPOINT,
     MULTIPOLYGON, or MULTILINESTRING.  Add "25D" for 3D layers.
     Default is type of source layer.
-a_srs srs_def: Assign an output SRS
-t_srs srs_def: Reproject/transform to this SRS on output
-s_srs srs_def: Override source SRS

Srs_def can be a full WKT definition (hard to escape properly),
or a well known definition (ie. EPSG:4326) or a file with a WKT
definition.
```

--------------------------------

### ListStoredQueries GET request example

Source: https://docs.geoserver.org/latest/en/user/services/wfs/reference/

Lists all stored queries on the server using a GET request. Valid for WFS version 2.0.0 only.

```HTTP
http://example.com/geoserver/wfs?
  request=ListStoredQueries&
  service=wfs&
  version=2.0.0
```

--------------------------------

### Start a full backup: backup_post.json configuration

Source: https://docs.geoserver.org/latest/en/user/community/backuprestore/usagerest/

JSON configuration file for starting a full backup. Specifies the archive file path and overwrite flag. With no options specified, defaults apply.

```json
{
  "backup": {
    "archiveFile": "/var/backups/geoserver/backup1.zip",
    "overwrite": true,
    "options": {}
  }
}
```

--------------------------------

### download.properties configuration example

Source: https://docs.geoserver.org/latest/en/user/extensions/wps-download/

Example configuration for the WPS Download extension, stored in download.properties in the GeoServer data directory. Limits include maxFeatures, rasterSizeLimits, writeLimits, hardOutputLimit, compressionLevel, and maxAnimationFrames. The file is watched and reloaded on modification.

```properties
# Max #of features
maxFeatures=100000
#8000 px X 8000 px
rasterSizeLimits=64000000
#8000 px X 8000 px X 3 bands X 1 byte per band = 192MB
writeLimits=192000000
# 50 MB
hardOutputLimit=52428800
# STORE =0, BEST =8
compressionLevel=4
# When set to 0 or below, no limit
maxAnimationFrames=1000
```

--------------------------------

### DropStoredQuery GET request example

Source: https://docs.geoserver.org/latest/en/user/services/wfs/reference/

Drops a stored query with ID 'myStoredQuery' using a GET request. Valid for WFS version 2.0.0 only.

```HTTP
http://example.com/geoserver/wfs?
  request=DropStoredQuery&
  storedQuery_Id=myStoredQuery
```

--------------------------------

### Create description.ftl with Hello World content

Source: https://docs.geoserver.org/latest/en/user/extensions/kml/tutorials/kmlplacemark/

Start a new file named description.ftl and add the text 'Hello World!' as the template content. Save it in the workspaces/topp/states_shapefile/states directory of the GeoServer data directory (GEOSERVER_DATA_DIR).

```plaintext
Hello World!
```

--------------------------------

### Poll the status of an execution: completed backup response

Source: https://docs.geoserver.org/latest/en/user/community/backuprestore/usagerest/

Example response for a completed backup. Shows status COMPLETED, progress 8/8, timings, exit status, and step executions. The status can be STARTING, STARTED, STOPPING, STOPPED, COMPLETED, FAILED, or ABANDONED. Keep polling while STARTING or STARTED.

```json
{
  "backup": {
    "execution": {
      "id": 0,
      "status": "COMPLETED",
      "progress": "8/8",
      "startTime": "2026-06-06T10:21:14.802",
      "endTime": "2026-06-06T10:21:25.356",
      "exitStatus": {
        "exitCode": "COMPLETED",
        "exitDescription": ""
      },
      "stepExecutions": {
        "step": [
          {
            "name": "backupWorkspacesAndLayers",
            "status": "COMPLETED",
            "exitStatus": { "exitCode": "COMPLETED", "exitDescription": "" },
            "readCount": 12,
            "writeCount": 12,
            "failureExceptions": ""
          }
        ]
      },
      "archiveFile": "/var/backups/geoserver/backup1.zip"
    }
  }
}
```

--------------------------------

### GetCapabilities GET request example

Source: https://docs.geoserver.org/latest/en/user/services/wcs/reference/

A typical GetCapabilities request using a GET request to a WCS server at http://www.example.com/wcs. It includes the required service, AcceptVersions, and request parameters.

```http
http://www.example.com/wcs?
service=wcs&
AcceptVersions=1.1.0&
request=GetCapabilities
```

--------------------------------

### Start Kafka broker and schema registry with docker-compose

Source: https://docs.geoserver.org/latest/en/user/community/monitor-kafka/usage/

Run this command from the test resources directory to start Kafka and schema registry containers. Requires Docker and docker-compose.

```bash
# start kafka
cd src/community/monitor-kafka/src/test/resources
docker-compose up -d
```

--------------------------------

### Initialize the store by listing available coverages

Source: https://docs.geoserver.org/latest/en/user/community/cog/mosaic/

Sends a GET request to list available coverages for the COG mosaic store. The response is an XML list containing the coverage name 'modisvi'.

```bash
curl -v -u admin:geoserver -XGET http://localhost:8080/geoserver/rest/workspaces/test/coveragestores/modisvi/coverages.xml?list=all
```

```xml
<List>
  <coverageName>modisvi</coverageName>
</list>
```

--------------------------------

### DescribeStoredQueries GET request example

Source: https://docs.geoserver.org/latest/en/user/services/wfs/reference/

Describes the stored query with ID 'urn:ogc:def:query:OGC-WFS::GetFeatureById' using a GET request. Valid for WFS version 2.0.0 only.

```HTTP
http://example.com/geoserver/wfs?
  request=DescribeStoredQueries&
  storedQuery_Id=urn:ogc:def:query:OGC-WFS::GetFeatureById
```

--------------------------------

### Get a provider response (JSON)

Source: https://docs.geoserver.org/latest/en/user/rest/authenticationproviders/

Example JSON response for retrieving a specific authentication provider.

```json
{
  "id": "52857278:13c7ffd66a8:-7ff0",
  "name": "default",
  "className": "org.geoserver.security.auth.UsernamePasswordAuthenticationProvider",
  "userGroupServiceName": "default"
}
```

--------------------------------

### Run the import

Source: https://docs.geoserver.org/latest/en/user/extensions/importer/rest_examples/

Executes the import using a POST request to the import endpoint.

```bash
curl -u admin:geoserver -XPOST \
  "http://localhost:8080/geoserver/rest/imports/0"
```

--------------------------------

### Get a provider response (XML)

Source: https://docs.geoserver.org/latest/en/user/rest/authenticationproviders/

Example XML response for retrieving a specific authentication provider.

```xml
<org.geoserver.security.config.UsernamePasswordAuthenticationProviderConfig>
  <id>52857278:13c7ffd66a8:-7ff0</id>
  <name>default</name>
  <className>org.geoserver.security.auth.UsernamePasswordAuthenticationProvider</className>
  <userGroupServiceName>default</userGroupServiceName>
</org.geoserver.security.config.UsernamePasswordAuthenticationProviderConfig>
```

--------------------------------

### Setup PostGIS datastore for import

Source: https://docs.geoserver.org/latest/en/user/extensions/importer/rest_examples/

JSON payload to create a PostGIS datastore named 'postgis' in the 'cite' workspace with connection parameters.

```json
{
  "dataStore": {
    "name": "postgis",
    "type": "PostGIS",
    "workspace": {
      "name": "cite"
    },
    "connectionParameters": {
      "entry": [
        {"@key": "schema","$": "public"},
        {"@key": "database","$": "postgres"},
        {"@key": "host","$": "localhost"},
        {"@key": "port","$": "5432"},
        {"@key": "passwd","$": "postgres"},
        {"@key": "dbtype","$": "postgis"},
        {"@key": "user","$": "postgres"},
        {"@key": "Estimated extends","$": "true"},
        {"@key": "encode functions","$": "true"},
        {"@key": "Loose bbox","$": "true"},
        {"@key": "Method used to simplify geometries","$": "PRESERVETOPOLOGY"},
        {"@key": "Support on the fly geometry simplification","$": "true"},
        {"@key": "validate connections","$": "true"},
        {"@key": "Connection timeout","$": "20"},
        {"@key": "min connections","$": "1"},
        {"@key": "max connections","$": "10"},
        {"@key": "Evictor tests per run","$": "3"},
        {"@key": "Test while idle","$": "true"},
        {"@key": "Max connection idle time","$": "300"}
      ]
    },
    "_default": true
  }
}
```

--------------------------------

### DescribeDomains request URL for testing installation

Source: https://docs.geoserver.org/latest/en/user/extensions/wmts-multidimensional/install/

A simple DescribeDomains request to test if the module is correctly installed. Use this against any layer known by the WMTS service, for example the demo layer tiger:poly_landmarks.

```http
http://localhost:8080/geoserver/gwc/service/wmts?REQUEST=DescribeDomains&Version=1.0.0&Layer=tiger:poly_landmarks&TileMatrixSet=EPSG:4326
```

--------------------------------

### Build and install ZLIB for NetCDF-4

Source: https://docs.geoserver.org/latest/en/user/extensions/netcdf-out/nc4/

Configure and install ZLIB with a prefix of /work/libs/nc4libs. The 'make check install' command runs tests and installs.

```bash
./configure --prefix=/work/libs/nc4libs

make check install
```

--------------------------------

### GET single transformation response

Source: https://docs.geoserver.org/latest/en/user/extensions/importer/rest_reference/

Example JSON response from a GET request to /imports/{importId}/tasks/{taskId}/transforms/{transformId}, showing a single ReprojectTransform with source null and target EPSG:4326.

```json
Status: 200 OK
Content-Type: application/json

{
  "type": "ReprojectTransform", 
  "href": "http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/0", 
  "source": null, 
  "target": "EPSG:4326"
}
```

--------------------------------

### OGC filter encoded in GET request (FES 2.0)

Source: https://docs.geoserver.org/latest/en/user/services/wms/vendor/

Example of an OGC filter encoding standard 2.0 in a GET request. The filter uses PropertyIsLike with wildCard '*', singleChar '.', and escapeChar '!' on the NAME property.

```text
filter=%3Cfes%3AFilter%20xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance%22%20xmlns%3Agml%3D%22http%3A%2F%2Fwww.opengis.net%2Fgml%2F3.2%22%20xmlns%3Awfs%3D%22http%3A%2F%2Fwww.opengis.net%2Fwfs%22%20xmlns%3D%22http%3A%2F%2Fwww.opengis.net%2Ffes%2F2.0%22%20xmlns%3Afes%3D%22http%3A%2F%2Fwww.opengis.net%2Ffes%2F2.0%22%3E%3Cfes%3APropertyIsLike%20wildCard%3D%22*%22%20singleChar%3D%22.%22%20escapeChar%3D%22!%22%3E%3Cfes%3AValueReference%3ENAME%3C%2Ffes%3AValueReference%3E%3Cfes%3ALiteral%3E*United*%3C%2Ffes%3ALiteral%3E%3C%2Ffes%3APropertyIsLike%3E%3C%2Ffes%3AFilter%3E  
```

--------------------------------

### Get list of supported formats with ogr2ogr --help

Source: https://docs.geoserver.org/latest/en/user/extensions/ogr/

Run this command to see the full set of options and supported formats for your ogr2ogr build. The output varies depending on how ogr2ogr was compiled.

```bash
ogr2ogr --help
```

--------------------------------

### GET transformations list response

Source: https://docs.geoserver.org/latest/en/user/extensions/importer/rest_reference/

Example JSON response from a GET request to /imports/{importId}/tasks/{taskId}/transforms, showing a list of transformations with type, href, source, target, field, and format attributes.

```json
Status: 200 OK
Content-Type: application/json

{
  "transforms": [
    {
      "type": "ReprojectTransform", 
      "href": "http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/0", 
      "source": null, 
      "target": "EPSG:4326"
    }, 
    {
      "type": "DateFormatTransform", 
      "href": "http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/1", 
      "field": "date", 
      "format": "yyyyMMdd"
    }
  ]
}
```
Tokens:
Raw