2024-10-05 10:43:33 +02:00
#
# First section - common variable initialization
#
# Ensure that errors don't hide inside pipes
SHELL = /usr/bin/env bash
.SHELLFLAGS = -o pipefail -c
# Layers definition and meta data
TILESET_FILE := $( or $( TILESET_FILE) ,$( shell ( . .env; echo $$ { TILESET_FILE} ) ) ,openmaptiles.yaml)
# Options to run with docker and docker-compose - ensure the container is destroyed on exit
# Containers run as the current user rather than root (so that created files are not root-owned)
DC_OPTS ?= --rm --user= $( shell id -u) :$( shell id -g)
# If set to a non-empty value, will use postgis-preloaded instead of postgis docker image
USE_PRELOADED_IMAGE ?=
# Local port to use with postserve
PPORT ?= 8090
export PPORT
# Local port to use with tileserver
TPORT ?= 8080
export TPORT
STYLE_FILE := build/style/style.json
STYLE_HEADER_FILE := style/style-header.json
# Support newer `docker compose` syntax in addition to `docker-compose`
i f e q ( , $( shell which docker -compose ) )
DOCKER_COMPOSE_COMMAND := docker compose
$( info Using docker compose V2 ( docker compose) )
e l s e
DOCKER_COMPOSE_COMMAND := docker-compose
$( info Using docker compose V1 ( docker-compose) )
e n d i f
# Allow a custom docker-compose project name
DC_PROJECT := $( or $( DC_PROJECT) ,$( shell ( . .env; echo $$ { DC_PROJECT} ) ) )
i f e q ( $( DC_PROJECT ) , )
DC_PROJECT := $( notdir $( shell pwd ) )
DOCKER_COMPOSE := $( DOCKER_COMPOSE_COMMAND)
e l s e
DOCKER_COMPOSE := $( DOCKER_COMPOSE_COMMAND) --project-name $( DC_PROJECT)
e n d i f
# Make some operations quieter (e.g. inside the test script)
i f e q ( $( or $ ( QUIET ) ,$ ( shell ( . .env ; echo $ $ {QUIET }) ) ) ) , )
QUIET_FLAG :=
e l s e
QUIET_FLAG := --quiet
e n d i f
# Use `xargs --no-run-if-empty` flag, if supported
XARGS := xargs $( shell xargs --no-run-if-empty </dev/null 2>/dev/null && echo --no-run-if-empty)
# If running in the test mode, compare files rather than copy them
TEST_MODE ?= no
i f e q ( $( TEST_MODE ) , y e s )
# create images in ./build/devdoc and compare them to ./layers
GRAPH_PARAMS = ./build/devdoc ./layers
e l s e
# update graphs in the ./layers dir
GRAPH_PARAMS = ./layers
e n d i f
# Set OpenMapTiles host
export OMT_HOST := http://$( firstword $( subst :, ,$( subst tcp://,,$( DOCKER_HOST) ) ) localhost)
# This defines an easy $(newline) value to act as a "\n". Make sure to keep exactly two empty lines after newline.
d e f i n e n e w l i n e
e n d e f
# Use the old Postgres connection values as a fallback
PGHOST := $( or $( PGHOST) ,$( shell ( . .env; echo $$ { PGHOST} ) ) ,$( POSTGRES_HOST) ,$( shell ( . .env; echo $$ { POSTGRES_HOST} ) ) ,postgres)
PGPORT := $( or $( PGPORT) ,$( shell ( . .env; echo $$ { PGPORT} ) ) ,$( POSTGRES_PORT) ,$( shell ( . .env; echo $$ { POSTGRES_PORT} ) ) ,postgres)
PGDATABASE := $( or $( PGDATABASE) ,$( shell ( . .env; echo $$ { PGDATABASE} ) ) ,$( POSTGRES_DB) ,$( shell ( . .env; echo $$ { POSTGRES_DB} ) ) ,postgres)
PGUSER := $( or $( PGUSER) ,$( shell ( . .env; echo $$ { PGUSER} ) ) ,$( POSTGRES_USER) ,$( shell ( . .env; echo $$ { POSTGRES_USER} ) ) ,postgres)
PGPASSWORD := $( or $( PGPASSWORD) ,$( shell ( . .env; echo $$ { PGPASSWORD} ) ) ,$( POSTGRES_PASSWORD) ,$( shell ( . .env; echo $$ { POSTGRES_PASSWORD} ) ) ,postgres)
#
# Determine area to work on
# If $(area) parameter is not set, and only one *.osm.pbf file is found in ./data, use it as $(area).
# Otherwise, all make targets requiring an area will show an error.
# Note: If no *.osm.pbf files are found, once the users call "make download area=..."
# they will not need to use an "area=" parameter again because there will be just a single file.
#
# historically we have been using $(area) rather than $(AREA), so make both work
area ?= $( AREA)
# Ensure the $(area) param is set, or try to automatically determine it based on available data files
i f e q ( $( area ) , )
# An $(area) parameter is not set. If only one *.osm.pbf file is found in ./data, use it as $(area).
data_files := $( shell find data -name '*.osm.pbf' 2>/dev/null)
ifneq ( $( word 2,$( data_files) ) ,)
define assert_area_is_given
@echo ""
@echo "ERROR: The 'area' parameter or environment variable have not been set, and there several 'area' options:"
@$( patsubst data/%.osm.pbf,echo " '%'" ; ,$( data_files) )
@echo ""
@echo "To specify an area use:"
@echo " make $@ area=<area-id> "
@echo ""
@exit 1
endef
else
ifeq ( $( word 1,$( data_files) ) ,)
define assert_area_is_given
@echo ""
@echo "ERROR: The 'area' parameter (or env var) has not been set, and there are no data/*.osm.pbf files"
@echo ""
@echo "To specify an area use"
@echo " make $@ area=<area-id> "
@echo ""
@echo "To download an area, use make download area=<area-id>"
@echo "To list downloadable areas, use make list-geofabrik and/or make list-bbbike"
@exit 1
@echo ""
endef
else
# Keep just the name of the data file, without the .osm.pbf extension
area := $( patsubst data/%.osm.pbf,%,$( data_files) )
# Rename area-latest.osm.pbf to area.osm.pbf
# TODO: This if statement could be removed in a few months once everyone is using the file without the `-latest`?
ifneq ( $( area) ,$( area:-latest= ) )
$( shell mv " data/ $( area) .osm.pbf " " data/ $( area:-latest= ) .osm.pbf " )
area := $( area:-latest= )
$( warning ATTENTION: File data/$( area) -latest.osm.pbf was renamed to $( area) .osm.pbf.)
AREA_INFO := Detected area = $( area) based on finding a 'data/$(area)-latest.osm.pbf' file - renamed to '$(area).osm.pbf' . Use 'area' parameter or environment variable to override.
else
AREA_INFO := Detected area = $( area) based on finding a 'data/$(area).osm.pbf' file. Use 'area' parameter or environment variable to override.
endif
endif
endif
e n d i f
i f n e q ( $( AREA_INFO ) , )
define assert_area_is_given
@echo " $( AREA_INFO) "
endef
e n d i f
# If set, this file will be downloaded in download-osm and imported in the import-osm targets
PBF_FILE ?= data/$( area) .osm.pbf
# For download-osm, allow URL parameter to download file from a given URL. Area param must still be provided.
DOWNLOAD_AREA := $( or $( url) , $( area) )
# The mbtiles file is placed into the $EXPORT_DIR=/export (mapped to ./data)
MBTILES_FILE := $( or $( MBTILES_FILE) ,$( shell ( . .env; echo $$ { MBTILES_FILE} ) ) ,$( area) .mbtiles)
MBTILES_LOCAL_FILE = data/$( MBTILES_FILE)
DIFF_MODE := $( or $( DIFF_MODE) ,$( shell ( . .env; echo $$ { DIFF_MODE} ) ) )
i f e q ( $( DIFF_MODE ) , t r u e )
# import-osm implementation requires IMPOSM_CONFIG_FILE to be set to a valid file
# For one-time only imports, the default value is fine.
# For diff mode updates, use the dynamically-generated area-based config file
export IMPOSM_CONFIG_FILE = data/$( area) .repl.json
e n d i f
# Load area-specific bbox file that gets generated by the download-osm --bbox
AREA_BBOX_FILE ?= data/$( area) .bbox
i f n e q ( , $( wildcard $ ( AREA_BBOX_FILE ) ) )
cat := $( if $( filter $( OS) ,Windows_NT) ,type,cat)
BBOX := $( shell $( cat) ${ AREA_BBOX_FILE } )
export BBOX
e n d i f
# Consult .env if needed
MIN_ZOOM := $( or $( MIN_ZOOM) ,$( shell ( . .env; echo $$ { MIN_ZOOM} ) ) ,0)
MAX_ZOOM := $( or $( MAX_ZOOM) ,$( shell ( . .env; echo $$ { MAX_ZOOM} ) ) ,7)
PPORT := $( or $( PPORT) ,$( shell ( . .env; echo $$ { PPORT} ) ) ,7)
TPORT := $( or $( TPORT) ,$( shell ( . .env; echo $$ { TPORT} ) ) ,7)
d e f i n e H E L P _ M E S S A G E
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
OpenMapTiles https : //github .com /openmaptiles /openmaptiles
H i n t s f o r t e s t i n g a r e a s
make list-geofabrik # list actual geofabrik OSM extracts for download -> <<your-area>>
./quickstart.sh <<your-area>> # example: ./quickstart.sh madagascar
Hints for designers :
make start-maputnik # start Maputnik Editor + dynamic tile server [ see $(OMT_HOST):8088 ]
make stop-maputnik # stop Maputnik Editor + dynamic tile server
make start-postserve # start dynamic tile server [ see $(OMT_HOST):$(PPORT) ]
make stop-postserve # stop dynamic tile server
make start-tileserver # start maptiler/tileserver-gl [ see $(OMT_HOST):$(TPORT) ]
make stop-tileserver # stop maptiler/tileserver-gl
Hints for developers :
make # build source code
make bash # start openmaptiles-tools /bin/bash terminal
make generate-bbox-file # compute bounding box of a data file and store it in a file
make generate-devdoc # generate devdoc including graphs for all layers [./layers/...]
make generate-qa # statistics for a given layer's field
make generate-tiles-pg # generate vector tiles based on .env settings using PostGIS ST_MVT()
make generate-tiles # generate vector tiles based on .env settings using Mapnik (obsolete)
make generate-changed-tiles # Generate tiles changed by import-diff
make test-sql # run unit tests on the OpenMapTiles SQL schema
cat .env # list PG database and MIN_ZOOM and MAX_ZOOM information
cat quickstart.log # transcript of the last ./quickstart.sh run
make help # help about available commands
Hints for downloading & importing data :
make list-geofabrik # list actual geofabrik OSM extracts for download
make list-bbbike # list actual BBBike OSM extracts for download
make download area = albania # download OSM data from any source and create config file
make download-geofabrik area = albania # download OSM data from geofabrik.de and create config file
make download-osmfr area = asia/qatar # download OSM data from openstreetmap.fr and create config file
make download-bbbike area = Amsterdam # download OSM data from bbbike.org and create config file
make import-data # Import data from OpenStreetMapData, Natural Earth and OSM Lake Labels.
make import-osm # Import OSM data with the mapping rules from build/mapping.yaml
make import-diff # Import OSM updates from data/changes.osc.gz
make import-wikidata # Import labels from Wikidata
make import-sql # Import layers (run this after modifying layer SQL)
Hints for database management :
make psql # start PostgreSQL console
make psql-list-tables # list all PostgreSQL tables
make list-views # list PostgreSQL public schema views
make list-tables # list PostgreSQL public schema tables
make vacuum-db # PostgreSQL: VACUUM ANALYZE
make analyze-db # PostgreSQL: ANALYZE
make destroy-db # remove docker containers and PostgreSQL data volume
make start-db # start PostgreSQL, creating it if it doesn't exist
make start-db-preloaded # start PostgreSQL, creating data-prepopulated one if it doesn't exist
make stop-db # stop PostgreSQL database without destroying the data
Hints for Docker management :
make clean-unnecessary-docker # clean unnecessary docker image(s) and container(s)
make refresh-docker-images # refresh openmaptiles docker images from Docker HUB
make remove-docker-images # remove openmaptiles docker images
make list-docker-images # show a list of available docker images
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
e n d e f
export HELP_MESSAGE
#
# TARGETS
#
.PHONY : all
2025-01-16 20:45:43 +01:00
all : init -dirs build /openmaptiles .tm 2source /data .yml build /mapping .yaml build -sql build -style
2024-10-05 10:43:33 +02:00
.PHONY : help
help :
@echo " $$ HELP_MESSAGE " | less
d e f i n e w i n _ f s _ e r r o r
( \
echo "" ; \
echo "ERROR: Windows native filesystem" ; \
echo "" ; \
echo "Please avoid running OpenMapTiles in a Windows filesystem." ; \
echo "See https://github.com/openmaptiles/openmaptiles/issues/1095#issuecomment-817095465" ; \
echo "" ; \
exit 1 ; \
)
e n d e f
.PHONY : init -dirs
init-dirs :
@mkdir -p build/sql/parallel
@mkdir -p build/openmaptiles.tm2source
@mkdir -p build/style
@mkdir -p data
@mkdir -p cache
@ ! ( $( DOCKER_COMPOSE) 2>/dev/null run $( DC_OPTS) openmaptiles-tools df --output= fstype /tileset| grep -q 9p) < /dev/null || ( $( win_fs_error) )
build/openmaptiles.tm2source/data.yml : init -dirs
i f e q ( , $( wildcard build /openmaptiles .tm 2source /data .yml ) )
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c \
'generate-tm2source $(TILESET_FILE) > $@'
e n d i f
build/mapping.yaml : init -dirs
i f e q ( , $( wildcard build /mapping .yaml ) )
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c \
'generate-imposm3 $(TILESET_FILE) > $@'
e n d i f
.PHONY : build -sql
build-sql : init -dirs
i f e q ( , $( wildcard build /sql /run_last .sql ) )
@mkdir -p build/sql/parallel
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c \
' generate-sql $( TILESET_FILE) --dir ./build/sql \
&& generate-sqltomvt $( TILESET_FILE) \
--key --gzip --postgis-ver 3.3.4 \
--function --fname= getmvt >> ./build/sql/run_last.sql'
e n d i f
.PHONY : build -sprite
build-sprite : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c ' spreet /style/icons build/style/sprite && \
spreet --retina /style/icons build/style/sprite@2x'
.PHONY : build -style
build-style : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c ' style-tools recompose $( TILESET_FILE) $( STYLE_FILE) \
$( STYLE_HEADER_FILE) && \
spreet /style/icons build/style/sprite && spreet --retina /style/icons build/style/sprite@2x'
.PHONY : download -fonts
download-fonts :
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash -c ' [ ! -d "/export/fonts" ] && mkdir /export/fonts && \
echo "Downloading fonts..." && wget -qO /export/noto-sans.zip --show-progress \
https://github.com/openmaptiles/fonts/releases/download/v2.0/noto-sans.zip && \
echo "Unzipping fonts..." && unzip -q /export/noto-sans.zip -d /export/fonts && rm /export/noto-sans.zip || \
echo "Fonts already exist." '
.PHONY : clean
clean : clean -test -data
rm -rf build
clean-test-data :
rm -rf data/changes.state.txt
rm -rf data/last.state.txt
rm -rf data/changes.repl.json
.PHONY : destroy -db
DOCKER_PROJECT = $( shell echo $( DC_PROJECT) | tr A-Z a-z | tr -cd '[:alnum:]' )
destroy-db :
$( DOCKER_COMPOSE) down -v --remove-orphans
$( DOCKER_COMPOSE) rm -fv
docker volume ls -q -f " name=^ $( DOCKER_PROJECT) _ " | $( XARGS) docker volume rm
rm -rf cache
mkdir cache
.PHONY : start -db -nowait
start-db-nowait : init -dirs
@echo " Starting postgres docker compose target using $$ {POSTGIS_IMAGE:-default} image (no recreate if exists) " && \
$( DOCKER_COMPOSE) up --no-recreate -d postgres
.PHONY : start -db
start-db : start -db -nowait
@echo "Wait for PostgreSQL to start..."
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools pgwait
# Wrap start-db target but use the preloaded image
.PHONY : start -db -preloaded
start-db-preloaded : export POSTGIS_IMAGE =openmaptiles /postgis -preloaded
start-db-preloaded : export COMPOSE_HTTP_TIMEOUT =180
start-db-preloaded : start -db
.PHONY : stop -db
stop-db :
@echo "Stopping PostgreSQL..."
$( DOCKER_COMPOSE) stop postgres
.PHONY : list -geofabrik
list-geofabrik : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools download-osm list geofabrik
.PHONY : list -bbbike
list-bbbike : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools download-osm list bbbike
#
# download, download-geofabrik, download-osmfr, and download-bbbike are handled here
# The --imposm-cfg will fail for some of the sources, but we ignore that error -- only needed for diff mode
#
OSM_SERVERS := geofabrik osmfr bbbike
ALL_DOWNLOADS := $( addprefix download-,$( OSM_SERVERS) ) download
OSM_SERVER = $( patsubst download,,$( patsubst download-%,%,$@ ) )
.PHONY : $( ALL_DOWNLOADS )
$(ALL_DOWNLOADS) : init -dirs
@$( assert_area_is_given)
i f n e q ( $( url ) , )
$( if $( OSM_SERVER) ,$( error url parameter can only be used with non-specific download target:$( newline) make download area = $( area) url = " $( url) " $( newline) ) )
e n d i f
i f e q ( , $( wildcard $ ( PBF_FILE ) ) )
ifeq ( $( DIFF_MODE) ,true)
@echo " Downloading $( DOWNLOAD_AREA) with replication support into $( PBF_FILE) and $( IMPOSM_CONFIG_FILE) from $( if $( OSM_SERVER) ,$( OSM_SERVER) ,any source ) "
@$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools download-osm $( OSM_SERVER) " $( DOWNLOAD_AREA) " \
--imposm-cfg " $( IMPOSM_CONFIG_FILE) " \
--bbox " $( AREA_BBOX_FILE) " \
--output " $( PBF_FILE) "
else
@echo " Downloading $( DOWNLOAD_AREA) into $( PBF_FILE) from $( if $( OSM_SERVER) ,$( OSM_SERVER) ,any source ) "
@$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools download-osm $( OSM_SERVER) " $( DOWNLOAD_AREA) " \
--bbox " $( AREA_BBOX_FILE) " \
--output " $( PBF_FILE) "
endif
@echo ""
e l s e
ifeq ( $( DIFF_MODE) ,true)
ifeq ( ,$( wildcard $( IMPOSM_CONFIG_FILE) ) )
$( error \
$( newline) Data files $( PBF_FILE) already exists, but $( IMPOSM_CONFIG_FILE) does not. \
$( newline) You probably downloaded the data file before setting DIFF_MODE = true. \
$( newline) You can delete the data file $( PBF_FILE) and re-run make download \
$( newline) to re-download and generate config, or manually create $( IMPOSM_CONFIG_FILE) \
$( newline) See example https://github.com/openmaptiles/openmaptiles-tools/blob/v5.2/bin/config/repl_config.json \
$( newline) )
else
@echo " Data files $( PBF_FILE) and replication config $( IMPOSM_CONFIG_FILE) already exists, skipping the download. "
endif
else
@echo " Data files $( PBF_FILE) already exists, skipping the download. "
endif
e n d i f
.PHONY : generate -bbox -file
generate-bbox-file :
@$( assert_area_is_given)
i f e q ( , $( wildcard $ ( AREA_BBOX_FILE ) ) )
@$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools download-osm bbox " $( PBF_FILE) " " $( AREA_BBOX_FILE) "
e l s e
@echo " Configuration file $( AREA_BBOX_FILE) already exists, no need to regenerate. BBOX= $( BBOX) "
e n d i f
.PHONY : psql
psql : start -db -nowait
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools sh -c 'pgwait && psql.sh'
# Special cache handling for Docker Toolbox on Windows
i f e q ( $( MSYSTEM ) , M I N G W 6 4 )
DC_CONFIG_CACHE := -f docker-compose.yml -f docker-compose-$( MSYSTEM) .yml
DC_OPTS_CACHE := $( filter-out --user= %,$( DC_OPTS) )
e l s e
DC_OPTS_CACHE := $( DC_OPTS)
e n d i f
.PHONY : import -osm
import-osm : all start -db -nowait
@$( assert_area_is_given)
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && import-osm $(PBF_FILE)'
.PHONY : start -update -osm
start-update-osm : start -db
@$( assert_area_is_given)
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) up -d update-osm
.PHONY : stop -update -osm
stop-update-osm :
$( DOCKER_COMPOSE) stop update-osm
.PHONY : import -diff
import-diff : start -db -nowait
@$( assert_area_is_given)
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && import-diff'
.PHONY : import -data
import-data : start -db
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) import-data
.PHONY : import -sql
import-sql : all start -db -nowait
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools sh -c 'pgwait && import-sql' | \
awk -v s = ": WARNING:" '1{print; fflush()} $$0~s{print "\n*** WARNING detected, aborting"; exit(1)}' | \
awk '1{print; fflush()} $$0~".*ERROR" {txt=$$0} END{ if(txt){print "\n*** ERROR detected, aborting:"; print txt; exit(1)} }'
.PHONY : generate -tiles
generate-tiles : all start -db
@echo "WARNING: This Mapnik-based method of tile generation is obsolete. Use generate-tiles-pg instead."
@echo " Generating tiles into $( MBTILES_LOCAL_FILE) (will delete if already exists)... "
@rm -rf " $( MBTILES_LOCAL_FILE) "
$( DOCKER_COMPOSE) run $( DC_OPTS) generate-vectortiles
@echo "Updating generated tile metadata ..."
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools \
mbtiles-tools meta-generate " $( MBTILES_LOCAL_FILE) " $( TILESET_FILE) --auto-minmax --show-ranges
.PHONY : generate -tiles -pg
generate-tiles-pg : all start -db
@echo " Generating tiles into $( MBTILES_LOCAL_FILE) (will delete if already exists) using PostGIS ST_MVT()... "
@rm -rf " $( MBTILES_LOCAL_FILE) "
# For some reason Ctrl+C doesn't work here without the -T. Must be pressed twice to stop.
$( DOCKER_COMPOSE) run -T $( DC_OPTS) openmaptiles-tools generate-tiles
@echo "Updating generated tile metadata ..."
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools \
mbtiles-tools meta-generate " $( MBTILES_LOCAL_FILE) " $( TILESET_FILE) --auto-minmax --show-ranges
.PHONY : data /tiles .txt
data/tiles.txt :
find ./data -name "*.tiles" -exec cat { } \; -exec rm { } \; | \
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools \
tile_multiplier $( MIN_ZOOM) $( MAX_ZOOM) >> data/tiles.txt
.PHONY : generate -changed -tiles
generate-changed-tiles : data /tiles .txt
# Re-generating updated tiles, if needed
if [ -s data/tiles.txt ] ; then \
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools refresh-views; \
$( DOCKER_COMPOSE) run $( DC_OPTS) -e LIST_FILE = data/tiles.txt openmaptiles-tools generate-tiles; \
rm data/tiles.txt; \
fi
.PHONY : start -tileserver
start-tileserver : init -dirs build -style download -fonts
@echo " "
@echo "***********************************************************"
@echo "* "
@echo "* Download/refresh maptiler/tileserver-gl docker image"
@echo "* see documentation: https://github.com/maptiler/tileserver-gl"
@echo "* "
@echo "***********************************************************"
@echo " "
$( DOCKER_COMPOSE_COMMAND) pull tileserver-gl
@echo " "
@echo "***********************************************************"
@echo "* "
@echo "* Start maptiler/tileserver-gl "
@echo " * ----------------------------> check $( OMT_HOST) : $( TPORT) "
@echo "* "
@echo "***********************************************************"
@echo " "
$( DOCKER_COMPOSE) up -d tileserver-gl
.PHONY : stop -tileserver
stop-tileserver :
$( DOCKER_COMPOSE) stop tileserver-gl
.PHONY : start -postserve
start-postserve : start -db
@echo " "
@echo "***********************************************************"
@echo "* "
@echo " * Bring up postserve at $( OMT_HOST) : $( PPORT) "
@echo "* --> can view it locally (use make start-maputnik)"
@echo "* --> or can use https://maputnik.github.io/editor"
@echo "* "
@echo " * set data source / TileJSON URL to $( OMT_HOST) : $( PPORT) "
@echo "* "
@echo "***********************************************************"
@echo " "
$( DOCKER_COMPOSE) up -d postserve
.PHONY : stop -postserve
stop-postserve :
$( DOCKER_COMPOSE) stop postserve
.PHONY : start -maputnik
start-maputnik : stop -maputnik start -postserve
@echo " "
@echo "***********************************************************"
@echo "* "
@echo "* Start maputnik/editor "
@echo " * ---> go to $( OMT_HOST) :8088 "
@echo " * ---> set data source / TileJSON URL to $( OMT_HOST) : $( PPORT) "
@echo "* "
@echo "***********************************************************"
@echo " "
$( DOCKER_COMPOSE) up -d maputnik_editor
.PHONY : stop -maputnik
stop-maputnik :
-$( DOCKER_COMPOSE) stop maputnik_editor
# STAT_FUNCTION=frequency|toplength|variance
.PHONY : generate -qa
generate-qa : all start -db -nowait
@echo " "
@echo "e.g. make generate-qa STAT_FUNCTION=frequency LAYER=transportation ATTRIBUTE=class"
@echo " "
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools \
layer-stats $( STAT_FUNCTION) $( TILESET_FILE) $( LAYER) $( ATTRIBUTE) -m 0 -n 14 -v
# generate all etl and mapping graphs
.PHONY : generate -devdoc
generate-devdoc : init -dirs
mkdir -p ./build/devdoc && \
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools sh -c \
' generate-etlgraph $( TILESET_FILE) $( GRAPH_PARAMS) && \
generate-mapping-graph $( TILESET_FILE) $( GRAPH_PARAMS) '
.PHONY : bash
bash : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools bash
.PHONY : import -wikidata
import-wikidata : init -dirs
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools import-wikidata --cache /cache/wikidata-cache.json $( TILESET_FILE)
.PHONY : reset -db -stats
reset-db-stats : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -P pager = off -c 'SELECT pg_stat_statements_reset();'
.PHONY : list -views
list-views : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -A -F"," -P pager = off -P footer = off \
-c "select viewname from pg_views where schemaname='public' order by viewname;"
.PHONY : list -tables
list-tables : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -A -F"," -P pager = off -P footer = off \
-c "select tablename from pg_tables where schemaname='public' order by tablename;"
.PHONY : psql -list -tables
psql-list-tables : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -P pager = off -c "\d+"
.PHONY : vacuum -db
vacuum-db : init -dirs
@echo "Start - postgresql: VACUUM ANALYZE VERBOSE;"
2025-01-16 20:45:43 +01:00
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -P pager = off -c 'VACUUM (ANALYZE, VERBOSE);'
2024-10-05 10:43:33 +02:00
.PHONY : analyze -db
analyze-db : init -dirs
@echo "Start - postgresql: ANALYZE VERBOSE;"
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools psql.sh -v ON_ERROR_STOP = 1 -P pager = off -c 'ANALYZE VERBOSE;'
.PHONY : list -docker -images
list-docker-images :
docker images | grep openmaptiles
.PHONY : refresh -docker -images
refresh-docker-images : init -dirs
i f n e q ( $( NO_REFRESH ) , )
@echo "Skipping docker image refresh"
e l s e
@echo ""
@echo "Refreshing docker images... Use NO_REFRESH=1 to skip."
i f n e q ( $( USE_PRELOADED_IMAGE ) , )
POSTGIS_IMAGE = openmaptiles/postgis-preloaded \
$( DOCKER_COMPOSE_COMMAND) pull --ignore-pull-failures $( QUIET_FLAG) openmaptiles-tools generate-vectortiles postgres
e l s e
$( DOCKER_COMPOSE_COMMAND) pull --ignore-pull-failures $( QUIET_FLAG) openmaptiles-tools generate-vectortiles postgres import-data
e n d i f
e n d i f
.PHONY : remove -docker -images
remove-docker-images :
@echo "Deleting all openmaptiles related docker image(s)..."
@$( DOCKER_COMPOSE) down
@docker images "openmaptiles/*" -q | $( XARGS) docker rmi -f
@docker images "maputnik/editor" -q | $( XARGS) docker rmi -f
@docker images "maptiler/tileserver-gl" -q | $( XARGS) docker rmi -f
.PHONY : clean -unnecessary -docker
clean-unnecessary-docker :
@echo "Deleting unnecessary container(s)..."
@docker ps -a -q --filter "status=exited" | $( XARGS) docker rm
@echo "Deleting unnecessary image(s)..."
@docker images | awk -F" " '/<none>/{print $$3}' | $( XARGS) docker rmi
.PHONY : test -perf -null
test-perf-null : init -dirs
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools test-perf $( TILESET_FILE) --test null --no-color
.PHONY : build -test -pbf
build-test-pbf : init -dirs
$( DOCKER_COMPOSE_COMMAND) run $( DC_OPTS) openmaptiles-tools /tileset/.github/workflows/build-test-data.sh
.PHONY : debug
debug : ## Use this target when developing Makefile itself to verify loaded environment variables
@$( assert_area_is_given)
@echo file_exists = $( wildcard $( AREA_BBOX_FILE) )
@echo AREA_BBOX_FILE = $( AREA_BBOX_FILE) , $$ AREA_ENV_FILE
@echo BBOX = $( BBOX) , $$ BBOX
@echo MIN_ZOOM = $( MIN_ZOOM) , $$ MIN_ZOOM
@echo MAX_ZOOM = $( MAX_ZOOM) , $$ MAX_ZOOM
build/import-tests.osm.pbf : init -dirs
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'osmconvert tests/import/*.osm -o=build/import-tests.osm.pbf'
data/changes.state.txt :
cp -f tests/changes.state.txt data/
data/last.state.txt :
cp -f tests/last.state.txt data/
data/changes.repl.json :
cp -f tests/changes.repl.json data/
data/changes.osc.gz : init -dirs
@echo " UPDATE unit test data..."
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'osmconvert tests/update/*.osc --merge-versions -o=data/changes.osc && gzip -f data/changes.osc'
test-sql : clean refresh -docker -images destroy -db start -db -nowait build /import -tests .osm .pbf data /changes .state .txt data /last .state .txt data /changes .repl .json build /mapping .yaml data /changes .osc .gz build /openmaptiles .tm 2source /data .yml build /mapping .yaml build -sql
$( eval area := changes)
@echo "Load IMPORT test data"
sed -ir "s/^[#]*\s*MAX_ZOOM=.*/MAX_ZOOM=14/" .env
sed -ir "s/^[#]*\s*DIFF_MODE=.*/DIFF_MODE=false/" .env
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && import-osm build/import-tests.osm.pbf'
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) import-data
@echo "Apply OpenMapTiles SQL schema to test data @ Zoom 14..."
$( DOCKER_COMPOSE) run $( DC_OPTS) openmaptiles-tools sh -c 'pgwait && import-sql' | \
awk -v s = ": WARNING:" '1{print; fflush()} $$0~s{print "\n*** WARNING detected, aborting"; exit(1)}' | \
awk '1{print; fflush()} $$0~".*ERROR" {txt=$$0} END{ if(txt){print "\n*** ERROR detected, aborting:"; print txt; exit(1)} }'
@echo "Test SQL output for Import Test Data"
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && psql.sh < tests/test-post-import.sql' 2>& 1 | \
awk -v s = "ERROR:" '1{print; fflush()} $$0~s{print "*** ERROR detected, aborting"; exit(1)}'
@echo "Run UPDATE process on test data..."
sed -ir "s/^[#]*\s*DIFF_MODE=.*/DIFF_MODE=true/" .env
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && import-diff'
@echo "Test SQL output for Update Test Data"
$( DOCKER_COMPOSE) $( DC_CONFIG_CACHE) run $( DC_OPTS_CACHE) openmaptiles-tools sh -c 'pgwait && psql.sh < tests/test-post-update.sql' 2>& 1 | \
awk -v s = "ERROR:" '1{print; fflush()} $$0~s{print "*** ERROR detected, aborting"; exit(1)}'
