chore(docs): add license server docs by acerDebugman · Pull Request #35275 · taosdata/TDengine

acerDebugman · 2026-04-30T16:34:25Z

Description

Issue(s)

Close/close/Fix/fix/Resolve/resolve: Issue Link

Checklist

Please check the items in the checklist if applicable.

Is the user manual updated?
Are the test cases passed and automated?
Is there no significant decrease in test coverage?

github-actions · 2026-04-30T16:35:12Z

+
+### 服务信息
+
+- 已在本地启动 CLS 服务， 默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

- 已在本地启动 CLS 服务，默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。

- 已在本地启动 CLS 服务，默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。

Copilot

Pull request overview

新增 License Center（ELS/CLS）离线授权流程的中文参考文档，帮助用户完成 CLS 部署、离线令牌导入，以及 TSDB 侧的 CLS 配置对接。

Changes:

新增 License-Center 参考手册 页面，覆盖离线授权全流程与 TSDB/Explorer 配置入口
补充流程截图资源（ELS/CLS 界面示例）

Reviewed changes

Copilot reviewed 1 out of 14 changed files in this pull request and generated 4 comments.

File	Description
docs/zh/14-reference/01-components/13-license-center/index.mdx	新增 License Center 离线授权操作手册与 TSDB 配置说明
docs/zh/14-reference/01-components/13-license-center/assets/license-center-els-customer-create-entry.png	新增文档配图（ELS 客户管理入口）
docs/zh/14-reference/01-components/13-license-center/assets/license-center-cls-license-import-dialog.png	新增文档配图（CLS 离线导入对话框）

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-30T16:37:24Z

+解压安装包：
+
+```bash
+license-center-cls-0.1.0-linux-amd64.tar.gz


“解压安装包”这段的 bash 代码块里只有压缩包文件名，不是可执行命令；按现有文档惯例这里应给出实际解压命令（例如 tar -zxvf ...），否则读者容易误解为直接执行文件名。

Suggested change

license-center-cls-0.1.0-linux-amd64.tar.gz

tar -zxvf license-center-cls-0.1.0-linux-amd64.tar.gz

Copilot · 2026-04-30T16:37:25Z

+- `local.rpc_port`: 表示与 ELS 服务通信端口
+- `els.host`: 表示 ELS 服务的地址
+- `els.port`: 表示 ELS 服务的端口
+- `els.enable`: 表是否开启与 ELS 的通信


参数说明里 els.enable 这一行有明显笔误，导致语义不通顺：应为“表示是否开启…”。

Suggested change

- `els.enable`: 表是否开启与 ELS 的通信

- `els.enable`: 表示是否开启与 ELS 的通信

Copilot · 2026-04-30T16:37:25Z

+```bash
+ALTER ALL DNODES 'clsEnabled' '1';
+ALTER ALL DNODES 'clsRefreshInterval' '15';
+ALTER ALL DNODES 'clsUrl' 'http://192.168.2.158:6072';
+ALTER ALL DNODES 'clsLicenseId' 'lic-53467044-2dad-4be2-9280-adacb201a644';
+```


SQL 示例使用了 bash 代码块，会导致高亮/复制语义不准确；建议改为 sql，避免读者误以为需要在 shell 里执行。

Copilot · 2026-04-30T16:37:25Z

+
+在 taos-explorer 组件的 系统管理/许可证 页面，点击激活许可证按钮后，可以看到如下配置页面：
+
+![image-20260501002702206](./assets/image-20260501002702206.png)


该图片的替代文本是自动生成的文件名（image-20260501002702206），对屏幕阅读器不友好；建议改为描述性 alt 文本（例如“taos-explorer 许可证激活配置页面”），与本文其余图片保持一致。

Suggested change

![image-20260501002702206](./assets/image-20260501002702206.png)

![taos-explorer 许可证激活配置页面](./assets/image-20260501002702206.png)

gemini-code-assist

Code Review

This pull request introduces a comprehensive reference manual for the License-Center component, covering installation, configuration, and the offline authorization workflow for TDengine TSDB and IDMP. The review feedback suggests several improvements to the documentation, including providing the specific shell command for package extraction, correcting a typo and punctuation inconsistency in the parameter descriptions, using the correct language tag for SQL code blocks, and renaming an image file to be more descriptive.

gemini-code-assist · 2026-04-30T16:39:56Z

+解压安装包：
+
+```bash
+license-center-cls-0.1.0-linux-amd64.tar.gz


The text mentions extracting the package, but only the filename is shown. It is recommended to provide the actual command.

tar -zxvf license-center-cls-0.1.0-linux-amd64.tar.gz

gemini-code-assist · 2026-04-30T16:39:56Z

