Skip to content

Commit

Permalink
Merge pull request #207 from humanmade/add-function-url-docs
Browse files Browse the repository at this point in the history
Add documentation on function URL deployment
  • Loading branch information
rmccue authored Jul 31, 2024
2 parents 599a90d + 088040f commit 662e4ee
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ Tachyon requires the following Lambda Function spec:

Take the `lambda.zip` from the latest release and upload it to your function.

For routing web traffic to the Lambda function, we recommend using [Lambda Function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-configuration.html). These should be configured as:

- Auth type: None
- Invoke mode: `RESPONSE_STREAM`

Alternatively, you can use API Gateway; this should be set to route all GET requests (i.e. `/{proxy+}`) to invoke your Tachyon Lambda function.

We also recommend running an aggressive caching proxy/CDN in front of Tachyon, such as CloudFront. (An expiration time of 1 year is typical for a production configuration.)

## Documentation

* [Plugin Setup](./docs/plugin.md)
Expand Down

0 comments on commit 662e4ee

Please sign in to comment.