Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@
"en/basic/admin-panel/settings",
"en/basic/admin-panel/ai-setting",
"en/basic/admin-panel/automation-management",
"en/basic/admin-panel/audit-log",
"en/basic/admin-panel/sandbox-agent",
"en/basic/admin-panel/multitenancy"
]
Expand Down Expand Up @@ -668,6 +669,7 @@
"zh/basic/admin-panel/settings",
"zh/basic/admin-panel/ai-setting",
"zh/basic/admin-panel/automation-management",
"zh/basic/admin-panel/audit-log",
"zh/basic/admin-panel/sandbox-agent",
"zh/basic/admin-panel/multitenancy"
]
Expand Down
10 changes: 6 additions & 4 deletions en/basic/admin-panel/ai-setting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Before you open the AI Settings page, make sure the following items are ready. B

<Note>
You only need one Vercel account to complete the setup.

In the current version, some **AI** and **App Builder** capabilities are affected if the instance cannot access Vercel. Teable is working on full private deployment support for AI and App Builder, so future versions no longer depend on Vercel services.
</Note>

| Requirement | Required? | Notes |
Expand Down Expand Up @@ -59,7 +61,7 @@ Follow these four steps:
</Step>
</Steps>

### 1. Configure LLM API
### Configure LLM API

Start by choosing how you want to connect your models in **LLM API**.

Expand All @@ -72,7 +74,7 @@ Start by choosing how you want to connect your models in **LLM API**.
</Tab>
</Tabs>

### 2. Configure Recommended Models
### Configure Recommended Models

This step decides which models users can choose from. Start with a clear primary set so users can choose by task complexity. A common setup is:

Expand All @@ -82,7 +84,7 @@ This step decides which models users can choose from. Start with a clear primary
| **Sonnet** | Everyday tasks with a good balance of quality and cost |
| **Haiku** | Lightweight tasks and fast responses |

### 3. Set chat model
### Set chat model

This step sets the default model for sidebar **AI Chat**. The model must come from the recommended model list, so if this step is disabled, the previous step is usually incomplete.

Expand All @@ -94,7 +96,7 @@ You should choose a stable model that supports tool calling and has already been

You can adjust **Max session duration (seconds)** and **Session creates per minute per user**. After voice input is enabled and saved, users will see the microphone button in the AI Chat input box.

### 4. Configure the runtime and App Builder
### Configure the Runtime and App Builder

Complete **AI Chat Runtime** first, then complete **App Builder**.

Expand Down
32 changes: 32 additions & 0 deletions en/basic/admin-panel/audit-log.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Audit log"
description: "Review instance-wide activity, filter operation history, and inspect audit log details in the Admin Panel."
---

<Tip>Available for self-hosted Business plan and above</Tip>

Path: Admin Panel → Audit log

**Audit log** lets administrators review recent activity across the instance and trace who performed an operation, when it happened, and what area it affected. Logs are retained for one month.

## What You Can Review

The audit log covers common administration and collaboration activity, including spaces, bases, tables, views, fields, records, sharing, invitations, access tokens, and the Authority Matrix.

Each log entry shows the operation time, operator, action type, related base or space, and request source. Open a log entry to view its details.

## Filter Logs

Use the filters at the top of the page to narrow the log list:

- **Select Operator**: Show actions performed by a specific user.
- **Select Space**: Show activity within a specific space.
- **Select Base**: Show activity for a specific base.
- **Select Action**: Filter by operation type, such as records, fields, views, tables, bases, sharing, spaces, invitations, users, and access tokens.

If a user, base, or space has been deleted, the entry remains in the log and the resource is marked as deleted.

## Notes

- Only instance administrators can access the Admin Panel.
- The audit log is intended for recent operational review and is retained for one month.
10 changes: 5 additions & 5 deletions en/basic/admin-panel/automation-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Path: Admin Panel → Automation management

**Automation management** is used to view automation run status across the instance.

## 1. Summary Metrics
## Summary Metrics

The top of the page shows the overall status for the selected time range:

