https://github.com/akhenakh/kvtiles

Self hosted maps, PMTiles, MBTiles key value storage and server
https://github.com/akhenakh/kvtiles

gis map maps mbtiles pmtiles

Last synced: 12 days ago
JSON representation

Self hosted maps, PMTiles, MBTiles key value storage and server

• Host: GitHub
• URL: https://github.com/akhenakh/kvtiles
• Owner: akhenakh
• License: apache-2.0
• Created: 2020-03-09T18:29:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-24T00:05:58.000Z (10 months ago)
• Last Synced: 2024-10-16T03:43:09.915Z (23 days ago)
• Topics: gis, map, maps, mbtiles, pmtiles
• Language: Go
• Homepage:
• Size: 16 MB
• Stars: 88
• Watchers: 6
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kvtiles

kvtiles is a web server to embed and serve maps. Free map for all!

Regions are precomputed, simply pull the image and you are good to go.

Using the MVT format extracted from MBTiles, kvtiles is now using [PMTiles](https://protomaps.com/).

In short this project provides [self hosted map tiles](https://blog.nobugware.com/post/2019/self_hosted_world_maps/). 

## Docker & Kubernetes

Main goal of kvtiles is to be run in Docker/Kubernetes.

You can browse all the different regions and levels via [kvtiles docker tags](https://hub.docker.com/r/akhenakh/kvtiles/tags)

```

 docker run --rm -it -p 8080:8080 akhenakh/kvtiles:us-9-latest

```

Then point your browser to `http://yourdockerip:8080/static/`

An example deployment for kubernetes is located in `cmd/kvtilesd`.

## APIs

Tiles are available at `/tiles/{z:[0-9]+}/{x:[0-9]+}/{y:[0-9]+}.pbf`, an optional `key` URL param can be passed to secure access to your tiles server, (use the `tilesKey` option).

Metrics are provided via Prometheus at `http://host:httpMetricsPort/metrics`.

A debug visual map is available at `http://host:httpAPIPort/static/`.

Health status is provided via gRPC `host:healthPort` or via HTTP `http://host:httpAPIPort/healthz`.

A `http://host:httpAPIPort/version` is giving you running version but also information on the dataset.

## Application usage

To serve the DB use `kvtilesd`

```

Usage of ./cmd/kvtilesd/kvtilesd:

  -allowOrigin="*": Access-Control-Allow-Origin

  -dbPath="map.pmtiles": Pmtiles path

  -healthPort=6666: grpc health port

  -httpAPIPort=8080: http API port

  -httpMetricsPort=8088: http port

  -logLevel="INFO": DEBUG|INFO|WARN|ERROR

  -tilesKey="": A key to protect your tiles access

```

## Create a map in PMTILES

Download an [extract](http://download.geofabrik.de/) or a full planet of Openstreetmap in PBF format.

Create an MBTILES file using [Planetiler](https://github.com/onthegomap/planetiler).

You can use tippecanoe `tile-join` command to join smaller extends like continents to be able to build the planet.

Download the `pmtiles` binary for your system at [go-pmtiles/Releases](https://github.com/protomaps/go-pmtiles/releases) to convert from MBTILES to PMTILES.

```

pmtiles convert map.mbtiles map.pmtiles

```

## Build Image

```

export KO_DOCKER_REPO=ghcr.io/akhenakh/kvtiles  

ko publish --bare --platform=linux/amd64,linux/arm64 ./cmd/kvtilesd 

# private push

ko publish --bare  --platform=linux/amd64,linux/arm64 ./cmd/kvtilesd --insecure-registry 

```

## Docker usage

```

docker run --rm -p 8080:8080  -it -v ${PWD}:/data -e BUCKETURL=file:///data/quebec.pmtiles -e LOGLEVEL=debug ghcr.io/akhenakh/kvtiles:latest

```

## Run locally

```

KO_DATA_PATH=./cmd/kvtilesd/kodata go run ./cmd/kvtilesd -bucketURL file:///${PWD}/quebec.pmtiles 

```