From 0f16aaa12650da3753c8a7db7249a0a33bfa71c7 Mon Sep 17 00:00:00 2001 From: xiaoweii Date: Mon, 29 Sep 2025 17:29:58 +0800 Subject: [PATCH 1/3] docs: update deploy template --- README.md | 7 +++---- README_CN.md | 6 +++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7dfc99aa..9e1d801d 100644 --- a/README.md +++ b/README.md @@ -92,16 +92,15 @@ this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examp ### Step 2: Deploy stack and get your API URL -1. Click one of the following buttons to launch the CloudFormation Stack in the same region where your API Key was - created. +1. Go to [CloudFormation Console](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChat) and select **Upload a template file** under **Specify template**, then use one of the following templates to deploy. (Make sure you are in the same region where your API Key was created.) - **App Runner** - [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template) + Download [CloudFormation Template](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatAppRunner.template) and upload the file. - **Lambda** (Note: For AWS customer use only) - [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatLambda&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template) + Download [CloudFormation Template](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatLambda.template) and upload the file. 2. Click **Next**, On the "Specify stack details" page, provide the following information: - Fill the `ApiKeyParam` with the parameter name you used for storing the API key (e.g., "SwiftChatAPIKey"). diff --git a/README_CN.md b/README_CN.md index 80871f16..f6512313 100644 --- a/README_CN.md +++ b/README_CN.md @@ -84,15 +84,15 @@ SwiftChat 是一款快速响应的 AI 聊天应用，采用 [React Native](https ### 步骤 2：部署堆栈并获取 API URL -1. 点击以下按钮之一在创建 API Key 的同一区域启动 CloudFormation 堆栈。 +1. 前往 [CloudFormation 控制台](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChat)，在**指定模板**下选择**上传模板文件**，然后使用以下模板之一进行部署。（确保您所在的区域与创建 API Key 的区域相同。） - **App Runner** - [![启动堆栈](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template) + 下载 [CloudFormation 模板](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatAppRunner.template) 并上传文件。 - **Lambda**（注意：仅供 AWS 客户使用） - [![启动堆栈](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatLambda&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template) + 下载 [CloudFormation 模板](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatLambda.template) 并上传文件。 2. 点击 **下一步**，在"指定堆栈详细信息"页面，提供以下信息： - 用您存储 API 密钥的参数名称填写 `ApiKeyParam`（例如 "SwiftChatAPIKey"）。 From 0e3570d29c8a186b62a418b5f0fa0770432bcf81 Mon Sep 17 00:00:00 2001 From: xiaoweii Date: Mon, 29 Sep 2025 17:42:01 +0800 Subject: [PATCH 2/3] docs: update link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e1d801d..4f318cc5 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examp - **App Runner** - Download [CloudFormation Template](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatAppRunner.template) and upload the file. + Download CloudFormation Template and upload the file. - **Lambda** (Note: For AWS customer use only) From 2ee762ce2c8af560c7a412ebf90a942a7e5be109 Mon Sep 17 00:00:00 2001 From: xiaoweii Date: Mon, 29 Sep 2025 17:50:28 +0800 Subject: [PATCH 3/3] docs: update downlaod link --- README.md | 4 ++-- README_CN.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f318cc5..b103d182 100644 --- a/README.md +++ b/README.md @@ -96,11 +96,11 @@ this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examp - **App Runner** - Download CloudFormation Template and upload the file. + Open [SwiftChatAppRunner.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatAppRunner.template), then download and upload the file. - **Lambda** (Note: For AWS customer use only) - Download [CloudFormation Template](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatLambda.template) and upload the file. + Open [SwiftChatLambda.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatLambda.template) then download and upload the file. 2. Click **Next**, On the "Specify stack details" page, provide the following information: - Fill the `ApiKeyParam` with the parameter name you used for storing the API key (e.g., "SwiftChatAPIKey"). diff --git a/README_CN.md b/README_CN.md index f6512313..8cb44d81 100644 --- a/README_CN.md +++ b/README_CN.md @@ -88,11 +88,11 @@ SwiftChat 是一款快速响应的 AI 聊天应用，采用 [React Native](https - **App Runner** - 下载 [CloudFormation 模板](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatAppRunner.template) 并上传文件。 + 打开 [SwiftChatAppRunner.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatAppRunner.template)，然后下载并上传文件。 - **Lambda**（注意：仅供 AWS 客户使用） - 下载 [CloudFormation 模板](https://raw.githubusercontent.com/aws-samples/swift-chat/refs/heads/main/server/template/SwiftChatLambda.template) 并上传文件。 + 打开 [SwiftChatLambda.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatLambda.template)，然后下载并上传文件。 2. 点击 **下一步**，在"指定堆栈详细信息"页面，提供以下信息： - 用您存储 API 密钥的参数名称填写 `ApiKeyParam`（例如 "SwiftChatAPIKey"）。