ldproxy

https://docs.ldproxy.net/
Admin
ldproxy is a comprehensive OGC API implementation that makes geospatial data findable, accessible,...
Tokens:63,434
Snippets:861
Trust Score:6.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Start ldproxy with Docker

Source: https://docs.ldproxy.net/10-installation

Run this command to download the latest ldproxy image, deploy it as a container, expose port 7080, and persist data to a local directory.

```bash
docker run --name ldproxy -d -p 7080:7080 -v ~/ldproxy_data:/data iide/ldproxy:latest

```

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

### Examples for Reloading Entity Configuration

Source: https://docs.ldproxy.net/tools/xtractl/commands

Examples demonstrate reloading all services, a single ID, or multiple IDs.

```bash
xtractl entity reload "*" -t services

```

```bash
xtractl entity reload id1

```

```bash
xtractl entity reload id1,id2

```

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

### Examples for Switching Log Filters

Source: https://docs.ldproxy.net/tools/xtractl/commands

Examples show how to enable specific filters or disable all filters.

```bash
xtractl log filter sqlQueries,sqlResults

```

```bash
xtractl log filter "*" --disable

```

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

### Install ldproxy and xtratiler with Docker Compose

Source: https://docs.ldproxy.net/tools/xtratiler

This docker-compose.yml example shows how to install and configure both ldproxy and xtratiler. Ensure both containers mount the same store directory and xtratiler can access ldproxy's port.

```yaml
services:
  ldproxy:
    image: iide/ldproxy:latest
    restart: always
    ports:
      - "7080:7080"
    volumes:
      - /path/to/store:/data

  xtratiler:
    image: ghcr.io/ldproxy/xtratiler:latest
    restart: always
    command: agent -q http://ldproxy:7081 -c 32 -r 2
    volumes:
      - /path/to/store:/store

```

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

### Examples for xtracfg upgrade entities

Source: https://docs.ldproxy.net/tools/xtracfg/commands

Examples demonstrating how to upgrade entities, with and without specifying a file path.

```bash
xtracfg upgrade entities -v -r

```

```bash
xtracfg upgrade entities -v -r store/entities/services/api.yml

```

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

### Foundation Building Block Configuration Example

Source: https://docs.ldproxy.net/services/building-blocks/foundation

An example configuration for the Foundation building block, demonstrating how to set the API catalog label, description, and other options.

```yaml
- buildingBlock: FOUNDATION
  includeLinkHeader: true
  useLangParameter: false
  apiCatalogLabel: 'Demonstration APIs using ldproxy'
  apiCatalogDescription: 'The APIs below are available as examples for Web APIs that can be set up with <a href="https://github.com/interactive-instruments/ldproxy" >ldproxy</a>.'

```

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

### Examples for xtracfg check entities

Source: https://docs.ldproxy.net/tools/xtracfg/commands

Examples demonstrating how to check entities, with and without specifying a file path.

```bash
xtracfg check entities -v -r

```

```bash
xtracfg check entities -v -r store/entities/services/api.yml

```

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

### 3D Tiles Features Provider Configuration Example

Source: https://docs.ldproxy.net/providers/tile3d/10-features

Example configuration for a 3D Tiles Features provider, specifying seeding behavior, cache types, and tileset defaults.

```yaml
id: cologne_lod2-3dtiles
providerType: 3DTILE
providerSubType: FEATURES
seeding:
  runOnStartup: true
  purge: true
  jobSize: S
caches:
- type: DYNAMIC
  seeded: true
  levels:
    min: 0
    max: 2
tilesetDefaults:
  featureProvider: cologne_lod2
  clampToEllipsoid: true
tilesets:
  building:
    id: building
    featureType: building
    geometricErrorRoot: 4096.0
    subtreeLevels: 3
    contentLevels:
      min: 2
      max: 2

```

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

### Example Codelist Configuration

Source: https://docs.ldproxy.net/auxiliaries/codelists

This example demonstrates the structure of a codelist file, mapping original values to human-readable labels for HTML representation. It includes a human-readable label and a map of entries.