+- `local.rpc_port`: 表示与 ELS 服务通信端口
+- `els.host`: 表示 ELS 服务的地址
+- `els.port`: 表示 ELS 服务的端口
+- `els.enable`: 表是否开启与 ELS 的通信


Typo: '表' should be '表示' to be consistent with the other parameter descriptions.

gemini-code-assist · 2026-04-30T16:39:56Z

+- `els.enable`: 表是否开启与 ELS 的通信
+- `database.path`: 表示数据存放路径
+- `log.level`: 表示日志级别
+- `log.file`：表示日志路径


Consistency: Use a half-width colon ':' instead of a full-width colon '：' to match the style of the preceding lines.

gemini-code-assist · 2026-04-30T16:39:56Z

+
+```bash
+ALTER ALL DNODES 'clsEnabled' '1';
+ALTER ALL DNODES 'clsRefreshInterval' '15';


The code block contains SQL statements. Using the 'sql' language tag instead of 'bash' will provide better syntax highlighting.

gemini-code-assist · 2026-04-30T16:39:56Z

+
+![image-20260501002702206](./assets/image-20260501002702206.png)
+
+配置字段含义和 SQL 配置一致。


The image filename 'image-20260501002702206.png' appears to be a default name. Consider renaming the file to something more descriptive like 'license-center-explorer-config.png'.

sheyanjie-qq · 2026-05-03T03:55:54Z

+解压安装包：
+
+```bash
+license-center-cls-0.1.0-linux-amd64.tar.gz


Where can the user download the package?

sheyanjie-qq · 2026-05-03T03:56:33Z

+rpc_port = 6073
+
+[els]
+host = "192.168.2.158"


pls use a common ip

sheyanjie-qq · 2026-05-03T03:57:38Z

+
+[els]
+host = "192.168.2.158"
+port = 8094


8094 seems not in the port range.

sheyanjie-qq · 2026-05-03T04:00:47Z

+ALTER ALL DNODES 'clsEnabled' '1';
+ALTER ALL DNODES 'clsRefreshInterval' '15';
+ALTER ALL DNODES 'clsUrl' 'http://192.168.2.158:6072';
+ALTER ALL DNODES 'clsLicenseId' 'lic-53467044-2dad-4be2-9280-adacb201a644';


All license IDs and the like, including those in images, need to be blurred.

sheyanjie-qq · 2026-05-03T04:03:14Z

+
+## 离线授权操作流程
+
+### 1. 在 ELS 中创建客户


The user does not need to operate this part, so do not include it.

Joe Zhang added 2 commits April 22, 2026 09:08

docs: add customer license center usage

296482b

chore: add tsdb cls config paragraph

91b0a5a

Copilot AI review requested due to automatic review settings April 30, 2026 16:34

acerDebugman requested review from guanshengliang and zitsen as code owners April 30, 2026 16:34

taosdata-bot Bot added the internal label Apr 30, 2026

Copilot started reviewing on behalf of acerDebugman April 30, 2026 16:35 View session

github-actions Bot reviewed Apr 30, 2026

View reviewed changes

Copilot AI reviewed Apr 30, 2026

View reviewed changes

chore: remove blank line and blank space

5b51aaa

gemini-code-assist Bot reviewed Apr 30, 2026

View reviewed changes

sheyanjie-qq reviewed May 3, 2026

View reviewed changes


		### 服务信息

		- 已在本地启动 CLS 服务，默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。

	license-center-cls-0.1.0-linux-amd64.tar.gz
	tar -zxvf license-center-cls-0.1.0-linux-amd64.tar.gz

	- `els.enable`: 表是否开启与 ELS 的通信
	- `els.enable`: 表示是否开启与 ELS 的通信


		在 taos-explorer 组件的系统管理/许可证页面，点击激活许可证按钮后，可以看到如下配置页面：

		![image-20260501002702206](./assets/image-20260501002702206.png)

	![image-20260501002702206](./assets/image-20260501002702206.png)
	![taos-explorer 许可证激活配置页面](./assets/image-20260501002702206.png)


		![image-20260501002702206](./assets/image-20260501002702206.png)

		配置字段含义和 SQL 配置一致。

Conversation

acerDebugman commented Apr 30, 2026

Description

Issue(s)

Checklist

Uh oh!

github-actions Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

sheyanjie-qq May 3, 2026

Choose a reason for hiding this comment

Uh oh!

sheyanjie-qq May 3, 2026

Choose a reason for hiding this comment

Uh oh!

sheyanjie-qq May 3, 2026

Choose a reason for hiding this comment

Uh oh!

sheyanjie-qq May 3, 2026

Choose a reason for hiding this comment

Uh oh!

sheyanjie-qq May 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants