Skip to content

docs(self-host): overhaul deploy section for the full-featured platform era #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tea-artist merged 12 commits into from
Jul 15, 2026
Merged

docs(self-host): overhaul deploy section for the full-featured platform era #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ded01ea
docs(self-host): overhaul deploy section for the full-featured platfo…
tea-artist Jul 15, 2026
861d0c9
docs(env): document the AI runtime-plane connection group; drop retir…
tea-artist Jul 15, 2026
40b4694
docs(self-host): shelve legacy production/config pages as deprecated,…
tea-artist Jul 15, 2026
2bca021
docs(api): drop setup link into the shelved database-connection page
tea-artist Jul 15, 2026
d7e5c3e
docs(self-host): delete shelved legacy deploy pages, redirect old URLs
tea-artist Jul 15, 2026
5cb2501
docs(self-host): architecture-first narrative — Teable is an AI product
tea-artist Jul 15, 2026
8c1db8d
docs(self-host): hide Standalone Dashboard page from navigation
tea-artist Jul 15, 2026
ece89d8
docs(self-host): hide Nginx reverse-proxy page from navigation
tea-artist Jul 15, 2026
30a0ac5
docs(self-host): add local machine target to the agent-deploy table
tea-artist Jul 15, 2026
b40bf7e
docs(self-host): recenter architecture story on the real workloads
tea-artist Jul 15, 2026
852d87a
docs(self-host): rename Choose Your Path page to Deployment
tea-artist Jul 15, 2026
b3b68a8
docs(self-host): reorganize upgrade page around the changelog-date logic
tea-artist Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 78 additions & 36 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,78 @@
{
"source": "/zh/about",
"destination": "/zh/basic/ai/overview"
},
{
"source": "/en/deploy/production-overview",
"destination": "/en/deploy/choose"
Comment on lines +40 to +41

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 15, 2026

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 Preserve production sizing for the retired overview

When users with existing bookmarks to the production overview land here, they now get only the path-selection matrix, while the Docker guide still scopes standalone Docker to small teams/evaluation and no replacement page carries the deleted overview's production sizing, HA, Redis, and storage guidance. This leaves 50+ user/basic self-host deployments without an actionable production path after the redirect; please redirect to documentation that retains those requirements or keep a production overview page.

Useful? React with 👍 / 👎.

},
{
"source": "/zh/deploy/production-overview",
"destination": "/zh/deploy/choose"
},
{
"source": "/en/deploy/k8s",
"destination": "/en/deploy/choose"
},
{
"source": "/zh/deploy/k8s",
"destination": "/zh/deploy/choose"
},
{
"source": "/en/deploy/aws",
"destination": "/en/deploy/choose"
},
{
"source": "/zh/deploy/aws",
"destination": "/zh/deploy/choose"
},
{
"source": "/en/deploy/azure",
"destination": "/en/deploy/choose"
},
{
"source": "/zh/deploy/azure",
"destination": "/zh/deploy/choose"
},
{
"source": "/en/deploy/gcp",
"destination": "/en/deploy/choose"
},
{
"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"
Comment on lines +88 to +89

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 15, 2026

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 Don't redirect storage setup to env-only reference

When users follow the retired /en/deploy/storage URL, this now lands on the environment-variable table, but that page only lists storage variables and no longer includes the public bucket public-read/CORS and bucket-policy guidance that the deleted storage guide provided. S3/MinIO users can therefore set the variables successfully while missing the required bucket access rules, which causes browser asset access or uploads to fail; please redirect to a page/section that still contains the bucket setup requirements or restore that guidance here.

Useful? React with 👍 / 👎.

},
{
"source": "/zh/deploy/storage",
"destination": "/zh/deploy/env"
},
{
"source": "/en/deploy/database-connection",
"destination": "/en/deploy/env"
},
{
"source": "/zh/deploy/database-connection",
"destination": "/zh/deploy/env"
},
{
"source": "/en/deploy/agent-runtime",
"destination": "/en/deploy/architecture"
},
{
"source": "/zh/deploy/agent-runtime",
"destination": "/zh/deploy/architecture"
}
],
"navigation": {
Expand Down Expand Up @@ -295,8 +367,8 @@
{
"group": "Quick Start",
"pages": [
"en/deploy/docker",
"en/deploy/one-key"
"en/deploy/choose",
"en/deploy/architecture"
]
},
{
Expand All @@ -315,27 +387,12 @@
"en/basic/admin-panel/multitenancy"
]
},
{
"group": "Production Deployment",
"pages": [
"en/deploy/production-overview",
"en/deploy/agent-runtime",
"en/deploy/k8s",
"en/deploy/aws",
"en/deploy/azure",
"en/deploy/gcp"
]
},
{
"group": "Configuration",
"pages": [
"en/deploy/env",
"en/deploy/storage",
"en/deploy/email",
"en/deploy/database-connection",
"en/deploy/oidc",
"en/deploy/nginx",
"en/deploy/dashboard"
"en/deploy/oidc"
]
},
{
Expand Down Expand Up @@ -659,8 +716,8 @@
{
"group": "快速开始",
"pages": [
"zh/deploy/docker",
"zh/deploy/one-key"
"zh/deploy/choose",
"zh/deploy/architecture"
]
},
{
Expand All @@ -679,27 +736,12 @@
"zh/basic/admin-panel/multitenancy"
]
},
{
"group": "生产环境部署",
"pages": [
"zh/deploy/production-overview",
"zh/deploy/agent-runtime",
"zh/deploy/k8s",
"zh/deploy/aws",
"zh/deploy/azure",
"zh/deploy/gcp"
]
},
{
"group": "配置",
"pages": [
"zh/deploy/env",
"zh/deploy/storage",
"zh/deploy/email",
"zh/deploy/database-connection",
"zh/deploy/oidc",
"zh/deploy/nginx",
"zh/deploy/dashboard"
"zh/deploy/oidc"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion en/api-doc/sql-query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ noindex: true
---

<Tip>
**Self-hosted only**: Available for all versions with unlimited connections. For setup, see [Database Connection](/en/deploy/database-connection).
**Self-hosted only**: Available for all versions with unlimited connections.
</Tip>
Comment on lines 6 to 8

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 15, 2026

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 Keep the database proxy setup linked

For self-hosted instances that have not configured PUBLIC_DATABASE_PROXY, the database connection flow still needs deployment-side setup, but this commit removed the only direct link from the SQL Query page while the setup page is also removed from navigation. Users landing here can reach the UI steps and fail connection creation without any clue that an env var is missing, so please keep the setup link or inline the PUBLIC_DATABASE_PROXY requirement here.

Useful? React with 👍 / 👎.


Teable allows you to connect to its underlying PostgreSQL database through external tools for read-only queries. This enables integration with BI tools (PowerBI, Metabase, Superset), database clients (DataGrip, Navicat, TablePlus), low-code platforms (Appsmith, Budibase), and application code.
Expand Down
6 changes: 3 additions & 3 deletions en/basic/admin-panel/ai-setting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The **AI Settings** page is used to configure **AI Chat**, **AI fields**, **AI a

## Before you start

Before you open the AI Settings page, make sure the following items are ready. For self-hosted AI Chat and App Builder, first follow [Agent Runtime Deployment](/en/deploy/agent-runtime).
Before you open the AI Settings page, make sure the following items are ready. For self-hosted AI Chat and App Builder, first deploy the runtime plane — see [Architecture](/en/deploy/architecture).

| Requirement | Required? | Notes |
|------|------|------|
Expand Down Expand Up @@ -77,7 +77,7 @@ To let users use the microphone in AI Chat, enable voice input and enter the **O

### Configure Agent Runtime and App Builder

Self-hosted **AI Chat** and **App Builder** require Agent Runtime setup and a compatible chat model. When you use your own key (BYOK), the chat model must come from an **OpenAI Compatible** or **Anthropic** provider. Self-hosted Agent Runtime is still in an early stage, and setup can be complex. Follow [Agent Runtime Deployment](/en/deploy/agent-runtime), which will continue to evolve based on deployment feedback. For assistance, contact **support@teable.ai**.
Self-hosted **AI Chat** and **App Builder** require Agent Runtime setup and a compatible chat model. When you use your own key (BYOK), the chat model must come from an **OpenAI Compatible** or **Anthropic** provider. Deploy the runtime plane first — see [Architecture](/en/deploy/architecture) and the [teable-deployment](https://github.com/teableio/teable-deployment) repository. For assistance, contact **support@teable.ai**.

<Steps>
<Step title="Confirm Agent Runtime status">
Expand Down Expand Up @@ -125,7 +125,7 @@ Check the **Pending configuration** panel first to see which item is still missi

<Accordion title="The page says Agent Runtime configuration is still missing">

Check whether the current deployment has completed [Agent Runtime Deployment](/en/deploy/agent-runtime), including the required Teable environment variables. For assistance, contact **support@teable.ai**.
Check whether the runtime plane is deployed and connected (see [Architecture](/en/deploy/architecture)), including the required Teable environment variables — the deployment's doctor script verifies the whole chain. For assistance, contact **support@teable.ai**.
</Accordion>

<Accordion title="I get a credit exceeded error">
Expand Down
2 changes: 1 addition & 1 deletion en/basic/admin-panel/sandbox-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Path: Admin Panel → Sandbox Agent

The **Sandbox Agent** page contains **Settings** and **Sandboxes** tabs for configuring how AI Chat runs in sandboxes.

<Info>For self-hosted setup, complete [Agent Runtime Deployment](/en/deploy/agent-runtime) before configuring this page.</Info>
<Info>For self-hosted setup, deploy the full-featured runtime plane first — see [Architecture](/en/deploy/architecture).</Info>

## Runtime Limits

Expand Down
2 changes: 1 addition & 1 deletion en/basic/ai/app-builder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ For prompt patterns, build tips, rollback advice, and common troubleshooting, se
</Accordion>

<Accordion title="Where do I configure App Builder for Self-Hosted?">
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. Agent Runtime deployment is still in an early stage and can be complex. Contact Teable at **support@teable.ai** for deployment support.
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**.

<Note>
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.
Expand Down
3 changes: 1 addition & 2 deletions en/deploy/activate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ Before subscribing to a plan, you need to have Teable installed and running on y

If you haven't installed Teable yet, please follow one of these installation guides:
- [Docker Deployment](/en/deploy/docker) (Recommended for quick setup)
- [Kubernetes Deployment](/en/deploy/k8s) (For production environments)
- [One-Click Cloud Deployment](/en/deploy/one-key) (Template-based setup)
- [Full-featured platform](/en/deploy/architecture) (AI features and App Builder, Docker or Kubernetes)

<Note>
Make sure your Teable instance is up and running before proceeding to the next steps.
Expand Down
Loading
Loading