```yaml
---
label: Umweltbereich, für den Umweltziele festgelegt werden können.
entries:
  air: Luft
  climateAndClimateChange: Klima und Klimawandel
  healthProtection: Gesundheitsschutz
  landUse: Bodennutzung
  naturalResources: natürliche Ressourcen
  natureAndBiodiversity: Natur und biologische Vielfalt
  noise: Lärm
  soil: Boden
  sustainableDevelopment: nachhaltige Entwicklung
  waste: Abfall
  water: Wasser

```

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

### Configure Tile Matrix Sets

Source: https://docs.ldproxy.net/services/building-blocks/tile_matrix_sets

Example configuration for enabling and including predefined tile matrix sets.

```yaml
- buildingBlock: TILE_MATRIX_SETS
  enabled: true
  includePredefined:
  - WebMercatorQuad
  - WorldCRS84Quad
  - WorldMercatorWGS84Quad

```

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

### Configure FEATURES_HTML for API

Source: https://docs.ldproxy.net/services/building-blocks/features_-_html

Example of the specifications in the configuration file for the entire API.

```yaml
- buildingBlock: FEATURES_HTML
  enabled: true
  style: 'topographic-with-basemap'

```

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

### Configure MBTiles Provider

Source: https://docs.ldproxy.net/providers/tile/30-mbtiles

Example configuration for the MBTiles provider, specifying the source MBTiles file.

```yaml
id: zoomstack-tiles
providerType: TILE
providerSubType: MBTILES
tilesets:
  __all__:
    id: __all__
    source: zoomstack/OS_Open_Zoomstack.mbtiles

```

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

### Example for Changing Log Level

Source: https://docs.ldproxy.net/tools/xtractl/commands

Sets the log level to DEBUG.

```bash
xtractl log level DEBUG

```

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

### xtracfg Help Commands (Binary)

Source: https://docs.ldproxy.net/tools/xtracfg

View help information for the xtracfg CLI and its subcommands when installed as a binary.

```bash
xtracfg --help
```

```bash
xtracfg check --help
```

```bash
xtracfg check entities --help
```

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

### Specify Source Directory (Binary)

Source: https://docs.ldproxy.net/tools/xtracfg

Run xtracfg commands on a specific directory when using the binary installation.

```bash
xtracfg --src /ldproxy/data info
```

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

### Configure Feature Collections Building Block

Source: https://docs.ldproxy.net/services/building-blocks/feature_collections

Example configuration for the COLLECTIONS building block, including additional links for related resources.

```yaml
- buildingBlock: COLLECTIONS
  additionalLinks:
  - rel: related
    type: text/html
    title: 'Weinlagen-Online website (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/portal/weinlagen.html'
    hreflang: de
  - rel: related
    type: application/xml
    title: 'OGC Web Map Service with the data (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/cgi-bin/mapserv?map=/data/_map/weinlagen/einzellagen_rlp.map&service=WMS&request=GetCapabilities'
    hreflang: de
  - rel: related
    type: application/xml
    title: 'OGC Web Feature Service with the data (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/geoserver/lwk/ows?service=WFS&request=getcapabilities'
    hreflang: de
  - rel: enclosure
    type: application/x-shape
    title: 'Download the data as a shapefile (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/geoserver/lwk/ows?service=WFS&version=1.0.0&request=GetFeature&typeName=lwk:Weinlagen&outputFormat=shape-zip'
    hreflang: de

```

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

### Configure Common Core Building Block

Source: https://docs.ldproxy.net/services/building-blocks/common_core

Example configuration for the COMMON building block, enabling it and setting caching headers and additional links for the Landing Page resource.

```yaml
- buildingBlock: COMMON
  enabled: true
  caching:
    lastModified: '2021-07-01T00:00:00Z'
    expires: '2023-06-30T23:59:59Z'
    cacheControl: max-age=86400
    cacheControlItems: max-age=3600
  additionalLinks:
  - rel: describedby
    type: text/html
    title: Website with additional information
    href: 'https://example.com/path/to/document'
    hreflang: en

```

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

### Enable Additional Metadata Building Block

