跳转到内容

密钥与环境变量

管理 Convex 后端的 API 密钥和环境变量。

点击 builder 工具栏中的 Settings 按钮,打开设置面板。面板包含三个部分:

部分用途
General项目名称与知识库
SEO & sharing设置网站标题、描述和 favicon
SecretsConvex 后端的环境变量
  1. 点击 builder 工具栏中的 Settings 按钮
  2. 打开 Secrets 标签页
  3. 输入名称(例如 STRIPE_SECRET_KEY)和对应的值
  4. 点击 Add

密钥会同步到应用的 Convex 后端。在 Convex action/mutation/query 代码中,通过 process.env.SECRET_NAME 来引用它们。密钥会在 frontend 代码或 pod 级别的环境变量中提供——这样可以防止密钥泄漏到浏览器 bundle 中。

AI 在构建功能时会自动使用你的密钥:

  • "Accept payments with Stripe" → 使用你的 STRIPE_SECRET_KEY
  • "Send emails with Resend" → 使用你的 RESEND_API_KEY
  • "Add Google OAuth" → 使用你的 GOOGLE_CLIENT_IDGOOGLE_CLIENT_SECRET

密钥只能在 Convex 后端函数(actions 和 mutations)中访问,无法在 frontend React 代码中使用。AI 生成的 Convex 函数通过 process.env 读取它们。

密钥值默认以掩码显示。你可以切换可见性以查看明文,也可以更新密钥值,或将其删除后重新创建。

AI 可以看到你的密钥名称,但无法看到密钥的值。这样它在构建功能时能够引用正确的环境变量,同时不会暴露敏感数据。

Proyecta 会自动识别常见的敏感密钥模式(API 密钥、令牌、密码等),并在界面上对其值进行掩码处理。

SEO & sharing 部分允许你设置:

  • Site title — 显示在浏览器标签页和搜索结果中
  • Site description — 用于 SEO meta 描述
  • Favicon — 浏览器标签页中显示的图标

这些设置保存在你的项目中,并在发布时生效。

Knowledge Base 部分允许你添加参考资料和上下文信息,供 AI 在构建应用时使用。你可以添加品牌规范、技术规格或任何其他文档,帮助 AI 做出更好的决策。

密钥会加密存储吗?

密钥存储在你的项目中,并同步到 Convex deployment。它们不会出现在已提交的代码中。

开发环境和生产环境能使用不同的密钥吗?

目前,密钥同时适用于开发运行时和已发布(生产)的 Convex deployment。按环境管理密钥的功能计划在未来版本中推出。

如果我不小心泄露了密钥怎么办?

请立即删除旧密钥,在第三方服务提供商处撤销该密钥,然后重新创建一个新密钥。

密钥和连接器有什么区别?

密钥是由你自行管理的原始环境变量。连接器是托管集成,由 Proyecta 负责处理凭证存储、身份验证、令牌刷新和审计日志。如果有可用的连接器(Stripe、Slack、Resend、ElevenLabs),优先使用连接器;对于尚未提供连接器的服务,则使用密钥。