GeoServer

https://docs.geoserver.org/stable/en/user/
Admin
GeoServer is an open source software server written in Java that allows users to share and edit...
Tokens:1,294,973
Snippets:8,355
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start GeoServer with monitor and monitor-kafka profiles

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

Run from src/web/app to start GeoServer with the monitoring extensions. Initializes the data directory and installs default monitor config.

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

```

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

### Offset Parameter Example

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

Example usage of the offset parameter to specify the starting point in the result set.

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

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

### Install GDAL and Java bindings on Ubuntu

Source: https://docs.geoserver.org/stable/en/user/data/raster/gdal

Install GDAL and its Java bindings on Ubuntu and derivatives using apt-get. The libraries are placed in the search path, so no extra setup is normally needed.

```bash
sudo apt-get install gdal-bin libgdal-java

```

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

### Backup execution response

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

Example response from starting a backup, showing the execution object with id, status, progress, and archiveFile.

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

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

### Dynamic palette file example (red to blue progression)

Source: https://docs.geoserver.org/stable/en/user/community/ncwms

Example palette file with a comment line and two colors. Comments start with a percentage sign. Colors can be defined using #RRGGBB, #AARRGGBB, 0xRRGGBB, or 0xAARRGGBB.

```text
% Red to blue progression
#FF0000
#0000FF

```

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

### Sample property file for interpolation

Source: https://docs.geoserver.org/stable/en/user/data/app-schema/property-interpolation

Sample property file with values for the properties used in the mapping file example. Can be installed in WEB-INF/classes/app-schema.properties.

```properties
example.host = database.example.com
example.database = example
example.user = dbuser
example.passwd = s3cr3t
```

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

### XML view parameters example

Source: https://docs.geoserver.org/stable/en/user/data/database/sqlview

Example of the XML format for view parameters. The VP root element contains PS elements for each layer, with P elements for each parameter. Empty PS elements are used for layers without parameters. XML view parameters can only be used in GET requests.

```text
&viewParams=<VP><PS><P n="m1">8302,802,8505</P><P n="m2">22,44</P></PS><PS/><PS><P n="csvInput">acv,rrp;1,0;0,7;22,1</P></PS></VP>

```

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

### Start GeoServer

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

Navigate to the bin directory and execute the startup script to launch the server.

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

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

### Get a provider with curl (XML)

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

GET /security/authproviders/{providerName} retrieves a specific provider. Example uses provider name 'default'.

```bash
curl -u admin:•••• -H "Accept: application/xml" http://localhost:8080/geoserver/rest/security/authproviders/default
```

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

### Start a full backup - configuration file

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

JSON configuration file (backup_post.json) for starting a full backup. With no options specified, defaults apply.

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

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

### GET Filter Chain Response

Source: https://docs.geoserver.org/stable/en/user/rest/api/filterchains

Example response for a GET request to retrieve a filter chain. The response includes the filter chain configuration in JSON format.

```json
{
    "filterChain": {
        "name": "web-test-2",
        "className": "org.geoserver.security.HtmlLoginFilterChain",
        "patterns": {
            "string": [
                "/web/**",
                "/gwc/rest/web/**",
                "/"
            ]
        },
        "filters": {
            "string": [
                "rememberme",
                "form",
                "anonymous"
            ]
        },
        "disabled": false,
        "allowSessionCreation": true,
        "requireSSL": false,
        "matchHTTPMethod": false,
        "position": 0
    }
}
```

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

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

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

Run from the test/resources directory to start Kafka and schema registry containers.

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

```

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

### WFS GetFeature with Excel output (GET)

Source: https://docs.geoserver.org/stable/en/user/extensions/excel

Example of a WFS GetFeature request using the GET method with the outputFormat parameter set to 'excel' or 'excel2007' to receive an Excel file.

```APIDOC
## [GET] /geoserver/wfs

### Description
Performs a WFS GetFeature request and returns the response in Excel 97-2003 (.xls) or Excel 2007 (.xlsx) format, depending on the outputFormat parameter.

### Method
GET

### Endpoint
http://localhost:8080/geoserver/wfs

### Parameters
#### Query Parameters
- **request** (string) - Required - Must be set to `GetFeature`.
- **version** (string) - Required - WFS version, e.g., `1.1.0`.
- **typeName** (string) - Required - The feature type to query, e.g., `topp:states`.
- **outputFormat** (string) - Required - Set to `excel` for Excel 97-2003 or `excel2007` for Excel 2007.

### Request Example
http://localhost:8080/geoserver/wfs?request=GetFeature&version=1.1.0&typeName=topp:states&outputFormat=excel

### Response
#### Success Response (200)
Returns an Excel file in the requested format.

#### Response Example
Binary Excel file content.
```

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

### Example datastore.properties for PostGIS

Source: https://docs.geoserver.org/stable/en/user/extensions/netcdf/netcdf

Configuration file to connect the mosaic to a PostGIS database for indexing.

```properties
SPI=org.geotools.data.postgis.PostgisNGDataStoreFactory
host=localhost
port=5432
database=netcdf
schema=mosaic_indexes
user=user
passwd=pwd
Loose\ bbox=true
Estimated\ extends=false
validate\ connections=true
Connection\ timeout=10
preparedStatements=true
max\ connections=20
```

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

### Build and install ZLIB for NetCDF-4

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

Configure and install ZLIB into the specified prefix directory, then run make check and install.

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

make check install
```

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

### GetLegendGraphic example invocation

Source: https://docs.geoserver.org/stable/en/user/services/wms/get_legend_graphic

Example HTTP GET request to retrieve a legend graphic for the topp:states layer. Returns four 20x20 icons representing the rules of the default style.

```http
http://localhost:8080/geoserver/wms?REQUEST=GetLegendGraphic&VERSION=1.0.0&FORMAT=image/png&WIDTH=20&HEIGHT=20&LAYER=topp:states
```

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

### Start a restore - configuration file

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

JSON configuration file (restore_post.json) for starting a restore from an existing archive on the server.

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

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

### GET /geoserver/ows (GML32)

Source: https://docs.geoserver.org/stable/en/user/services/wfs/axis_order

Example of a WFS 2.0 GetFeature request with GML32 output format.

```APIDOC
## [GET] /geoserver/ows

### Description
Retrieves feature data in GML32 format for WFS 2.0.0 requests.

### Method
GET

### Endpoint
http://localhost:8080/geoserver/ows

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be `WFS`.
- **version** (string) - Required - Must be `2.0.0`.
- **request** (string) - Required - Must be `GetFeature`.
- **typeNames** (string) - Required - The qualified name of the feature type, e.g., `topp:states`.
- **featureId** (string) - Required - The feature identifier, e.g., `states.1`.
- **outputFormat** (string) - Required - Must be `gml32`.

### Response
#### Success Response (200)
Returns a GML32 document containing the feature geometry.

#### Response Example
```xml
<gml:MultiSurface srsName="urn:ogc:def:crs:EPSG::4326" gml:id="states.1.the_geom">
  <gml:surfaceMember>
    <gml:Polygon gml:id="states.1.the_geom.1"><gml:exterior>
      <gml:LinearRing>
        <gml:posList>
          37.51099 -88.071564 37.476273 -88.087883 
        </gml:posList>
      </gml:LinearRing>
    </gml:exterior>
    </gml:Polygon>
  </gml:surfaceMember>
</gml:MultiSurface>
```
```

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

### Example ogr2ogr --help output from FWTools 2.2.8

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

Example output from running 'ogr2ogr --help' with the FWTools 2.2.8 distribution. It shows the usage and the list of 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.

```

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

### GET /geoserver/ows (GML3)

Source: https://docs.geoserver.org/stable/en/user/services/wfs/axis_order

Example of a WFS 2.0 GetFeature request with GML3 output format.

```APIDOC
## [GET] /geoserver/ows

### Description
Retrieves feature data in GML3 format for WFS 2.0.0 requests.

### Method
GET

### Endpoint
http://localhost:8080/geoserver/ows

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be `WFS`.
- **version** (string) - Required - Must be `2.0.0`.
- **request** (string) - Required - Must be `GetFeature`.
- **typeNames** (string) - Required - The qualified name of the feature type, e.g., `topp:states`.
- **featureId** (string) - Required - The feature identifier, e.g., `states.1`.
- **outputFormat** (string) - Required - Must be `gml3`.

### Response
#### Success Response (200)
Returns a GML3 document containing the feature geometry.

#### Response Example
```xml
<gml:MultiSurface srsName="urn:x-ogc:def:crs:EPSG:4326">
  <gml:surfaceMember>
    <gml:Polygon>
      <gml:exterior>
        <gml:LinearRing>
          <gml:posList>
            37.51099 -88.071564 37.476273 -88.087883 
          </gml:posList>
        </gml:LinearRing>
      </gml:exterior>
    </gml:Polygon>
  </gml:surfaceMember>
