Skip to content

docs(self-host): revive one-click platform page — attach a runtime plane or migrate#182

Merged
tea-artist merged 3 commits into
mainfrom
docs-one-key-revival
Jul 16, 2026
Merged

docs(self-host): revive one-click platform page — attach a runtime plane or migrate#182
tea-artist merged 3 commits into
mainfrom
docs-one-key-revival

Conversation

@tea-artist

@tea-artist tea-artist commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Brings back /deploy/one-key (en/zh) with a new purpose. The old page was a list of one-click template buttons (declared non-functional and deleted in #180, URL redirected). The original page bodies are restored verbatim (en: template buttons + subscribe/activate flow; zh: pros/cons, sizing, Sealos, subscribe/activate), with the new positioning as a leading note: these templates deploy standalone Teable, one-click platforms cannot start containers and therefore cannot host the runtime plane.

Two paths, both anchored to the deployment repository's basic-to-full-featured migration guide:

  1. Attach a runtime plane — keep the platform deployment; deploy the runtime plane on a machine you control and connect the app over its single HTTPS link (env vars from the guide). Data stays in place; rollback is removing the variables.
  2. Migrate to the standard deployment — PostgreSQL dump + uploaded files into a Docker all-in-one or Kubernetes install, then repoint the domain.

Also: page restored to Quick Start navigation, the /deploy/one-key → /deploy/choose redirects removed (the URL serves content again), and a licensing pointer to Instance ID activation retained from the old page.

🤖 Generated with Claude Code

tea-artist and others added 2 commits July 16, 2026 17:30
…-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 <noreply@anthropic.com>
…n 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 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b8e6d4383a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread en/deploy/one-key.mdx
<Note>
**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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Narrow the AI limitation to runtime-backed features

For Business self-hosted users who only need AI Fields or AI automation, this sentence says the one-click install has “no AI features,” but the existing docs describe self-hosted AI Fields as available on Business+ and scope the runtime-plane requirement specifically to AI Chat and App Builder (en/basic/field/ai/ai-field.mdx:6, en/basic/admin-panel/ai-setting.mdx:15, en/basic/admin-panel/ai-setting.mdx:80). This will incorrectly push those users toward attaching/migrating the runtime plane before using any AI; please narrow the claim to runtime-backed features such as AI Chat, App Builder, and app deployments, and mirror the same fix in the zh page.

Useful? React with 👍 / 👎.

… 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 <noreply@anthropic.com>
@tea-artist
tea-artist merged commit 29aaa55 into main Jul 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant