From 83dadedd6bc0a5124d960b2a73c233d2689a4478 Mon Sep 17 00:00:00 2001 From: Bieber Date: Thu, 16 Jul 2026 17:30:14 +0800 Subject: [PATCH 1/3] docs(self-host): revive the one-click platform page for the attach-or-migrate story One-click platforms (Railway and similar) can host standalone Teable but cannot start containers, so the runtime plane can't live there. The page now serves existing template users with two paths: attach an externally deployed runtime plane over its single HTTPS connection (data stays put, rollback = remove the env vars), or migrate wholesale to the standard deployment. Back in the Quick Start navigation; the one-key redirect is removed since the URL serves content again. Co-Authored-By: Claude Fable 5 --- docs.json | 14 ++++------- en/deploy/one-key.mdx | 55 +++++++++++++++++++++++++++++++++++++++++++ zh/deploy/one-key.mdx | 44 ++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+), 10 deletions(-) create mode 100644 en/deploy/one-key.mdx create mode 100644 zh/deploy/one-key.mdx diff --git a/docs.json b/docs.json index 4fdab27..4f5edb2 100644 --- a/docs.json +++ b/docs.json @@ -76,14 +76,6 @@ "source": "/zh/deploy/gcp", "destination": "/zh/deploy/choose" }, - { - "source": "/en/deploy/one-key", - "destination": "/en/deploy/choose" - }, - { - "source": "/zh/deploy/one-key", - "destination": "/zh/deploy/choose" - }, { "source": "/en/deploy/storage", "destination": "/en/deploy/env" @@ -368,7 +360,8 @@ "group": "Quick Start", "pages": [ "en/deploy/choose", - "en/deploy/architecture" + "en/deploy/architecture", + "en/deploy/one-key" ] }, { @@ -718,7 +711,8 @@ "group": "快速开始", "pages": [ "zh/deploy/choose", - "zh/deploy/architecture" + "zh/deploy/architecture", + "zh/deploy/one-key" ] }, { diff --git a/en/deploy/one-key.mdx b/en/deploy/one-key.mdx new file mode 100644 index 0000000..8ff6a00 --- /dev/null +++ b/en/deploy/one-key.mdx @@ -0,0 +1,55 @@ +--- +title: "One-Click Platform Deployment" +description: "Running Teable from a one-click template (Railway and similar)? Two ways to the full platform: attach a runtime plane, or migrate to the standard deployment." +--- + +One-click templates on platforms like Railway or Zeabur give you a +**standalone** Teable in minutes: the app with PostgreSQL and Redis — tables, +collaboration, API, and automations, but no AI features. These platforms +cannot host the runtime plane: sandboxes and deployed apps run as containers, +which one-click platforms don't let you start (see +[Architecture](/en/deploy/architecture)). + +You have two ways to the full platform from here. + +## Option 1 — keep your platform, attach a runtime plane + +The Teable app talks to the runtime plane over a single HTTPS connection, so +the two don't need to share a machine: + +1. **Deploy the runtime plane** on a machine you control — a cloud server or + a Kubernetes cluster — following the + [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) + in the deployment repository. You'll need a domain for it; the "Let an AI + agent deploy it" guide on the [Deployment](/en/deploy/choose) page applies + here too. +2. **Connect your app**: check that your Teable image is recent enough (the + guide states the minimum release), add the connection environment + variables from the guide in your platform's service settings, and + redeploy. +3. **Verify** in + [Admin Panel → Sandbox Agent](/en/basic/admin-panel/sandbox-agent). + +Your data stays where it is throughout, and rollback is just removing those +variables again. + +## Option 2 — migrate to the standard deployment + +Consolidate everything onto the full-featured platform (Docker all-in-one or +Kubernetes — see [Deployment](/en/deploy/choose)): + +1. Back up your platform deployment: a PostgreSQL dump plus your uploaded + files. +2. Deploy the full-featured platform, then restore the dump and the files. +3. Point your domain at the new deployment and retire the platform project. + +## Which one? + +**Option 1** is the fastest and fully reversible — pick it if you like your +platform's workflow. **Option 2** puts everything in one place you control. + +## Licensing + +AI features require a self-hosted Business plan or above: copy your +**Instance ID** from the admin panel, subscribe, and activate — see +[Subscribe and Activate License](/en/deploy/activate). diff --git a/zh/deploy/one-key.mdx b/zh/deploy/one-key.mdx new file mode 100644 index 0000000..207e87d --- /dev/null +++ b/zh/deploy/one-key.mdx @@ -0,0 +1,44 @@ +--- +title: "一键平台部署" +description: "在 Railway、Zeabur 这类一键平台上跑 Teable?通往全功能平台有两条路:外挂一套运行平面,或迁移到标准部署。" +--- + +在 Railway、Zeabur 这类平台上,一键模板几分钟就能拉起一套**基础版** Teable: +应用加 PostgreSQL 与 Redis —— 表格、协作、API、自动化都有,但没有 AI 能力。 +这类平台托管不了运行平面:沙箱与已部署应用都要以容器方式运行,而一键平台 +不允许你启动容器(见[架构](/zh/deploy/architecture))。 + +从这里通往全功能平台,有两条路。 + +## 路线一:平台不动,外挂一套运行平面 + +Teable 应用与运行平面之间只有一条 HTTPS 连接,两者不需要在同一台机器上: + +1. **部署运行平面**:在一台你掌控的机器上(云服务器或 Kubernetes 集群), + 按部署仓库的[迁移指南](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) + 操作。需要为它准备一个域名;[部署](/zh/deploy/choose)页「交给 AI agent + 部署」的方式在这里同样适用。 +2. **接上应用**:确认 Teable 镜像版本达到指南标注的最低版本,在平台的服务 + 设置里按指南补上连接用的环境变量,重新部署; +3. **验证**:到[管理面板 → Sandbox Agent](/zh/basic/admin-panel/sandbox-agent) + 确认沙箱可用。 + +数据全程原地不动;回滚就是把那几个环境变量再删掉。 + +## 路线二:迁移到标准部署 + +把一切收拢到全功能平台上(Docker 单机全栈或 Kubernetes,见[部署](/zh/deploy/choose)): + +1. 在平台侧做好备份:PostgreSQL dump 加已上传的文件; +2. 部署全功能平台,恢复数据与文件; +3. 把域名指向新部署,下线平台上的项目。 + +## 怎么选? + +**路线一**最快且完全可逆 —— 喜欢现有平台的工作流就选它。**路线二**把一切 +收在一处,完全由你掌控。 + +## 授权 + +AI 能力需要私有化部署 Business 及以上套餐:在管理面板复制 **Instance ID**, +订阅并激活 —— 见[订阅与激活 License](/zh/deploy/activate)。 From b8e6d4383a9f1f802511d36b09da1d5a23c295b8 Mon Sep 17 00:00:00 2001 From: Bieber Date: Thu, 16 Jul 2026 17:35:44 +0800 Subject: [PATCH 2/3] docs(self-host): one-key page = original content restored, declaration up front Restore the pre-shelving page bodies verbatim (en: four template buttons + subscribe/activate; zh: pros/cons, sizing, Sealos, subscribe/activate) and put the new positioning as a leading note: templates deploy standalone Teable, one-click platforms cannot host the runtime plane, and the two paths to full features are attach-a-runtime-plane or migrate. The zh next-steps link to the deleted database-connection page is dropped. Co-Authored-By: Claude Fable 5 --- en/deploy/one-key.mdx | 85 +++++++++++++++++++++++-------------------- zh/deploy/one-key.mdx | 63 +++++++++++++++++--------------- 2 files changed, 79 insertions(+), 69 deletions(-) diff --git a/en/deploy/one-key.mdx b/en/deploy/one-key.mdx index 8ff6a00..16524c0 100644 --- a/en/deploy/one-key.mdx +++ b/en/deploy/one-key.mdx @@ -1,55 +1,60 @@ --- -title: "One-Click Platform Deployment" -description: "Running Teable from a one-click template (Railway and similar)? Two ways to the full platform: attach a runtime plane, or migrate to the standard deployment." +title: "One-Click Cloud Deployment" +description: "Deploy Teable quickly using cloud provider templates, then subscribe to unlock paid features and activate your license." --- -One-click templates on platforms like Railway or Zeabur give you a -**standalone** Teable in minutes: the app with PostgreSQL and Redis — tables, -collaboration, API, and automations, but no AI features. These platforms -cannot host the runtime plane: sandboxes and deployed apps run as containers, -which one-click platforms don't let you start (see -[Architecture](/en/deploy/architecture)). + +**What these templates deploy — and what they can't.** One-click templates +give you a **standalone** Teable (app + PostgreSQL + Redis): tables, +collaboration, API, and automations, but no AI features. One-click platforms +cannot start containers, so the [runtime plane](/en/deploy/architecture) that +powers AI sessions, App Builder, and app deployments cannot run on them. Two +ways to the full platform: -You have two ways to the full platform from here. +1. **Keep your platform and attach a runtime plane**: deploy it on a machine + you control following the + [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md), + then add the connection environment variables from the guide to your + platform service and redeploy. Your data stays in place, and rollback is + just removing the variables again. +2. **Migrate to the [standard deployment](/en/deploy/choose)**: back up a + PostgreSQL dump plus your uploaded files, restore them into a Docker + all-in-one or Kubernetes install, and repoint your domain. + -## Option 1 — keep your platform, attach a runtime plane +## One-Click Cloud Deployment -The Teable app talks to the runtime plane over a single HTTPS connection, so -the two don't need to share a machine: +One-click templates help you bootstrap a Teable environment quickly. After deployment, if you want paid features (for self-hosted plans), you should **subscribe** and **activate your license** using your Instance ID. -1. **Deploy the runtime plane** on a machine you control — a cloud server or - a Kubernetes cluster — following the - [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) - in the deployment repository. You'll need a domain for it; the "Let an AI - agent deploy it" guide on the [Deployment](/en/deploy/choose) page applies - here too. -2. **Connect your app**: check that your Teable image is recent enough (the - guide states the minimum release), add the connection environment - variables from the guide in your platform's service settings, and - redeploy. -3. **Verify** in - [Admin Panel → Sandbox Agent](/en/basic/admin-panel/sandbox-agent). +## Step 1: Deploy with a template -Your data stays where it is throughout, and rollback is just removing those -variables again. +Choose a template below and deploy. -## Option 2 — migrate to the standard deployment +[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/NtH5uD?referralCode=rE4BjB) -Consolidate everything onto the full-featured platform (Docker all-in-one or -Kubernetes — see [Deployment](/en/deploy/choose)): +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/QF8695) -1. Back up your platform deployment: a PostgreSQL dump plus your uploaded - files. -2. Deploy the full-featured platform, then restore the dump and the files. -3. Point your domain at the new deployment and retire the platform project. +[![Deploy to RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploylobe.svg)](https://repocloud.io/details/?app_id=273) -## Which one? +[![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/teable) -**Option 1** is the fastest and fully reversible — pick it if you like your -platform's workflow. **Option 2** puts everything in one place you control. +## Step 2: Subscribe (paid features) -## Licensing +If you are deploying **self-hosted** and need paid features, subscribe with your **Instance ID**: -AI features require a self-hosted Business plan or above: copy your -**Instance ID** from the admin panel, subscribe, and activate — see -[Subscribe and Activate License](/en/deploy/activate). +1. Open the Admin Panel in your deployed instance and copy the **Instance ID** +2. Go to the self-hosted pricing page and subscribe: `https://app.teable.ai/public/pricing?host=self-hosted` +3. After subscribing, you will get a **License Key** + +Then activate it in your instance: + +- Documentation: [Subscribe and Activate License](/en/deploy/activate) + + +If you are using **Teable Cloud** (hosted by Teable), manage your plan in-app: +see [Billing & Subscription](/en/basic/space/billing). + + +## Need help? + +If you have questions about subscription or licensing, contact `support@teable.ai`. diff --git a/zh/deploy/one-key.mdx b/zh/deploy/one-key.mdx index 207e87d..7123b7e 100644 --- a/zh/deploy/one-key.mdx +++ b/zh/deploy/one-key.mdx @@ -1,44 +1,49 @@ --- -title: "一键平台部署" -description: "在 Railway、Zeabur 这类一键平台上跑 Teable?通往全功能平台有两条路:外挂一套运行平面,或迁移到标准部署。" +title: "一键云部署" +description: "通过云服务商模板快速部署 Teable,然后订阅解锁付费功能并激活许可证。" --- -在 Railway、Zeabur 这类平台上,一键模板几分钟就能拉起一套**基础版** Teable: -应用加 PostgreSQL 与 Redis —— 表格、协作、API、自动化都有,但没有 AI 能力。 -这类平台托管不了运行平面:沙箱与已部署应用都要以容器方式运行,而一键平台 -不允许你启动容器(见[架构](/zh/deploy/architecture))。 + +**这些模板部署的是什么 —— 以及它们做不到什么。** 一键模板拉起的是**基础版** +Teable(应用 + PostgreSQL + Redis):表格、协作、API、自动化都有,但没有 AI +能力。一键平台无法启动容器,因此支撑 AI 会话、App Builder 与应用部署的 +[运行平面](/zh/deploy/architecture)住不进去。通往全功能平台有两条路: -从这里通往全功能平台,有两条路。 +1. **平台不动,外挂一套运行平面**:在一台你掌控的机器上按 + [迁移指南](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) + 部署运行平面,然后在平台的服务设置里按指南补上连接用的环境变量并重新部署。 + 数据原地不动;回滚就是把变量再删掉。 +2. **迁移到[标准部署](/zh/deploy/choose)**:备份 PostgreSQL dump 与已上传的 + 文件,恢复进 Docker 单机全栈或 Kubernetes,再把域名指过去。 + -## 路线一:平台不动,外挂一套运行平面 +| 优点 | 缺点 | +| ----------- | ------ | +| 无需任何配置，一键启动 | 依赖云服务商 | +| 可以弹性伸缩 | | +| 运维简单 | | -Teable 应用与运行平面之间只有一条 HTTPS 连接,两者不需要在同一台机器上: +**系统要求**： -1. **部署运行平面**:在一台你掌控的机器上(云服务器或 Kubernetes 集群), - 按部署仓库的[迁移指南](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) - 操作。需要为它准备一个域名;[部署](/zh/deploy/choose)页「交给 AI agent - 部署」的方式在这里同样适用。 -2. **接上应用**:确认 Teable 镜像版本达到指南标注的最低版本,在平台的服务 - 设置里按指南补上连接用的环境变量,重新部署; -3. **验证**:到[管理面板 → Sandbox Agent](/zh/basic/admin-panel/sandbox-agent) - 确认沙箱可用。 +* 应用节点最低 1c/2g +* 数据库最低 1c/2g -数据全程原地不动;回滚就是把那几个环境变量再删掉。 +#### Sealos -## 路线二:迁移到标准部署 +有免费额度，对国内支持友好，按量计费 -把一切收拢到全功能平台上(Docker 单机全栈或 Kubernetes,见[部署](/zh/deploy/choose)): +[**一键部署**](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dteable) -1. 在平台侧做好备份:PostgreSQL dump 加已上传的文件; -2. 部署全功能平台,恢复数据与文件; -3. 把域名指向新部署,下线平台上的项目。 +### 订阅与激活（付费功能） -## 怎么选? +如果你是**自托管部署**并需要付费功能，请在部署完成后进行订阅并激活许可证： -**路线一**最快且完全可逆 —— 喜欢现有平台的工作流就选它。**路线二**把一切 -收在一处,完全由你掌控。 +1. 在你部署好的 Teable 实例中进入管理员后台，复制 **Instance ID（实例 ID）** +2. 打开自托管订阅页面完成订阅：`https://app.teable.ai/public/pricing?host=self-hosted` +3. 订阅成功后会获得 **License Key（许可证密钥）**，回到实例中完成激活 -## 授权 +详情请见：[订阅和激活许可证](/zh/deploy/activate) -AI 能力需要私有化部署 Business 及以上套餐:在管理面板复制 **Instance ID**, -订阅并激活 —— 见[订阅与激活 License](/zh/deploy/activate)。 +### 下一步 + +[配置邮件服务](/zh/deploy/email) From 37ba9a62306bdce212ba85d15aa93d1f1e77704d Mon Sep 17 00:00:00 2001 From: Bieber Date: Thu, 16 Jul 2026 17:52:00 +0800 Subject: [PATCH 3/3] docs(self-host): move one-key to a trailing Deprecated group and mark the page Title gains the (Deprecated) suffix, the leading note becomes a Warning that routes new readers to Deployment first, and the page moves from Quick Start to a Deprecated group at the bottom of the Self-hosted tab. Co-Authored-By: Claude Fable 5 --- docs.json | 18 ++++++++++++++---- en/deploy/one-key.mdx | 10 ++++++---- zh/deploy/one-key.mdx | 13 +++++++------ 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/docs.json b/docs.json index 4f5edb2..73f62a7 100644 --- a/docs.json +++ b/docs.json @@ -360,8 +360,7 @@ "group": "Quick Start", "pages": [ "en/deploy/choose", - "en/deploy/architecture", - "en/deploy/one-key" + "en/deploy/architecture" ] }, { @@ -400,6 +399,12 @@ "pages": [ "en/deploy/upgrade" ] + }, + { + "group": "Deprecated", + "pages": [ + "en/deploy/one-key" + ] } ] }, @@ -711,8 +716,7 @@ "group": "快速开始", "pages": [ "zh/deploy/choose", - "zh/deploy/architecture", - "zh/deploy/one-key" + "zh/deploy/architecture" ] }, { @@ -751,6 +755,12 @@ "pages": [ "zh/deploy/upgrade" ] + }, + { + "group": "已弃用", + "pages": [ + "zh/deploy/one-key" + ] } ] }, diff --git a/en/deploy/one-key.mdx b/en/deploy/one-key.mdx index 16524c0..4ab9d7f 100644 --- a/en/deploy/one-key.mdx +++ b/en/deploy/one-key.mdx @@ -1,10 +1,12 @@ --- -title: "One-Click Cloud Deployment" +title: "One-Click Cloud Deployment (Deprecated)" description: "Deploy Teable quickly using cloud provider templates, then subscribe to unlock paid features and activate your license." --- - -**What these templates deploy — and what they can't.** One-click templates + +**Deprecated.** One-click templates are no longer a recommended way to deploy +Teable — start from [Deployment](/en/deploy/choose). If you already run Teable +from one of them, here is what you have and where to go next: these templates give you a **standalone** Teable (app + PostgreSQL + Redis): tables, collaboration, API, and automations, but no AI features. One-click platforms cannot start containers, so the [runtime plane](/en/deploy/architecture) that @@ -20,7 +22,7 @@ ways to the full platform: 2. **Migrate to the [standard deployment](/en/deploy/choose)**: back up a PostgreSQL dump plus your uploaded files, restore them into a Docker all-in-one or Kubernetes install, and repoint your domain. - + ## One-Click Cloud Deployment diff --git a/zh/deploy/one-key.mdx b/zh/deploy/one-key.mdx index 7123b7e..c32d185 100644 --- a/zh/deploy/one-key.mdx +++ b/zh/deploy/one-key.mdx @@ -1,12 +1,13 @@ --- -title: "一键云部署" +title: "一键云部署(已弃用)" description: "通过云服务商模板快速部署 Teable,然后订阅解锁付费功能并激活许可证。" --- - -**这些模板部署的是什么 —— 以及它们做不到什么。** 一键模板拉起的是**基础版** -Teable(应用 + PostgreSQL + Redis):表格、协作、API、自动化都有,但没有 AI -能力。一键平台无法启动容器,因此支撑 AI 会话、App Builder 与应用部署的 + +**已弃用。** 一键模板不再是推荐的 Teable 部署方式 —— 请从[部署](/zh/deploy/choose) +开始。如果你已经在用这类模板运行 Teable,先了解现状与去向:一键模板拉起的是 +**基础版** Teable(应用 + PostgreSQL + Redis):表格、协作、API、自动化都有, +但没有 AI 能力。一键平台无法启动容器,因此支撑 AI 会话、App Builder 与应用部署的 [运行平面](/zh/deploy/architecture)住不进去。通往全功能平台有两条路: 1. **平台不动,外挂一套运行平面**:在一台你掌控的机器上按 @@ -15,7 +16,7 @@ Teable(应用 + PostgreSQL + Redis):表格、协作、API、自动化都有,但 数据原地不动;回滚就是把变量再删掉。 2. **迁移到[标准部署](/zh/deploy/choose)**:备份 PostgreSQL dump 与已上传的 文件,恢复进 Docker 单机全栈或 Kubernetes,再把域名指过去。 - + | 优点 | 缺点 | | ----------- | ------ |