Skip to content

Commit 8faa135

Browse files
authored
docs: sync audit log and app publishing updates
1 parent f452231 commit 8faa135

19 files changed

Lines changed: 116 additions & 40 deletions

docs.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@
308308
"en/basic/admin-panel/settings",
309309
"en/basic/admin-panel/ai-setting",
310310
"en/basic/admin-panel/automation-management",
311+
"en/basic/admin-panel/audit-log",
311312
"en/basic/admin-panel/sandbox-agent",
312313
"en/basic/admin-panel/multitenancy"
313314
]
@@ -668,6 +669,7 @@
668669
"zh/basic/admin-panel/settings",
669670
"zh/basic/admin-panel/ai-setting",
670671
"zh/basic/admin-panel/automation-management",
672+
"zh/basic/admin-panel/audit-log",
671673
"zh/basic/admin-panel/sandbox-agent",
672674
"zh/basic/admin-panel/multitenancy"
673675
]

en/basic/admin-panel/ai-setting.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Before you open the AI Settings page, make sure the following items are ready. B
1616

1717
<Note>
1818
You only need one Vercel account to complete the setup.
19+
20+
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.
1921
</Note>
2022

2123
| Requirement | Required? | Notes |
@@ -59,7 +61,7 @@ Follow these four steps:
5961
</Step>
6062
</Steps>
6163

62-
### 1. Configure LLM API
64+
### Configure LLM API
6365

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

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

75-
### 2. Configure Recommended Models
77+
### Configure Recommended Models
7678

7779
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:
7880

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

85-
### 3. Set chat model
87+
### Set chat model
8688

8789
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.
8890

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

9597
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.
9698

97-
### 4. Configure the runtime and App Builder
99+
### Configure the Runtime and App Builder
98100

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

en/basic/admin-panel/audit-log.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Audit log"
3+
description: "Review instance-wide activity, filter operation history, and inspect audit log details in the Admin Panel."
4+
---
5+
6+
<Tip>Available for self-hosted Business plan and above</Tip>
7+
8+
Path: Admin Panel → Audit log
9+
10+
**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.
11+
12+
## What You Can Review
13+
14+
The audit log covers common administration and collaboration activity, including spaces, bases, tables, views, fields, records, sharing, invitations, access tokens, and the Authority Matrix.
15+
16+
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.
17+
18+
## Filter Logs
19+
20+
Use the filters at the top of the page to narrow the log list:
21+
22+
- **Select Operator**: Show actions performed by a specific user.
23+
- **Select Space**: Show activity within a specific space.
24+
- **Select Base**: Show activity for a specific base.
25+
- **Select Action**: Filter by operation type, such as records, fields, views, tables, bases, sharing, spaces, invitations, users, and access tokens.
26+
27+
If a user, base, or space has been deleted, the entry remains in the log and the resource is marked as deleted.
28+
29+
## Notes
30+
31+
- Only instance administrators can access the Admin Panel.
32+
- The audit log is intended for recent operational review and is retained for one month.

en/basic/admin-panel/automation-management.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Path: Admin Panel → Automation management
1010

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

13-
## 1. Summary Metrics
13+
## Summary Metrics
1414

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

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

26-
## 2. Filters
26+
## Filters
2727

2828
The main page supports filters:
2929

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

33-
## 3. Automation List
33+
## Automation List
3434

3535
The list shows a run summary for each automation:
3636

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

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

45-
## 4. Run History
45+
## Run History
4646

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

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

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

58-
## 5. Actions
58+
## Actions
5959

6060
From the automation list, you can:
6161

en/basic/admin-panel/multitenancy.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ description: "Teable supports organizations, allowing multiple organizations to
66
{/* mintlify-resync: 2026-05-14 */}
77
<Tip>Available for self-hosted Enterprise plan</Tip>
88

9-
### Organization Management
10-
119
Instance administrators access the organization management panel via `Admin Panel` > `Organizations`
1210

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

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

21-
## 1. Organization Management
19+
## Organization Management
2220

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

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

53-
## 2. Tiered Administrator System
51+
## Tiered Administrator System
5452

5553
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.
5654

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

78-
## 3. Use Cases
76+
## Use Cases
7977

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

en/basic/admin-panel/overview.mdx

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

2829
### Administrator Permissions

en/basic/admin-panel/sandbox-agent.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Path: Admin Panel → Sandbox Agent
1010

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

13-
## 1. Enablement Scope
13+
## Enablement Scope
1414

1515
In the **Settings** tab:
1616

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

21-
## 2. Runtime Limits
21+
## Runtime Limits
2222

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

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

3434
Click **Save** after configuring the settings.
3535

36-
## 3. Base Snapshots
36+
## Base Snapshots
3737

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

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

44-
## 4. Sandboxes Tab
44+
## Sandboxes Tab
4545

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

en/basic/ai/app-builder.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ Teable App Builder allows you to turn your data bases into fully functional, cus
1111

1212
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.
1313

14-
> **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).
14+
<Note>
15+
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).
16+
</Note>
1517

1618
## Creating an App
1719

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

114116
### Custom Domains
115117

118+
<Note>Custom domains require the Business plan or above.</Note>
119+
116120
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.
117121

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

120124
<img
121125
src="/images/docs/ai/2026-05-21-app-builder-custom-domain.png"
-91.1 KB
Loading
-95.8 KB
Loading

0 commit comments

Comments
 (0)