Skip to content

docs: clarify search reports and SSRF setting #189

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
HynLcc merged 1 commit into from
Jul 22, 2026
Merged

docs: clarify search reports and SSRF setting #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions en/basic/admin-panel/table-query-ops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Use **Table Query Ops** when views, filters, relations, or searches on a large t

Choose **Table**, **Base**, or **Space**, then enter the corresponding ID and select an analysis type. Start with **Table** when you already know which table is slow.

Click **Generate query report** or **Generate search report**. The report summarizes detected risks and recommended next actions.
Click **Generate query report** or **Generate search report**. The report summarizes detected risks and recommended next actions. For a search report, **EXPLAIN sample search** is optional. Add a sample to compare ILIKE and full-text search matches and query plans. Teable does not save the sample value.

<Info>The query report does not change the database. A full-text search recommendation requires administrator confirmation before Teable applies a database change.</Info>
<Info>The query report does not change the database. Applying a full-text search recommendation requires an **EXPLAIN sample search** and administrator confirmation.</Info>

For a large table, review the impact and schedule any confirmed change for a suitable maintenance window.
1 change: 1 addition & 0 deletions en/deploy/env.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ mode: "wide"
| **Security & Verification** | | | | |
| TURNSTILE_SITE_KEY | Cloudflare Turnstile site key for authentication verification | - | - | 1x00000000000000000000AA |
| TURNSTILE_SECRET_KEY | Cloudflare Turnstile secret key for authentication verification | - | - | 1x0000000000000000000000000000000AA |
| TEABLE_SSRF_PROTECTION_DISABLED | Disable protection that blocks outbound requests to loopback, private, link-local, and other reserved network addresses. Set to true only in trusted self-hosted deployments that must access internal endpoints | false | - | true |
| BACKEND_SIGNUP_VERIFICATION_CODE_RATE_LIMIT_SECONDS | Rate limit interval (seconds) for sending signup verification emails | - | - | 30 |
| BACKEND_TRUST_PROXY | Reverse proxy trust setting used to resolve the client IP behind a proxy. Affects audit logs and related security records. Accepts `true`, `false`, a hop count, or an IP/CIDR/preset list. Empty trusts private-network proxies | loopback, linklocal, uniquelocal | - | loopback, linklocal, uniquelocal |
| **Email Configuration (Deprecated - Use Admin Panel > Instance settings > Email)** | | | | |
Expand Down
4 changes: 2 additions & 2 deletions zh/basic/admin-panel/table-query-ops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ description: "分析慢查询，并查看可能的数据库优化建议。"

选择 **表**、**Base** 或 **Space**，填写对应 ID，再选择分析类型。如果已经知道哪张表较慢，建议从 **表** 开始分析。

点击 **生成查询报告** 或 **生成搜索报告**。报告会汇总发现的风险和建议的后续操作。
点击 **生成查询报告** 或 **生成搜索报告**。报告会汇总发现的风险和建议的后续操作。生成搜索报告时，**EXPLAIN 样例搜索词**为可选项。填写后，报告会比较 ILIKE 与全文搜索的命中结果和执行计划。Teable 不会保存这个搜索词。

<Info>查询报告不会修改数据库。全文搜索建议需要管理员确认后，Teable 才会执行数据库变更。</Info>
<Info>查询报告不会修改数据库。执行全文搜索建议前，必须填写 **EXPLAIN 样例搜索词**并由管理员确认。</Info>

对于大表，请先评估影响，并把需要确认执行的变更安排在合适的维护窗口。
1 change: 1 addition & 0 deletions zh/deploy/env.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ mode: "wide"
| **安全验证配置** | | | | |
| TURNSTILE_SITE_KEY | Cloudflare Turnstile 站点密钥，用于身份验证验证 | - | - | 1x00000000000000000000AA |
| TURNSTILE_SECRET_KEY | Cloudflare Turnstile 秘密密钥，用于身份验证验证 | - | - | 1x0000000000000000000000000000000AA |
| TEABLE_SSRF_PROTECTION_DISABLED | 关闭出站请求保护，不再阻止回环、私有、链路本地和其他保留网络地址。仅当可信私有化部署必须访问内部接口时设为 true | false | - | true |
| BACKEND_SIGNUP_VERIFICATION_CODE_RATE_LIMIT_SECONDS | 注册验证邮箱发送频率间隔限制（秒） | - | - | 30 |
| BACKEND_TRUST_PROXY | 反向代理信任配置，用于在代理后识别客户端 IP，影响审计日志等安全记录。支持 `true`、`false`、代理跳数，或 IP/CIDR/preset 列表。为空时信任私有网络代理 | loopback, linklocal, uniquelocal | - | loopback, linklocal, uniquelocal |
| **邮件配置（已弃用 - 请使用管理面板 > 实例设置 > 邮箱）** | | | | |
Expand Down