diff --git a/docs.json b/docs.json index 155f922..b69f136 100644 --- a/docs.json +++ b/docs.json @@ -329,6 +329,12 @@ "en/deploy/dashboard" ] }, + { + "group": "Compliance & Telemetry", + "pages": [ + "en/deploy/telemetry" + ] + }, { "group": "Maintenance", "pages": [ @@ -687,6 +693,12 @@ "zh/deploy/dashboard" ] }, + { + "group": "合规与遥测", + "pages": [ + "zh/deploy/telemetry" + ] + }, { "group": "维护", "pages": [ diff --git a/en/deploy/env.mdx b/en/deploy/env.mdx index dad0159..7be007f 100644 --- a/en/deploy/env.mdx +++ b/en/deploy/env.mdx @@ -78,7 +78,8 @@ Also ensure the public bucket is configured with **public-read + CORS**. See: [O | Analytics & Monitoring | | MICROSOFT_CLARITY_ID | Microsoft Clarity metrics ID, for enabling Microsoft Clarity analytics | - | - | your-metrics-id | | OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry OTLP endpoint | - | - | http://jaeger:4317 | +| TELEMETRY_REPORT_DISABLED | Disable self-hosted telemetry reporting, including license compliance reports from connected instances | false | - | true | | Database Configuration | | PRISMA_DATABASE_URL | Database connection URL, must be configured | - | Yes | postgresql://teable:teable@127.0.0.1:5432/teable | | PRISMA_TRANSACTION_TIMEOUT | Maximum time (ms) a transaction can run before timing out. Increase for long-running transactions (e.g., bulk updates with many foreign keys) | 5000 | - | 60000 | -| PRISMA_TRANSACTION_MAX_WAIT | Maximum time (ms) to wait to acquire a transaction from the pool | 2000 | - | 5000 | \ No newline at end of file +| PRISMA_TRANSACTION_MAX_WAIT | Maximum time (ms) to wait to acquire a transaction from the pool | 2000 | - | 5000 | diff --git a/en/deploy/telemetry.mdx b/en/deploy/telemetry.mdx new file mode 100644 index 0000000..fdf5aaf --- /dev/null +++ b/en/deploy/telemetry.mdx @@ -0,0 +1,40 @@ +--- +title: "Telemetry" +description: "Learn how Teable self-hosted telemetry works, what is reported, and how to disable it." +--- + +## Overview + +License activation can work offline after you obtain and enter a valid License Key. + +If a self-hosted instance can reach the Internet, it may send a minimal telemetry report for license compliance, security review, fraud prevention, and investigation of unauthorized distributions. + +This telemetry is separate from optional product analytics. It is designed for self-hosted administration and compliance, similar to common service ping, license validation, and anonymous usage reporting practices in self-managed software. + +## What May Be Reported + +Telemetry reports may include product authorization identifiers such as Instance ID and, when a license is installed, License ID; license plan, seat limit, and expiration dates when available; software edition, application version, build version, image digest, and build channel; aggregated usage counts and buckets; instance last activity time; hashed public origin hostname and hashed machine hostname; platform, CPU architecture, and Node.js version; and compliance risk signals. + +Product authorization identifiers such as Instance ID and License ID may be sent in their original form because they are used to validate the deployment and license status. + +Customer or host identifying values such as public origin hostname and machine hostname are hashed before transmission. + +## What Is Not Reported + +Telemetry reports do not include customer workspace content, table records, schema names, field values, SQL queries, application secrets, access credentials, authentication tokens, License Keys, user email lists, user names, or the full public origin URL. + +## Transmission and Retention + +Telemetry reports are encrypted in transit. + +Teable retains raw telemetry events only for as long as reasonably necessary for license compliance, security review, fraud prevention, dispute handling, and audit purposes. Teable may retain aggregated or derived compliance status for the duration of the customer relationship and any legally required retention period. + +## Disable Telemetry Reporting + +Self-hosted administrators can disable telemetry reporting by setting: + +```env +TELEMETRY_REPORT_DISABLED=true +``` + +Disabling telemetry reporting does not by itself prevent offline license activation, but may limit Teable's ability to verify license compliance, detect unauthorized distributions, or investigate license disputes. diff --git a/zh/deploy/activate.mdx b/zh/deploy/activate.mdx index 0da1e32..1cec09d 100644 --- a/zh/deploy/activate.mdx +++ b/zh/deploy/activate.mdx @@ -189,4 +189,3 @@ Teable 在订阅到期后提供 7 天的宽限期。在此宽限期内： - [Docker 部署](/zh/deploy/docker) - [环境配置](/zh/deploy/env) - [邮件配置](/zh/deploy/email) - diff --git a/zh/deploy/env.mdx b/zh/deploy/env.mdx index 3ce5a5e..b758cd5 100644 --- a/zh/deploy/env.mdx +++ b/zh/deploy/env.mdx @@ -78,7 +78,8 @@ mode: "wide" | 分析监控 | | MICROSOFT_CLARITY_ID | Microsoft Clarity 指标 ID，用于启用 Microsoft Clarity 分析 | - | - | your-metrics-id | | OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry OTLP 端点 | - | - | http://jaeger:4317 | +| TELEMETRY_REPORT_DISABLED | 禁用自托管遥测上报，包括联网实例的许可合规上报 | false | - | true | | 数据库配置 | | PRISMA_DATABASE_URL | 数据库连接 URL，必须配置 | - | 是 | postgresql://teable:teable@127.0.0.1:5432/teable | | PRISMA_TRANSACTION_TIMEOUT | 事务运行超时时间（毫秒），对于长时间运行的事务（如包含多个外键的批量更新）可以增加此值 | 5000 | - | 60000 | -| PRISMA_TRANSACTION_MAX_WAIT | 从连接池获取事务的最大等待时间（毫秒） | 2000 | - | 5000 | \ No newline at end of file +| PRISMA_TRANSACTION_MAX_WAIT | 从连接池获取事务的最大等待时间（毫秒） | 2000 | - | 5000 | diff --git a/zh/deploy/telemetry.mdx b/zh/deploy/telemetry.mdx new file mode 100644 index 0000000..10a755c --- /dev/null +++ b/zh/deploy/telemetry.mdx @@ -0,0 +1,40 @@ +--- +title: "遥测上报" +description: "了解 Teable 自托管遥测上报的工作方式、上报内容和关闭方式。" +--- + +## 概述 + +在您获取并输入有效 License Key 后，许可证激活可以离线工作。 + +如果自托管实例可以访问互联网，它可能会发送最小化的遥测上报，用于许可证合规、安全审查、反欺诈以及调查未授权发行版本。 + +该遥测上报与可选的产品分析相互独立，面向自托管管理和合规场景，参考了常见自托管软件采用的服务上报、许可证校验和匿名使用统计做法。 + +## 可能上报的数据 + +遥测上报可能包含 Instance ID，以及安装许可证时的 License ID 等产品授权标识；可用时的许可证套餐、席位限制和到期时间；部署报告的软件版本类型、应用版本、构建版本、镜像 digest 和构建渠道；聚合用量计数和区间；实例最近活跃时间；经过哈希处理的 public origin 主机名和机器主机名；运行平台、CPU 架构、Node.js 版本；以及合规风险信号。 + +Instance ID 和 License ID 属于产品授权标识，可能以原始值发送，用于验证部署和许可证状态。 + +public origin 主机名、机器主机名等可能识别客户或主机的字段会在传输前进行哈希处理。 + +## 不会上报的数据 + +遥测上报不包含客户工作区内容、表格记录、结构名称、字段值、SQL 查询、应用密钥、访问凭据、认证令牌、License Key、用户邮箱列表、用户姓名或完整 public origin URL。 + +## 传输和保留 + +遥测上报在传输过程中加密。 + +Teable 仅在许可证合规、安全审查、反欺诈、争议处理和审计目的所合理必要的期限内保留原始遥测事件，并可能在客户关系存续期间及法律要求的保存期限内保留聚合或派生的合规状态。 + +## 关闭遥测上报 + +自托管管理员可以通过以下环境变量关闭遥测上报： + +```env +TELEMETRY_REPORT_DISABLED=true +``` + +关闭遥测上报本身不会阻止离线许可证激活，但可能影响 Teable 验证许可证合规性、识别未授权发行版本或调查许可证争议的能力。