Source: https://docs.ldproxy.net/services/building-blocks/additional_metadata

Configuration example to enable the ADDITIONAL_METADATA building block. Ensure 'buildingBlock' is set to 'ADDITIONAL_METADATA' and 'enabled' is true.

```yaml
- buildingBlock: ADDITIONAL_METADATA
  enabled: true

```

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

### Configure GeoJSON-LD Building Block

Source: https://docs.ldproxy.net/services/building-blocks/features_-_geojson-ld

Example configuration for the GEO_JSON_LD building block, enabling it and specifying context and ID templates.

```yaml
- buildingBlock: GEO_JSON_LD
  enabled: true
  context: '{{serviceUrl}}/collections/{{collectionId}}/context'
  types:
  - geojson:Feature
  - sosa:Observation
  idTemplate: '{{serviceUrl}}/collections/{{collectionId}}/items/{{featureId}}'

```

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

### Configure JSON Building Block

Source: https://docs.ldproxy.net/services/building-blocks/json

Example of how to configure the JSON building block, disabling it by setting 'enabled' to false.

```yaml
- buildingBlock: JSON
  enabled: false

```

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

### Configure GLTF Building Block

Source: https://docs.ldproxy.net/services/building-blocks/features_-_gltf

Example configuration for the GLTF building block, enabling various features like normals, quantization, and defining properties for export.

```yaml
- buildingBlock: GLTF
  enabled: true
  withNormals: true
  polygonOrientationNotGuaranteed: true
  meshQuantization: true
  properties:
    gml_id:
      type: STRING
      stringOffsetType: UINT16
      noData: ''
    function:
      type: STRING
      stringOffsetType: UINT16
      noData: ''
    roofType:
      type: ENUM
      componentType: UINT16
      noData: 0
    name:
      type: STRING
      stringOffsetType: UINT16
      noData: ''

```

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

### JSON_FG Output Example

Source: https://docs.ldproxy.net/services/building-blocks/features_-_json-fg

Illustrates the output object type for a given 'F_CODE' value, such as 'GB075', when 'role: TYPE' is configured.

```json
{
  "type": "Feature",
  "id": 1,
  "featureType": "nas:GB075",
  ...
}

```

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

### Configure FEATURES_HTML with CesiumJS

Source: https://docs.ldproxy.net/services/building-blocks/features_-_html

Example of using CesiumJS for building data that is partially composed of building components, with the floor slab used as a fallback.

```yaml
- buildingBlock: FEATURES_HTML
  mapClientType: CESIUM
  geometryProperties:
  - consistsOfBuildingPart.lod1Solid
  - lod1Solid
  - lod1GroundSurface

```

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

### Enable FlatGeobuf Building Block

Source: https://docs.ldproxy.net/services/building-blocks/features_-_flatgeobuf

Configure the FlatGeobuf building block to be enabled. This is a basic setup to activate the feature encoding.

```yaml
- buildingBlock: FLATGEOBUF
  enabled: true

```

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

### Configure FEATURES_HTML for Feature Collection

Source: https://docs.ldproxy.net/services/building-blocks/features_-_html

Example of the specifications in the configuration file for a feature collection, including item label formatting and transformations.

```yaml
- buildingBlock: FEATURES_HTML
  itemLabelFormat: '{{ZI005_FNA}}'
  transformations:
    F_CODE:
      codelist: f_code
    ZI001_SDV:
      dateFormat: MM/dd/yyyy[', 'HH:mm:ss[' 'z]]
    RTY:
      codelist: rty
    FCSUBTYPE:
      codelist: fcsubtype
    TRS:
      codelist: trs
    RIN_ROI:
      codelist: roi
    ZI016_WTC:
      codelist: wtc
    RLE:
      codelist: rle
    LOC:
      codelist: loc

```

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

### String Formatting with Remove Prefix

Source: https://docs.ldproxy.net/providers/details/transformations

Use `stringFormat` with the `replace` filter to remove characters from the beginning of a string. This example removes all non-digit characters from the start.

```string
{{value | replace:'^[^0-9]*':''}}
```

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

