Skip to content
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

add license doc #1177

Merged
merged 9 commits into from
Nov 9, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,9 @@ master分支的代码更新速度快,如果安装了master分支对应的开

## 下一步

- [管理Nebula Graph服务](../../2.quick-start/5.start-stop-service.md)

- [连接Nebula Graph](../../2.quick-start/3.connect-to-nebula-graph.md)
- (企业版)[设置企业版License](../4.install-nebula-graph-from-tar.md)
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

- [基础操作语法](../../2.quick-start/4.nebula-graph-crud.md)
- [管理Nebula Graph服务](../../2.quick-start/5.start-stop-service.md)

## CMake参数

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,6 @@

## 下一步

使用`scripts`目录中的`nebula.service`文件启动Nebula Graph,详情参见[管理Nebula Graph服务](../manage-service.md)。
- (企业版)[设置企业版License](../4.install-nebula-graph-from-tar.md)

- [管理Nebula Graph服务](../manage-service.md)
61 changes: 61 additions & 0 deletions docs-2.0/4.deployment-and-installation/deploy-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# 设置企业版License

Nebula Graph企业版需要设置License才可以正常启动并使用企业版功能,本文介绍如何设置企业版的License文件。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

!!! enterpriseonly

License是为企业版用户提供的软件授权证书,企业版用户可以发送邮件至`[email protected]`申请License文件。

## 注意事项

- 没有设置License时,Nebula Graph企业版无法启动。

- 请勿修改文件,否则会导致License失效。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

- License过期后,将无法执行任何操作。请及时发送邮件至`[email protected]`申请续期。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

## License说明

用户可以用`cat`等命令查看License文件内容,示例文件如下:
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

```bash
----------License Content Start----------
{
"vendor": "Vesoft_Inc",
"organization": "doc",
"issuedDate": "2021-11-07T16:00:00.000Z",
"expirationDate": "2021-11-30T15:59:59.000Z",
"product": "nebula_graph",
"version": ">2.6.1",
"licenseType": "enterprise"
}
----------License Content End----------

----------License Key Start----------
cofFcOxxxxxxxxxxxxxhnZgaxrQ==
----------License Key End----------
```

License文件包含生效时间、过期时间等信息。说明如下。

|参数|说明|
|:---|:---|
|`vendor`|发放渠道。|
|`organization`|用户名称。|
|`issuedDate`|License生效时间。|
|`expirationDate`|License过期时间。|
|`product`|产品类型。Nebula Graph的产品类型为`nebula_graph`。|
|`version`|版本支持的信息。|
|`licenseType`|License类型。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。|
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

## 设置License

1. 安装Nebula Graph企业版。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

2. 申请License文件。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

3. 将License文件上传到所有包含Meta服务的机器上,路径为安装目录的`share/resources/`内。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

!!! note

周边工具的License文件上传位置,请参见具体工具的说明文档。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,5 +143,7 @@ RPM和DEB是Linux系统下常见的两种安装包格式,本文介绍如何使

## 后续操作

- (企业版)[设置企业版License](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-license.md)

- [启动Nebula Graph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/5.start-stop-service/)<!--这里用外链。-->
- [连接Nebula Graph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/)<!--这里用外链。-->
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ nav:
- 使用tar.gz文件安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- 使用Docker Compose部署: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- 使用RPM/DEB包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- 设置企业版License: 4.deployment-and-installation/deploy-license.md
- 管理服务: 4.deployment-and-installation/manage-service.md
- 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md
- 升级版本:
Expand Down