Apache Baremaps Documentation

The baremaps-testing/data directory contains sample spatial data in various formats (such as .shp, .gpkg, and .fgb) used for testing and demonstration purposes.

Available datasets include:

• countries.fgb and countries.gpkg (sourced from flatgeobuf)
• data.gpkg (sourced from geopackage-java)

The tileset.js configuration extends the TileJSON specification. It allows you to define vector_layers where each layer contains queries.

Each query can specify a zoom range (minzoom, maxzoom) and a PostGIS-dialect sql statement. This allows you to dynamically fetch layer content based on the current zoom level using the ${zoom} variable in your SQL.

{
  "tilejson": "2.2.0",
  "tiles": [
    "http://localhost:9000/tiles/{z}/{x}/{y}.mvt"
  ],
  "vector_layers": [
    {
      "id": "aerialway",
      "queries": [
        {
          "minzoom": 14,
          "maxzoom": 20,
          "sql": "SELECT id, tags, geom FROM osm_way_z${zoom} WHERE tags ? 'aerialway'"
        }
      ]
    }
  ]
}

In this project, configuration files (like tileset.js and style.js) are written in JavaScript instead of static JSON.

Benefits of using JS for configuration:

• Flexibility: Use JavaScript functions to programmatically generate complex configurations.
• Modularity: Supports import statements to reuse code across files.
• Documentation: Allows the use of comments within configuration files.
• Complexity Management: Easier to manage as configuration files grow in size and complexity.

To execute tests, navigate to a directory containing a tests folder and use the run command with the -s (style URL) flag. This will generate a report at tests/report.html.

baremaps-renderer run -s <styleUrl>

This example demonstrates how to use Apache Baremaps to create and serve vector tiles specifically from contour lines data. The process involves preparing the necessary data files and configuring the environment to generate tiles from contour line geometries.

For a detailed step-by-step guide on importing contour data into PostGIS and setting up the tile server, refer to the official documentation.

This example provides the necessary configuration and files to import OpenStreetMap (OSM) data into a PostGIS database and subsequently serve it as vector tiles using Apache Baremaps.

For a detailed step-by-step guide on the import process, refer to the official documentation: Import OSM into PostGIS.

To use baremaps-renderer as a command line tool, install the dependencies, build the project, and link the script to your system path using npm.

npm install
npm run build
npm link

To add a new test, create a new folder within the tests/integration directory. Inside that folder, you must include a metadata.json file defining the viewport parameters.

{
  "width": 512,
  "height": 512,
  "center": [6.6323, 46.5197],
  "zoom": 14
}

To keep your database current, use the update workflow. This downloads the latest changes from OpenStreetMap (osc.xml) and applies them.

Note: Refreshing materialized views is an optional and costly step. It is only necessary if you need to update low zoom levels.

# This command updates the database
baremaps workflow execute --file update.js

# This command refreshes the materialized views (optional)
baremaps workflow execute --file refresh.js