### GeoJSON Feature Encoding Example

Source: https://docs.ldproxy.net/services/building-blocks/features_-_geojson

This example shows a GeoJSON Feature object before and after flattening properties. Flattening is configured via the 'transformations' option.

```json
{
  "type" : "Feature",
  "id" : "1",
  "geometry" : {
    "type" : "Point",
    "coordinates" : [ 7.0, 50.0 ]
  },
  "properties" : {
    "name" : "Beispiel",
    "inspireId" : "https://example.org/id/soziales/kindergarten/1",
    "serviceType" : {
      "title" : "Kinderbetreuung",
      "href" : "https://inspire.ec.europa.eu/codelist/ServiceTypeValue/childCareService"
    },
    "pointOfContact" : {
      "address" : {
        "thoroughfare" : "Beispielstr.",
        "locatorDesignator" : "123",
        "postCode" : "99999",
        "adminUnit" : "Irgendwo"
      },
      "telephoneVoice" : "0211 16021740"
    },
    "occupancy" : [ {
      "typeOfOccupant" : "vorschule",
      "numberOfOccupants" : 20
    }, {
      "typeOfOccupant" : "schulkinder",
      "numberOfOccupants" : 25
    } ]
  }
}
```

```json
{
  "type" : "Feature",
  "id" : "1",
  "geometry" : {
    "type" : "Point",
    "coordinates" : [ 7.0, 50.0 ]
  },
  "properties" : {
    "name" : "Beispiel",
    "inspireId" : "https://example.org/id/soziales/kindergarten/1",
    "serviceType.title" : "Kinderbetreuung",
    "serviceType.href" : "https://inspire.ec.europa.eu/codelist/ServiceTypeValue/childCareService",
    "pointOfContact.address.thoroughfare" : "Otto-Pankok-Str.",
    "pointOfContact.address.locatorDesignator" : "29",
    "pointOfContact.address.postCode" : "40231",
    "pointOfContact.address.adminUnit" : "Düsseldorf",
    "pointOfContact.telephoneVoice" : "0211 16021740",
    "occupancy.1.typeOfOccupant" : "vorschule",
    "occupancy.1.numberOfOccupants" : 20,
    "occupancy.2.typeOfOccupant" : "schulkinder",
    "occupancy.2.numberOfOccupants" : 25
  }
}
```

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

### Configure PubSub Building Block

Source: https://docs.ldproxy.net/services/building-blocks/pubsub

Example configuration for enabling the PubSub building block, specifying MQTT brokers, publisher ID, and publication rules for different topic structures.

```yaml
buildingBlock: PUB_SUB
enabled: true
brokers:
  t19:
    host: t19.ldproxy.net
    port: 8883
publisher: ${PUBLISHER:-t19.ldproxy.net}
publications:
  items:
    broker: t19
    mqttQos: AT_MOST_ONCE
  '{wigos_station_identifier}/{observed_property}':
    parameters:
      wigos_station_identifier: wigos_station_identifier
      observed_property: name
    property: value
    broker: t19
    mqttQos: AT_MOST_ONCE
    retain: true

```

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

### Configure INSTANCES from local ZIP

Source: https://docs.ldproxy.net/application/20-configuration/10-store-new

Use FS type store to load INSTANCES from a local ZIP archive. The ZIP file should contain the entity definitions.

```yaml
store:
  sources:
  - type: FS
    content: INSTANCES
    src: /path/to.zip

```

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

### Get Specific Resource

Source: https://docs.ldproxy.net/services/building-blocks/resources

Fetches the file resource with the specified identifier.

```APIDOC
## GET /resources/{resourceId}

### Description
Fetches the file resource with identifier `resourceId`.

### Method
GET

### Endpoint
/resources/{resourceId}

### Parameters
#### Path Parameters
- **resourceId** (string) - Required - The local identifier of the resource.

### Query Parameters
#### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

### Response
#### Success Response (200)
- **content** (binary) - The content of the file resource.
```

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

### Get Stored Query Definition

Source: https://docs.ldproxy.net/services/building-blocks/features_-_search

Retrieve the definition of a specific stored query.