</gml:MultiSurface>
```
```

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

### Example _auxiliary.xml configuration

Source: https://docs.geoserver.org/stable/en/user/extensions/netcdf/netcdf

An example of the _auxiliary.xml file describing the NetCDF file contents.

```xml
<?xml version="1.0" encoding="UTF-8"?><Indexer>
  <coverages>
    <coverage>
      <schema name="dbz">
        <attributes>
          the_geom:Polygon,imageindex:Integer,time:java.util.Date
        </attributes>
      </schema>
      <origName>dbz</origName>
      <name>dbz</name>
    </coverage>
  </coverages>
</Indexer>
```

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

### Create a basic KML placemark template (description.ftl)

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

Creates a static placemark description that displays the text 'Hello World!'. Save this content in a file named description.ftl in the workspaces/topp/states_shapefile/states directory of the GeoServer data directory. The template is read on every request, so changes are picked up without restarting GeoServer.

```html
Hello World!

```

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

### GET Filter Chain XML Response

Source: https://docs.geoserver.org/stable/en/user/rest/api/filterchains

Example XML response for retrieving a filter chain via GET. The response includes the filter chain configuration with name, class, patterns, filters, and other properties.

```xml
<filterChain>
    <name>web-test-1</name>
    <className>org.geoserver.security.HtmlLoginFilterChain</className>
    <patterns>
        <string>/web/**</string>
        <string>/gwc/rest/web/**</string>
        <string>/</string>
    </patterns>
    <filters>
        <string>rememberme</string>
        <string>form</string>
        <string>anonymous</string>
    </filters>
    <disabled>false</disabled>
    <allowSessionCreation>true</allowSessionCreation>
    <requireSSL>false</requireSSL>
    <matchHTTPMethod>false</matchHTTPMethod>
    <position>1</position>
</filterChain>
```

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

### Check default JVM heap settings

Source: https://docs.geoserver.org/stable/en/user/production/container

Run this command to see the default initial and maximum heap sizes for your hardware. The example output from a 16 GB laptop shows an initial heap of 256 MB and a max heap of about 4 GB (roughly 1/4 of system memory).

```bash
java -XX:+PrintFlagsFinal -version | grep HeapSize
```

```text
uintx InitialHeapSize   := 268435456     {product}
uintx MaxHeapSize       := 4294967296    {product}

```

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

### Install libjpeg-turbo via package manager (Linux)

Source: https://docs.geoserver.org/stable/en/user/extensions/libjpeg-turbo

Commands to install libjpeg-turbo development and Java packages on Linux using the package manager. The source shows 'apt get' but likely means 'apt-get'.

```bash
apt get libjpeg-dev
apt get libjpeg-java

```

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

### TIME parameter examples

Source: https://docs.geoserver.org/stable/en/user/community/ncwms

Examples of TIME parameter syntax for the GetTimeSeries operation, including a time range and a single instant.

```text
TIME=2008-10-31T00:00:00.000Z/2008-11-01T00:00:00.000Z
```

```text
TIME=2008-10-31T00:00:00.000Z/2008-10-31T00:00:00.000Z
```

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

### List environment variables at GeoServer startup (Linux)

Source: https://docs.geoserver.org/stable/en/user/production/config

Use this command on Linux to list all environment variables set at GeoServer startup. Replace ${GEOSERVER_PID} with the actual process ID of the GeoServer process.

```bash
tr '\0' '\n' < /proc/${GEOSERVER_PID}/environ
```

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

### Valid CQL Filters for Backward Mapping

Source: https://docs.geoserver.org/stable/en/user/community/features-templating/querying

Examples of valid CQL filters for querying backward-mapped data. The last example shows how to reference array elements using the index, starting from 1, in the form {attributeName}{index}.

```cql
gsml:GeologicUnit.description = 'some string value'
```

```cql
name in ("MERCIA MUDSTONE", "UNKNOWN")
```

```cql
gsml:positionalAccuracy.valueArray1 = "100"
```

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

### GET /geoserver/ows (GML32 reproject to EPSG:4326)

Source: https://docs.geoserver.org/stable/en/user/services/wfs/axis_order

Example of a WFS 2.0 GetFeature request with GML32 output and reprojection to EPSG:4326.

```APIDOC
## [GET] /geoserver/ows

### Description
Retrieves feature data in GML32 format reprojected to EPSG:4326.

### Method
GET

### Endpoint
http://localhost:8080/geoserver/ows

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be `WFS`.
- **version** (string) - Required - Must be `2.0.0`.
- **request** (string) - Required - Must be `GetFeature`.
- **typeNames** (string) - Required - The qualified name of the feature type, e.g., `topp:states`.
- **featureId** (string) - Required - The feature identifier, e.g., `states.1`.
- **outputFormat** (string) - Required - Must be `gml32`.
- **srsName** (string) - Required - Must be `EPSG:4326`.

### Response
#### Success Response (200)
Returns a GML32 document with coordinates in x/y order (longitude/latitude).

#### Response Example
```xml
<gml:MultiSurface srsName="urn:ogc:def:crs:EPSG::4326" gml:id="states.1.the_geom">
  <gml:surfaceMember>
    <gml:Polygon gml:id="states.1.the_geom.1"><gml:exterior>
      <gml:LinearRing>
        <gml:posList>
          -88.071564 37.51099 -88.087883 37.476273
        </gml:posList>
      </gml:LinearRing>
    </gml:exterior>
    </gml:Polygon>
  </gml:surfaceMember>
</gml:MultiSurface>
```
```

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

### Quick Start: Pull and Run GeoServer Docker Container

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

Pulls and runs the GeoServer Docker container. The container includes a data directory. After running, navigate to http://localhost:8080/geoserver to see the GeoServer Welcome page.

```Docker
docker pull docker.osgeo.org/geoserver:3.0.x

```

```Docker
docker run -it -p 8080:8080 docker.osgeo.org/geoserver:3.0.x

```

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

### GET /geoserver/ows (GML3 reproject to EPSG:4326)

Source: https://docs.geoserver.org/stable/en/user/services/wfs/axis_order

Example of a WFS 2.0 GetFeature request with GML3 output and reprojection to EPSG:4326.

```APIDOC
## [GET] /geoserver/ows

### Description
Retrieves feature data in GML3 format reprojected to EPSG:4326.

### Method
GET

### Endpoint
http://localhost:8080/geoserver/ows

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be `WFS`.
- **version** (string) - Required - Must be `2.0.0`.
- **request** (string) - Required - Must be `GetFeature`.
- **typeNames** (string) - Required - The qualified name of the feature type, e.g., `topp:states`.
- **featureId** (string) - Required - The feature identifier, e.g., `states.1`.
- **outputFormat** (string) - Required - Must be `gml3`.
- **srsName** (string) - Required - Must be `EPSG:4326`.

### Response
#### Success Response (200)
Returns a GML3 document with coordinates in x/y order (longitude/latitude).

#### Response Example
```xml
<gml:MultiSurface srsName="urn:x-ogc:def:crs:EPSG:4326">
  <gml:surfaceMember>
    <gml:Polygon>
      <gml:exterior>
        <gml:LinearRing>
          <gml:posList>
            -88.071564 37.51099 -88.087883 37.476273
          </gml:posList>
        </gml:LinearRing>
      </gml:exterior>
    </gml:Polygon>
  </gml:surfaceMember>
</gml:MultiSurface>
```
```

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

### Example print configuration JSON (info.json response)

Source: https://docs.geoserver.org/stable/en/user/extensions/printing/protocol

The response from the info.json command is a JSON structure containing scales, DPIs, output formats, layouts, and URLs for printing and creating jobs. This example shows a typical configuration.

```json
var printConfig = {
    "scales":[
        {"name":"25000"},
        {"name":"50000"},
        {"name":"100000"}
    ],
    "dpis":[
        {"name":"190"},
        {"name":"254"}
    ],
    "outputFormats":[
        {"name":"pdf"},
        {"name":"png"}
    ],
    "layouts":[
        {
            "name":"A4 portrait",
            "map":{
                "width":440,
                "height":483
            }
        }
    ],
    "printURL":"http:\/\/localhost:5000\/print\/print.pdf",
    "createURL":"http:\/\/localhost:5000\/print\/create.json"
}
```
Tokens:
Raw