-
Notifications
You must be signed in to change notification settings - Fork 5k
chore(docs): add license server docs #35275
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.
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
base: main
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,174 @@ | ||||||
| --- | ||||||
| title: License-Center 参考手册 | ||||||
| sidebar_label: License-Center | ||||||
| toc_max_heading_level: 4 | ||||||
| --- | ||||||
|
|
||||||
| License Center 是一个用于管理 TDengine TSDB / IDMP 授权的 Web 服务,包含中心侧的 ELS 管理端和本地侧的 CLS 管理端。本文以当前本地已部署的 CLS 为例,介绍离线授权的完整操作流程。 | ||||||
|
|
||||||
| ## 前置条件 | ||||||
|
|
||||||
| ### 部署安装 | ||||||
|
|
||||||
| 解压安装包: | ||||||
|
|
||||||
| ```bash | ||||||
| license-center-cls-0.1.0-linux-amd64.tar.gz | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where can the user download the package? |
||||||
| ``` | ||||||
|
|
||||||
| 解压后即可看到部署相关脚本: | ||||||
|
|
||||||
| ```bash | ||||||
| scripts/ | ||||||
| ├── install.sh | ||||||
| ├── start.sh | ||||||
| ├── status.sh | ||||||
| ├── stop.sh | ||||||
| └── uninstall.sh | ||||||
| ``` | ||||||
|
|
||||||
| 执行 install.sh,start.sh 后即可启动服务。 | ||||||
|
|
||||||
| ### 配置信息 | ||||||
|
|
||||||
| 默认配置文件在 `/etc/taoscls/taoscls.toml`: | ||||||
|
|
||||||
| ```toml | ||||||
| [local] | ||||||
| listen = "0.0.0.0" | ||||||
| http_port = 6072 | ||||||
| rpc_port = 6073 | ||||||
|
|
||||||
| [els] | ||||||
| host = "192.168.2.158" | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. pls use a common ip |
||||||
| port = 8094 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 8094 seems not in the port range. |
||||||
| enable = true | ||||||
|
|
||||||
| [database] | ||||||
| path = "/var/lib/taoscls" | ||||||
|
|
||||||
| [log] | ||||||
| level = "info" | ||||||
| file = "/var/log/taoscls/taoscls.log" | ||||||
| ``` | ||||||
|
|
||||||
| 参数说明: | ||||||
|
|
||||||
| - `local.listen`: 表示服务监听的地址,默认 0.0.0.0 表示监听所有网卡地址 | ||||||
| - `local.http_port`: 表示开启的 http api 服务端口 | ||||||
| - `local.rpc_port`: 表示与 ELS 服务通信端口 | ||||||
| - `els.host`: 表示 ELS 服务的地址 | ||||||
| - `els.port`: 表示 ELS 服务的端口 | ||||||
| - `els.enable`: 表是否开启与 ELS 的通信 | ||||||
|
||||||
| - `els.enable`: 表是否开启与 ELS 的通信 | |
| - `els.enable`: 表示是否开启与 ELS 的通信 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶
| - 已在本地启动 CLS 服务, 默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。 | |
| - 已在本地启动 CLS 服务,默认情况下会在本机管理端显示 `CLS ID` 和公钥令牌。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The user does not need to operate this part, so do not include it.
Check failure on line 142 in docs/zh/14-reference/01-components/13-license-center/index.mdx
GitHub Actions / check-with-markdownlint
Multiple consecutive blank lines
docs/zh/14-reference/01-components/13-license-center/index.mdx:142 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
Check failure on line 143 in docs/zh/14-reference/01-components/13-license-center/index.mdx
GitHub Actions / check-with-markdownlint
Multiple consecutive blank lines
docs/zh/14-reference/01-components/13-license-center/index.mdx:143 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All license IDs and the like, including those in images, need to be blurred.
Copilot
AI
Apr 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SQL 示例使用了 bash 代码块,会导致高亮/复制语义不准确;建议改为 sql,避免读者误以为需要在 shell 里执行。
Copilot
AI
Apr 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
该图片的替代文本是自动生成的文件名(image-20260501002702206),对屏幕阅读器不友好;建议改为描述性 alt 文本(例如“taos-explorer 许可证激活配置页面”),与本文其余图片保持一致。
|  | |
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
“解压安装包”这段的 bash 代码块里只有压缩包文件名,不是可执行命令;按现有文档惯例这里应给出实际解压命令(例如 tar -zxvf ...),否则读者容易误解为直接执行文件名。