```APIDOC
## GET /search/{queryId}/definition

### Description
Get the definition of the stored query.

### Method
GET

### Endpoint
/search/{queryId}/definition

### Parameters
#### Path Parameters
- **queryId** (string) - Required - The identifier of the stored query.

#### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **definition** (object) - The definition of the stored query.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get Feature Collection Schema

Source: https://docs.ldproxy.net/services/building-blocks/feature_collections_-_schema

Retrieves the JSON Schema of the features for a specific collection.

```APIDOC
## GET collections/{collectionId}/schema

### Description
Returns the JSON Schema of the features of the collection `collectionId`.

### Method
GET

### Endpoint
`/collections/{collectionId}/schema`

### Parameters
#### Path Parameters
- **collectionId** (string) - Required - The identifier of the feature collection.

#### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
```

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

### Configure Log Output and Rotation

Source: https://docs.ldproxy.net/application/20-configuration/20-logging

Customize the log file path, enable archiving, and set rotation parameters. This example sets the log file to /var/log/ldproxy.log with daily rotation and keeps 30 archived files.

```yaml
logging:
  appenders:
    - type: file
      currentLogFilename: /var/log/ldproxy.log
      archive: true
      archivedLogFilenamePattern: /var/log/ldproxy-%d.zip
      archivedFileCount: 30
      timeZone: Europe/Berlin

```

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

### Get Stored Query Parameters

Source: https://docs.ldproxy.net/services/building-blocks/features_-_search

Retrieve the definition of the query parameters for a specific stored query.

```APIDOC
## GET /search/{queryId}/parameters

### Description
Get the definition of the query parameters.

### Method
GET

### Endpoint
/search/{queryId}/parameters

### Parameters
#### Path Parameters
- **queryId** (string) - Required - The identifier of the stored query.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **parameters** (object) - The definition of the query parameters.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Configure 3D Tiles Files Provider

Source: https://docs.ldproxy.net/providers/tile3d/20-files

Use this configuration to set up the 3D Tiles Files provider. Ensure the `source` path correctly points to the `tileset.json` file within the store's resources.

```yaml
id: lod-3dtiles
providerType: 3DTILE
providerSubType: FILES
tilesets:
  lod:
    id: lod
    source: lod/tileset.json

```

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

### Get All Resources

Source: https://docs.ldproxy.net/services/building-blocks/resources

Fetches the set of file resources. For each resource, the ID and a link to the file are provided.

```APIDOC
## GET /resources

### Description
Fetches the set of file resources. For each resource the id and a link to the file is provided.

### Method
GET

### Endpoint
/resources

### Query Parameters
#### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

### Response
#### Success Response (200)
- **id** (string) - The identifier of the resource.
- **link** (string) - A link to the file resource.
```

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

### Run ldproxy Editor via Docker

Source: https://docs.ldproxy.net/tools/editor

Use this command to start the ldproxy editor as a Docker container. Mount your ldproxy configuration directory to `/data` and access the editor via the specified port.

```bash
docker run -d -p 8080:80 -v /path/to/ldproxy.cfg:/data ghcr.io/ldproxy/editor

```

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

### WFS Provider Configuration

Source: https://docs.ldproxy.net/providers/feature/50-wfs

Example configuration for the WFS provider, specifying connection details like WFS version, GML version, namespaces, URI, and HTTP method.

```yaml
id: wfs
providerType: FEATURE
providerSubType: WFS
connectionInfo:
  connectorType: HTTP
  version: 2.0.0
  gmlVersion: 3.2.1
  namespaces:
    ave: http://rexample.com/ns/app/1.0
    wfs: http://www.opengis.net/wfs/2.0
    fes: http://www.opengis.net/fes/2.0
    gml: http://www.opengis.net/gml/3.2
    xsd: http://www.w3.org/2001/XMLSchema
    ows: http://www.opengis.net/ows/1.1
    xlink: http://www.w3.org/1999/xlink
    xsi: http://www.w3.org/2001/XMLSchema-instance
  uri: https://example.com/pfad/zum/wfs?
  method: GET

```

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

