From 0e942ebc18cccbb2b2d6de9dd738822fe334a88a Mon Sep 17 00:00:00 2001 From: HynLcc Date: Wed, 22 Jul 2026 23:49:17 +0800 Subject: [PATCH] docs: clarify private deployment requirements --- en/basic/admin-panel/ai-setting.mdx | 13 +++++++------ en/basic/admin-panel/database-tenant.mdx | 2 +- en/basic/ai/app-builder.mdx | 2 +- zh/basic/admin-panel/ai-setting.mdx | 13 +++++++------ zh/basic/admin-panel/database-tenant.mdx | 2 +- zh/basic/ai/app-builder.mdx | 2 +- 6 files changed, 18 insertions(+), 16 deletions(-) diff --git a/en/basic/admin-panel/ai-setting.mdx b/en/basic/admin-panel/ai-setting.mdx index 0ce4ad3..be6900d 100644 --- a/en/basic/admin-panel/ai-setting.mdx +++ b/en/basic/admin-panel/ai-setting.mdx @@ -19,7 +19,7 @@ Before you open the AI Settings page, make sure the following items are ready. | **Agent Runtime setup** | Required for AI Chat and App Builder | Used by AI Chat and App Builder | | **Custom provider** | Required when AI Chat or App Builder uses your own key (BYOK) | Use an **OpenAI Compatible** or **Anthropic** provider | | **OpenAI API Key** | Optional | Only needed if you want to enable **Voice input** in AI Chat | -| **Public access** | Required for App Builder publishing and attachment access | Your **Teable instance** and **object storage (MinIO / S3)** must be publicly accessible | +| **Public access** | Required when the **Vercel** deployment engine is selected | Your **Teable instance** and **object storage (MinIO / S3)** must be publicly accessible to Vercel | ## Setup steps @@ -69,7 +69,12 @@ In **AI Capabilities**, enable **AI Field** and **AI Chat** as needed. Configure ### Configure App Builder -Configure the **Deployment Engine**, then click **Test Connection**. +In **Deployment Engine**, choose how apps are deployed: + +| Deployment engine | Setup requirements | +|------|------| +| **Vercel** | Enter a Vercel access token, click **Test Connection**, and use **Test Public Access** to confirm that Vercel can reach your Teable instance and object storage. | +| **Teable Infra** | Uses the configured Teable Infra container runtime. No additional credentials or public access test is required here. | You can add these optional App Builder settings when needed: @@ -85,10 +90,6 @@ In **App Auth**, you can configure sign-in providers for generated apps: **Teable** sign-in is available by default. **Email OTP** appears in App Builder only after the SMTP settings are complete, and **Google** appears only after both OAuth credentials are configured. - -Click **Test Public Access** in the page and confirm that both your **Teable instance** and **object storage (MinIO / S3)** are publicly accessible. - - ### Optional. Configure Voice input To use voice input in AI Chat, enable the feature and enter an **OpenAI API Key**. Configure the **Transcription Endpoint** only when using a custom transcription service. You can also limit the recording length and requests per minute. diff --git a/en/basic/admin-panel/database-tenant.mdx b/en/basic/admin-panel/database-tenant.mdx index a4f308c..574162e 100644 --- a/en/basic/admin-panel/database-tenant.mdx +++ b/en/basic/admin-panel/database-tenant.mdx @@ -17,7 +17,7 @@ From **Admin Panel** → **BYODB**, an instance administrator can: - Move an existing Space to the target database. - Check the connection, migration status, and recent errors. -For an existing Space, Teable tests the migration without switching databases by default. After validation, the administrator decides whether to switch. Plan the final switch for a suitable maintenance window because writes may be paused. +For an existing Space, Teable tests the migration without switching databases by default. After validation, the administrator decides whether to switch. Switching briefly pauses writes, so plan it for a suitable maintenance window. ## FAQ diff --git a/en/basic/ai/app-builder.mdx b/en/basic/ai/app-builder.mdx index efb055f..f7c85a0 100644 --- a/en/basic/ai/app-builder.mdx +++ b/en/basic/ai/app-builder.mdx @@ -234,7 +234,7 @@ For prompt patterns, build tips, rollback advice, and common troubleshooting, se If you are running Teable self-hosted, follow the setup on the [AI Settings](/en/basic/admin-panel/ai-setting) page. If App Builder uses your own key (BYOK), the chat model must come from an **OpenAI Compatible** or **Anthropic** provider. For deployment support, contact Teable at **support@teable.ai**. - Before publishing, make sure both your Teable instance and object storage (MinIO / S3) are publicly accessible. If you are unsure, use **Test Public Access** on the [AI Settings](/en/basic/admin-panel/ai-setting) page. + If you select **Vercel** under **Deployment Engine**, make sure both your Teable instance and object storage (MinIO / S3) are publicly accessible, then use **Test Public Access** on the [AI Settings](/en/basic/admin-panel/ai-setting) page. This check is not required when you select **Teable Infra**. diff --git a/zh/basic/admin-panel/ai-setting.mdx b/zh/basic/admin-panel/ai-setting.mdx index 244ae2f..3c956d3 100644 --- a/zh/basic/admin-panel/ai-setting.mdx +++ b/zh/basic/admin-panel/ai-setting.mdx @@ -19,7 +19,7 @@ description: "为私有化部署实例配置 AI 对话、AI 字段、AI 自动 | **Agent Runtime 配置** | AI 对话和应用构建器必需 | 用于 AI 对话和应用构建器 | | **自定义服务商** | AI 对话或应用构建器使用自带 Key 时必需 | 提供商类型选择 **OpenAI Compatible**（OpenAI 兼容）或 **Anthropic** | | **OpenAI API Key** | 可选 | 只有需要在 AI 对话中启用 **语音输入** 时才需要 | -| **公网访问** | 应用发布和附件访问必需 | **Teable 实例** 和 **对象存储（MinIO / S3）** 需要被公网访问 | +| **公网访问** | 选择 **Vercel** 部署引擎时必需 | **Teable 实例** 和 **对象存储（MinIO / S3）** 需要被 Vercel 从公网访问 | ## 配置步骤 @@ -69,7 +69,12 @@ description: "为私有化部署实例配置 AI 对话、AI 字段、AI 自动 ### 配置应用构建器 -在 **部署引擎** 中完成配置，然后点击 **测试连接**。 +在 **部署引擎** 中选择应用的部署方式： + +| 部署引擎 | 配置要求 | +|------|------| +| **Vercel** | 填写 Vercel 访问令牌，点击 **测试连接**，并使用 **测试公网访问** 确认 Vercel 可以访问 Teable 实例和对象存储。 | +| **Teable Infra** | 使用已配置的 Teable Infra 容器运行时，无需在此填写额外凭据或测试公网访问。 | 如有需要，可以继续补充下面这些应用构建器可选配置： @@ -85,10 +90,6 @@ description: "为私有化部署实例配置 AI 对话、AI 字段、AI 自动 **Teable 登录** 默认可用。只有完整配置 SMTP 后，**邮箱验证码** 才会出现在应用构建器的登录设置中；只有同时配置 Google 客户端 ID 和密钥后，**Google** 登录才会出现。 - -点击页面中的 **测试公网访问**，确认 **Teable 实例** 和 **对象存储（MinIO / S3）** 都已经可以从公网访问。 - - ### 可选：配置语音输入 如需在 AI 对话中使用语音输入，请启用该功能并填写 **OpenAI API Key**。只有使用自定义转写服务时，才需要配置 **转写 Endpoint**。你还可以按需限制录音时长和每分钟请求次数。 diff --git a/zh/basic/admin-panel/database-tenant.mdx b/zh/basic/admin-panel/database-tenant.mdx index 53b1c7a..db34277 100644 --- a/zh/basic/admin-panel/database-tenant.mdx +++ b/zh/basic/admin-panel/database-tenant.mdx @@ -17,7 +17,7 @@ description: "将 Teable 空间数据托管在客户自管的 PostgreSQL 数据 - 把已有空间迁移到目标数据库。 - 查看连接、迁移状态和最近错误。 -对于已有空间，Teable 默认只测试迁移，不会切换数据库。校验完成后，由管理员决定是否切换。最终切换可能会暂停写入，请安排在合适的维护窗口执行。 +对于已有空间，Teable 默认只测试迁移，不会切换数据库。校验完成后，由管理员决定是否切换。切换时会短暂暂停写入，请安排在合适的维护窗口执行。 ## 常见问题 diff --git a/zh/basic/ai/app-builder.mdx b/zh/basic/ai/app-builder.mdx index 66be4e7..0ef213a 100644 --- a/zh/basic/ai/app-builder.mdx +++ b/zh/basic/ai/app-builder.mdx @@ -249,7 +249,7 @@ Teable 自动跟踪每一次部署。 如果您使用私有化部署的 Teable，请参考 [AI 配置](/zh/basic/admin-panel/ai-setting) 页面完成配置。如需让应用构建器使用自带 Key，聊天模型必须来自 **OpenAI Compatible**（OpenAI 兼容）或 **Anthropic** 类型的提供商。如需部署协助，请联系 Teable：**support@teable.ai**。 - 发布前，请先确认 Teable 和对象存储（MinIO / S3）都能被公网访问；不确定时，可以在 [AI 配置](/zh/basic/admin-panel/ai-setting) 页面使用 **测试公网访问** 进行验证。 + 如果在 **部署引擎** 中选择 **Vercel**，请确保 Teable 实例和对象存储（MinIO / S3）均可被公网访问，并在 [AI 配置](/zh/basic/admin-panel/ai-setting) 页面使用 **测试公网访问** 进行验证。选择 **Teable Infra** 时不需要这项检查。