Expand All @@ -23,14 +23,14 @@ The top of the page shows the overall status for the selected time range:
| **Health overview** | Automation health grouped by healthy, warning, and critical states |
| **Run status distribution** | Run distribution by successful, failed, running, pending, and canceled states |

## 2. Filters
## Filters

The main page supports filters:

- **Date range**: Last 30 minutes, 1 hour, 6 hours, 1 day, 3 days, 7 days, or 30 days.
- **Trigger**: Filter automations by trigger type.

## 3. Automation List
## Automation List

The list shows a run summary for each automation:

Expand All @@ -42,7 +42,7 @@ The list shows a run summary for each automation:

If an automation is inactive, the list shows **Inactive**.

## 4. Run History
## Run History

Open an automation to view **Run history**:

Expand All @@ -55,7 +55,7 @@ Open an automation to view **Run history**:

Run history can be filtered by successful, failed, running, pending, or canceled status.

## 5. Actions
## Actions

From the automation list, you can:

Expand Down
8 changes: 3 additions & 5 deletions en/basic/admin-panel/multitenancy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: "Teable supports organizations, allowing multiple organizations to
{/* mintlify-resync: 2026-05-14 */}
<Tip>Available for self-hosted Enterprise plan</Tip>

### Organization Management

Instance administrators access the organization management panel via `Admin Panel` > `Organizations`

<img
Expand All @@ -18,7 +16,7 @@ Instance administrators access the organization management panel via `Admin Pane

<Tip>The first user registered in the instance becomes an instance administrator</Tip>

## 1. Organization Management
## Organization Management

In the organization management interface, you can manage multiple organizations within a single Teable instance, with each organization's data being independent.

Expand Down Expand Up @@ -50,7 +48,7 @@ The organization management interface displays detailed information for all orga
className="docs-screenshot"
/>

## 2. Tiered Administrator System
## Tiered Administrator System

Teable adopts a tiered administrator design, providing two different administrator roles: instance administrators have management privileges for the entire Teable instance, while organization administrators focus on managing specific organizations.

Expand All @@ -75,7 +73,7 @@ Teable adopts a tiered administrator design, providing two different administrat
| **Organization Administrator** | ❌ None | ❌ None | ✅ This organization only | ✅ This organization only |
| **Regular Member** | ❌ None | ❌ None | ❌ None | ❌ None |

## 3. Use Cases
## Use Cases

Organization functionality is suitable for various scenarios that require managing multiple independent teams within one system. Here are typical application cases:

Expand Down
1 change: 1 addition & 0 deletions en/basic/admin-panel/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ After logging in as an administrator, click the "Admin Panel" button in the uppe
- **[Instance settings](/en/basic/admin-panel/settings)** - Configure system-wide settings, permissions, email, and system limits
- **[AI settings](/en/basic/admin-panel/ai-setting)** - Configure AI features and models
- **[Automation management](/en/basic/admin-panel/automation-management)** - View automation run status and run history
- **[Audit log](/en/basic/admin-panel/audit-log)** - Review recent instance activity and operation details
- **[Sandbox Agent](/en/basic/admin-panel/sandbox-agent)** - Configure Sandbox Agent runtime limits and base snapshots

### Administrator Permissions
Expand Down
8 changes: 4 additions & 4 deletions en/basic/admin-panel/sandbox-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Path: Admin Panel → Sandbox Agent

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

## 1. Enablement Scope
## Enablement Scope

In the **Settings** tab:

1. Turn on **Enable Sandbox Agent**.
2. Configure spaces in **Enabled Spaces**.
3. To enable all spaces, use **Enable for All Spaces**.

## 2. Runtime Limits
## Runtime Limits

Configure runtime limits in the **Settings** tab:

Expand All @@ -33,15 +33,15 @@ Configure runtime limits in the **Settings** tab:

Click **Save** after configuring the settings.

## 3. Base Snapshots
## Base Snapshots

Create and manage snapshots in **Base Snapshots**.

- Use **Quick Setup** to complete **Import Skills**, **Chat Snapshot**, and **App Builder**.
- Use **Create Snapshot** to customize Agent SDK, system tools, Skills, and custom apt packages.
- After a snapshot status is **Ready**, it can be set as **Active**.

## 4. Sandboxes Tab
## Sandboxes Tab

In the **Sandboxes** tab, view active sandboxes and session history.

Expand Down
8 changes: 6 additions & 2 deletions en/basic/ai/app-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Teable App Builder allows you to turn your data bases into fully functional, cus

The App Builder follows a "Prompt to App" workflow. You describe what you want, and AI builds the application structure, pages, and logic for you. You can then fine-tune every detail using the visual editor or code.

> **When to use App Builder vs AI Chat**: Use App Builder to create custom interfaces and standalone apps. For interactive data analysis and ad-hoc questions inside the database, use [AI Chat](/en/basic/ai/ai-chat).
<Note>
Use App Builder to create custom interfaces and standalone apps. For interactive data analysis and ad-hoc questions inside the database, use [AI Chat](/en/basic/ai/ai-chat).
</Note>

## Creating an App

Expand Down Expand Up @@ -113,9 +115,11 @@ When your app is ready, click the **Publish** button (arrow icon) in the top rig

### Custom Domains

<Note>Custom domains require the Business plan or above.</Note>

Use **Custom domain** to bind a domain to the published app. A subdomain is recommended, such as `app.yourdomain.com`. After you enter the domain, Teable shows the DNS records to add. Add the records with your DNS provider, wait for propagation, then verify the domain in Teable.

You can also use an available subdomain under `teable.app`, such as `your-name.teable.app`.
You can also use an available subdomain under `teable.app` and edit the `teable.app` prefix, such as `your-name.teable.app`.

<img
src="/images/docs/ai/2026-05-21-app-builder-custom-domain.png"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions zh/basic/admin-panel/ai-setting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ description: "为私有化部署实例配置 AI Chat、AI 字段、AI 自动化

<Note>
只需要一个 Vercel 账户,就可以完成这些配置。

当前版本中,如果实例无法访问 Vercel,部分 **AI** 和 **应用构建器** 能力会受影响。Teable 正在推进 AI 和应用构建器的完整私有化部署支持,后续版本将不再依赖 Vercel 服务。
</Note>

| 准备项 | 是否必需 | 说明 |
Expand Down Expand Up @@ -58,7 +60,7 @@ Vercel 相关费用主要分成两部分:
</Step>
</Steps>

### 1. 配置 LLM API
### 配置 LLM API

先在 **LLM API** 中选择模型接入方式。

Expand All @@ -71,7 +73,7 @@ Vercel 相关费用主要分成两部分:
</Tab>
</Tabs>

### 2. 配置推荐模型
### 配置推荐模型

这一步决定了用户可以选择哪些模型。建议先提供一组清晰的主力模型,方便用户按任务复杂度选择。一个常见的做法是:

Expand All @@ -81,7 +83,7 @@ Vercel 相关费用主要分成两部分:
| **Sonnet** | 日常任务,兼顾效果和成本 |
| **Haiku** | 轻量任务和快速响应 |

### 3. 设置聊天模型
### 设置聊天模型

这里要为侧边栏 **AI 对话** 指定默认模型。这个模型需要从推荐模型列表中选择,所以如果这一步是灰的,通常说明前一步还没完成。

Expand All @@ -93,7 +95,7 @@ Vercel 相关费用主要分成两部分:

你可以调整 **单次最长时长(秒)** 和 **每用户每分钟签发次数**。启用并保存语音输入后,用户会在 AI 对话输入框中看到麦克风按钮。

### 4. 配置运行环境与应用构建器
### 配置运行环境与应用构建器

先完成 **AI 聊天运行环境**,再完成 **应用构建器**。

Expand Down
32 changes: 32 additions & 0 deletions zh/basic/admin-panel/audit-log.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "审计日志"
description: "在管理员后台查看实例范围内的活动记录,筛选操作历史并检查审计详情。"
---

<Tip>私有化部署商业版及以上适用</Tip>

路径:管理面板 → 审计日志

**审计日志** 用于查看实例范围内的近期活动记录,帮助管理员回溯谁在什么时间做了什么操作。日志仅保留一个月。

## 可查看的操作

审计日志覆盖常见的管理和协作操作,包括空间、数据库、表格、视图、字段、记录、分享、邀请、访问令牌和权限矩阵相关活动。

每条日志会显示操作时间、操作者、操作类型、关联的数据库或空间,以及请求来源信息。打开日志后,可以查看这次操作的详情。

## 筛选日志

使用页面顶部的筛选器,可以缩小日志范围:

- **选择操作者**:查看某个用户执行的操作。
- **选择空间**:查看某个空间内的活动。
- **选择数据库**:查看某个数据库相关的活动。
- **选择操作类型**:按记录、字段、视图、表格、数据库、分享、空间、邀请、用户和访问令牌等类型筛选。

如果用户、数据库或空间已被删除,审计记录仍会保留,并标记该资源已删除。

## 注意事项

- 只有实例管理员可以访问管理面板。
- 审计日志用于近期操作回溯,仅保留一个月。
10 changes: 5 additions & 5 deletions zh/basic/admin-panel/automation-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: "在管理员后台查看自动化的运行状态、成功率和运

**自动化管理** 用于查看实例内自动化的运行状态。

## 一、 总览指标
## 总览指标

页面顶部展示所选时间范围内的整体状态:

Expand All @@ -23,14 +23,14 @@ description: "在管理员后台查看自动化的运行状态、成功率和运
| **健康概览** | 按正常、警告、严重等状态展示自动化健康情况 |
| **运行状态分布** | 按成功、失败、处理中、等待、已取消等运行状态展示分布 |

## 二、 筛选范围
## 筛选范围

主页面可以通过筛选器调整显示范围:

- **日期范围**:最近 30 分钟、1 小时、6 小时、1 天、3 天、7 天或 30 天。
- **触发器**:按触发器类型筛选对应自动化。

## 三、 自动化列表
## 自动化列表

列表中可以查看每个自动化的运行摘要:

Expand All @@ -42,7 +42,7 @@ description: "在管理员后台查看自动化的运行状态、成功率和运

如果自动化已停用,列表会显示为 **已停用**。

## 四、 运行记录
## 运行记录

打开某个自动化后,可以查看 **运行历史**:

Expand All @@ -55,7 +55,7 @@ description: "在管理员后台查看自动化的运行状态、成功率和运

运行历史支持按状态筛选成功、失败、处理中、等待或已取消的运行。

## 五、 管理操作
## 管理操作

自动化列表中可以执行:

Expand Down
8 changes: 3 additions & 5 deletions zh/basic/admin-panel/multitenancy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: "Teable 企业版支持组织管理功能,允许在单个实例
{/* mintlify-resync: 2026-05-14 */}
<Tip>适用于私有化部署企业版</Tip>

### 组织管理入口

实例管理员登陆后应用,从左侧边栏`管理面板`->`组织管理`。

<img
Expand All @@ -18,7 +16,7 @@ description: "Teable 企业版支持组织管理功能,允许在单个实例

<Tip>实例内首个注册的用户为实例管理员</Tip>

## 1. 组织管理
## 组织管理

在组织管理界面,您可以管理单个 Teable 实例中的多个组织,每个组织的数据相互独立。

Expand Down Expand Up @@ -50,7 +48,7 @@ description: "Teable 企业版支持组织管理功能,允许在单个实例
className="docs-screenshot"
/>

## 2. 分级管理员
## 分级管理员

Teable 采用分级管理员设计,提供两种不同的管理员角色:实例管理员拥有整个 Teable 实例的管理权限,而组织管理员则专注于管理特定组织。

Expand All @@ -75,7 +73,7 @@ Teable 采用分级管理员设计,提供两种不同的管理员角色:实
| **组织管理员** | ❌ 无 | ❌ 无 | ✅ 仅本组织 | ✅ 仅本组织 |
| **普通成员** | ❌ 无 | ❌ 无 | ❌ 无 | ❌ 无 |

## 3. 应用场景
## 应用场景

组织管理功能适用于各种需要在一个系统中管理多个独立团队的场景,以下是典型的应用案例:

Expand Down
Loading