Skip to content

docs: 添加 .env.example 环境变量模板文件 #16

Description

@BukeLy

问题

当前项目缺少.env.example文件,用户不清楚需要设置哪些环境变量。

环境变量与samconfig.toml.exampletemplate.yaml高度耦合,缺乏文档导致配置困难。

解决方案

添加.env.example文件,列出所有必需和可选的环境变量。
并让samconfig.toml从.env中加载环境变量而不是硬编码.

预期内容

# Required - Telegram Bot
TELEGRAM_BOT_TOKEN=
# Required - Bedrock Credentials
BEDROCK_ACCESS_KEY_ID=
BEDROCK_SECRET_ACCESS_KEY=
# Required - Internal Auth
SDK_CLIENT_AUTH_TOKEN=
# Optional - Bedrock Model ARNs
BEDROCK_HAIKU_MODEL_ARN=
BEDROCK_SONNET_MODEL_ARN=
BEDROCK_OPUS_MODEL_ARN=
# Auto-generated by SAM (不需要手动设置)# SESSION_BUCKET=# SESSION_TABLE=# QUEUE_URL=

关联文件

  • template.yaml - Parameters定义
  • samconfig.toml.example - 部署参数配置

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions