mirrors/PMTiles
1
0
Fork 0
mirror of https://github.com/protomaps/PMTiles.git synced 2026-02-04 02:41:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Brandon Liu
2022-07-18 23:06:30 +08:00
committed by GitHub
parent 1570ff0253
commit fa97e982e4
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
serverless/aws/README.md
View File

@@ -1,21 +1,23 @@
# PMTiles on Lambda
Generates a Lambda function for deploying PMTiles on Lambda behind Lambda Function URLs or API Gateway. (CloudFront is recommended as a cache in front.)
## How To Use
`python create_lambda_function.py MY_REGION MY_BUCKET_NAME`
```sh
git clone https://github.com/protomaps/PMTiles
cd serverless/aws
python create_lambda_function.py
```
Upload the resulting `lambda_function.zip` using the Lambda console.
## Configuration
Configure these Lambda environment variables:
* `BUCKET`: the S3 bucket name.
* `PMTILES_PATH`
* `TILE_PATH`
## AWS Notes
1. API Gateway (Event format v2.0)
2. Lambda Function URLs are not recommended.
* `PMTILES_PATH`: optional, define how a tileset name is translated into an S3 key. Default `{name}.pmtiles`
* Example path setting for objects in a directory: `my_folder/{name}/file.pmtiles`
* `TILE_PATH`: optional, define the URL route of the tiles API. Default `/{name}/{z}/{x}/{y}.pbf`
## Test Event
@@ -34,4 +36,4 @@ API Gateway V2 / Lambda Function URLs:
### Lambda@Edge
Lambda@Edge's multi-region features have little benefit when fetching data from S3 in a single region, and Lambda@Edge [doesn't support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/edge-functions-restrictions.html) environment variables or responses over 1 MB. For globally distributed caching, use CloudFront in combination with Lambda Function URLs.
Lambda@Edge's multi-region features have little benefit when fetching data from S3 in a single region, and Lambda@Edge [doesn't support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/edge-functions-restrictions.html) environment variables or responses over 1 MB. For globally distributed caching, use CloudFront in combination with Lambda Function URLs.