From 088040fdd9f611086575dc6e2fd339aa4db2cc87 Mon Sep 17 00:00:00 2001 From: Ryan McCue Date: Wed, 31 Jul 2024 16:12:54 +0100 Subject: [PATCH] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d2d3a74..73a800d 100644 --- a/README.md +++ b/README.md @@ -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)