mirror of
https://github.com/protomaps/PMTiles.git
synced 2026-02-04 10:51:07 +00:00
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# PMTiles on Cloudflare Workers
|
|
|
|
Use [rclone](https://rclone.org/downloads/) to upload your PMTiles archives to an R2 bucket. The Web UI is limited to 300 MB.
|
|
|
|
# Getting started
|
|
|
|
* First run `npm install` in the root `PMTiles/js` directory, then `npm install` in `PMTiles/serverless/cloudflare`
|
|
|
|
* Edit `wrangler.toml` with a new name + your development and production R2 buckets.
|
|
|
|
* Test in development: `npm run start`
|
|
|
|
* Publish the worker: `npm run deploy`
|
|
|
|
# Settings
|
|
|
|
By default, your worker will serve tiles at path `NAME/0/0/0.EXT` using the archive at the root of your bucket `NAME.pmtiles`, where EXT is one of `mvt`, `png`, `jpg` or `webp` depending on the tileset.
|
|
|
|
This behavior can be customized with optional environment variables:
|
|
|
|
`PMTILES_PATH` - A string like `folder/{name}.pmtiles` specifying the path to archives in your bucket. Default `{name}.pmtiles`
|
|
|
|
`TILES_PATH` - a string like `prefix/{name}/{z}/{x}/{y}.{ext}` specifying the tile path exposed by the worker. Default `{name}/{z}/{x}/{y}.{ext}`
|
|
|
|
`ALLOWED_ORIGINS` - a comma-separated list of allowed CORS origions. Default none. Examples: `https://example.com,https://localhost:3000`, `*`
|
|
|
|
|
|
# Using the Workers web editor
|
|
|
|
Generate the Workers script using `npm run build` and copy `dist/index.js` to the editor.
|