### Example GeoJSON Feature Properties

Source: https://docs.ldproxy.net/services/building-blocks/features_-_csv

Illustrates the structure of properties within a GeoJSON feature that will be encoded as CSV.

```json
{
  "att1": "foo",
  "att2": [ "bar1", "bar2", "bar3" ]
  "att3": {
    "value": 123,
    "values": [ 456, 789, 0 ]
  }
}

```

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

### Run ldproxy with Custom Data Path

Source: https://docs.ldproxy.net/application/30-deployment

Deploys ldproxy with a specific host directory for data storage and names the container 'ldproxy'.

```bash
docker run --name ldproxy -d -p 7080:7080 -v ~/docker/ldproxy_data:/data iide/ldproxy:latest

```

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

### Get Tile Matrix Set Definition

Source: https://docs.ldproxy.net/services/building-blocks/tile_matrix_sets

Retrieves the detailed definition of a specific tiling scheme by its identifier.

```APIDOC
## GET tileMatrixSets/{tileMatrixSetId}

### Description
Returns the definition of a tiling scheme.

### Method
GET

### Endpoint
`/tileMatrixSets/{tileMatrixSetId}`

### Path Parameters
- **tileMatrixSetId** (string) - Required - The identifier of the tiling scheme.

### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
```

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

### Get Stored Query Parameter Details

Source: https://docs.ldproxy.net/services/building-blocks/features_-_search

Retrieve the details of a specific query parameter for a stored query.

```APIDOC
## GET /search/{queryId}/parameters/{name}

### Description
Get the details of a query parameter.

### Method
GET

### Endpoint
/search/{queryId}/parameters/{name}

### Parameters
#### Path Parameters
- **queryId** (string) - Required - The identifier of the stored query.
- **name** (string) - Required - The name of the query parameter.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **parameter** (object) - The details of the query parameter.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GML Building Block Configuration Example

Source: https://docs.ldproxy.net/services/building-blocks/features_-_gml

Configure the GML building block with namespaces, default namespace, schema locations, GML ID prefix, and collection-specific API settings including attribute transformations.

```yaml
- buildingBlock: GML
  enabled: true
  applicationNamespaces:
    ns1: http://www.example.com/ns/ns1/1.0
    ns2: http://www.example.com/ns/ns2/1.0
  defaultNamespace: ns1
  schemaLocations:
    ns1: '{{serviceUrl}}/resources/ns1.xsd'
    ns2: '{{serviceUrl}}/resources/ns2.xsd'
  gmlIdPrefix: '_'
collections:
  some_type:
    ...
    api:
    - buildingBlock: GML
      xmlAttributes:
        - someAtt
      transformations:
        someOtherAtt:
          rename: 'ns2:someOtherAtt'

```

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

### Show Xtratiler Render Help

Source: https://docs.ldproxy.net/tools/xtratiler/commands

Displays the help message for the 'render' subcommand, outlining its use for submitting raster tile rendering jobs and its associated options.

```bash
$ xtratiler render --help
```

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

### xtracfg Help Commands (Docker)

Source: https://docs.ldproxy.net/tools/xtracfg

View help information for the xtracfg CLI and its subcommands when running via Docker.

```bash
docker run -it --rm ghcr.io/ldproxy/xtracfg --help
```

```bash
docker run -it --rm ghcr.io/ldproxy/xtracfg check --help
```

```bash
docker run -it --rm ghcr.io/ldproxy/xtracfg check entities --help
```

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

### Resulting CSV Output

Source: https://docs.ldproxy.net/services/building-blocks/features_-_csv

Shows the CSV representation of the example GeoJSON feature, demonstrating flattened properties and array limits.

```text
att1,att2_1,att2_2,att3_value,att3_values_1,att3_values_2
foo,bar1,bar2,123,456,789

```

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

### Purge Tile Cache with Specific Parameters

Source: https://docs.ldproxy.net/tools/xtractl/commands

Examples demonstrating how to purge tile cache using specific parameters like collection, tile matrix set, and bounding box. This allows for targeted cache invalidation.

```bash
xtractl tiles purge-cache api1 -c collection3 --tms WebMercatorQuad --bbox 8,49,9,50

```

```bash
xtractl tiles purge-cache api2 --bbox 8,49,9,50

```

```bash
xtractl tiles purge-cache api3

```

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

### Get Specific Feature

Source: https://docs.ldproxy.net/services/building-blocks/features

Retrieves a single feature by its unique identifier within a specified collection. The output format can be specified.

```APIDOC
## GET collections/{collectionId}/items/{featureId}

### Description
Retrieves a document representing the feature with the requested identifier within the specified collection.

### Method
GET

### Endpoint
/collections/{collectionId}/items/{featureId}

### Parameters
#### Path Parameters
- **collectionId** (string) - Required - The identifier of the feature collection.
- **featureId** (string) - Required - The local identifier of the feature within the collection.

#### Query Parameters
- **f** (string) - Optional - Select the output format of the response (e.g., GeoJSON, HTML). Defaults to using the "Accept" header.
- **profile** (string) - Optional - Requests variations in the representation of data in the same format.

### Response
#### Success Response (200)
- The response format depends on the `f` query parameter or the `Accept` header. It can include GeoJSON, HTML, etc.

#### Response Example (GeoJSON)
```json
{
  "type": "Feature",
  "id": "feature1",
  "properties": {
    "name": "Example Feature"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [10.0, 20.0]
  }
}
```
```

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

### Basic Substitution Syntax

Source: https://docs.ldproxy.net/application/20-configuration/95-substitutions

Use placeholders like ${variable_name} to insert values from environment variables or other sources into your configuration.

```yaml
connectionInfo:
  host: ${db.host}
```

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

### HTML Building Block Advanced Configuration

Source: https://docs.ldproxy.net/services/building-blocks/html

Configures the HTML building block with detailed options, including custom legal and privacy notices, and specific basemap settings. This example disables no-index and enables collection descriptions.

```yaml
- buildingBlock: HTML
  enabled: true
  noIndexEnabled: false
  schemaOrgEnabled: true
  collectionDescriptionsInOverview: true
  legalName: Legal notice
  legalUrl: https://www.interactive-instruments.de/en/about/impressum/
  privacyName: Privacy notice
  privacyUrl: https://www.interactive-instruments.de/en/about/datenschutzerklarung/
  basemapUrl: https://sg.geodatenzentrum.de/wmts_topplus_open/tile/1.0.0/web_grau/default/WEBMERCATOR/{z}/{y}/{x}.png
  basemapAttribution: '&copy;<a href="https://www.bkg.bund.de"  target="_new" >Bundesamt f&uuml;r Kartographie und Geod&auml;sie</a>(2020), <a href="https://sg.geodatenzentrum.de/web_public/Datenquellen_TopPlus_Open.pdf"  target="_new" >Datenquellen</a>'
  defaultStyle: default

```

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

### Get Feature Collections

Source: https://docs.ldproxy.net/services/building-blocks/feature_collections

Retrieves a list of all available feature collections. The response includes information about each collection and a link to its items.

```APIDOC
## GET collections

### Description
Lists all available feature collections. The response contains information about each collection, including a link to its items.

### Method
GET

### Endpoint
/collections

### Query Parameters
- **f** (string) - Optional - Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
```

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

### Enable Filter Building Block

Source: https://docs.ldproxy.net/services/building-blocks/filter

Configuration to enable the FILTER building block. This is a common setup for activating the filtering capabilities.

```yaml
- buildingBlock: FILTER
  enabled: true

```

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

### Configure Queryables Building Block

Source: https://docs.ldproxy.net/services/building-blocks/feature_collections_-_queryables

Example configuration for the QUERYABLES building block. This enables the building block, includes all eligible properties as queryables, excludes 'foo' and 'bar', uses underscore as a path separator, and disables query parameters.

```yaml
- buildingBlock: QUERYABLES
  enabled: true
  included:
    - '*'
  excluded:
    - foo
    - bar
  pathSeparator: UNDERSCORE
  asQueryParameters: false

```
Tokens:
Raw