Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akhenakh/selfhostmap
A complete solution to self host maps
https://github.com/akhenakh/selfhostmap
gis map maps mvt pmtiles self-hosted
Last synced: 25 days ago
JSON representation
A complete solution to self host maps
- Host: GitHub
- URL: https://github.com/akhenakh/selfhostmap
- Owner: akhenakh
- License: mit
- Created: 2024-02-21T01:42:47.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T16:08:59.000Z (2 months ago)
- Last Synced: 2024-10-19T23:29:07.678Z (2 months ago)
- Topics: gis, map, maps, mvt, pmtiles, self-hosted
- Language: HTML
- Homepage:
- Size: 14.8 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# selfhostmap
A complete solution to self host maps using [pmtiles](https://docs.protomaps.com/pmtiles/).
pmtiles can be served directly using HTTP range queries, but requires some additional js.
This solution aims at exposing the traditional MVT tiles /z/x/y format leveraging Caddy and a pmtiles plugin.
Styles and assets to display a map are embedded using [osm-liberty-gl](https://github.com/openmaptiles/osm-liberty-gl-style), so you don't have to, but any styles can be loaded.
It can serve local pmfiles, over HTTP or s3 storage.
## Serve your map
See below if you don't know how to create your pmtiles files.
### Parameters
- `AREA`: the name of the pmtiles files, "canada", "planet"...
- `BUCKET`: the directory bucket where to find the `AREA` file, "file:///home/user/GIS" or "http://myserver/files" or "s3://mybucket"
see [remote-urls](https://github.com/protomaps/go-pmtiles?tab=readme-ov-file#remote-urls).
- `BASE_MAP_URL`: the base url where the map will be available "http://192.168.1.3:8080"
### Using Docker
```sh
docker run --rm -it -e AREA="canada" -e BUCKET="file:///data" -e BASE_MAP_URL="http://192.168.1.3:8080" ghcr.io/akhenakh/selfhostmap:main
```
### Using Caddy
You need to build Caddy with the pmtiles extension:
Install Caddy builder https://github.com/caddyserver/xcaddy
```sh
xcaddy build --with github.com/caddy-dns/cloudflare --with github.com/protomaps/go-pmtiles/caddy
```
Execute the resulting caddy binary:
```sh
AREA="canada" BUCKET="file:///home/user/maps" BASE_MAP_URL="http://localhost:8080" ./caddy run -c ./Caddyfile.local
```
`BUCKET` should point to the directory you saved your pmtiles files.
Point your browser to http://localhost:8080
## QGIS
Works with QGIS:
Create a new Vector Tiles Connection:
URL: http://192.168.1.3:8080/tiles/planet/{z}/{x}/{y}.mvt
Style: http://192.168.1.3:8080/osm-liberty-gl.json
Replace the url with your actual server.
Then add the layer to your map.
## Create a map using planetiler
```sh
wget https://github.com/onthegomap/planetiler/releases/latest/download/planetiler.jar
java -Xmx8g -jar planetiler.jar --download --area=france --output=france.pmtiles
```
See https://github.com/onthegomap/planetiler for the options.