Skip to content

Commit

Permalink
Merge pull request #963 from bensonhome/main
Browse files Browse the repository at this point in the history
🎨更新客户端使用文档
  • Loading branch information
nickcdon authored Dec 6, 2023
2 parents af7a469 + a628aed commit 4686723
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 22 deletions.
7 changes: 1 addition & 6 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,7 @@
- (2) 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat`(windows环境)

### 4. 配置client/config.ini文件
-(1)将`<Server IP地址>`替换成实际的serve ip(可包含端口号)。

-(2)国内使用github拉取网络较慢,推荐使用腾讯工蜂拉取,需要修改以下配置:
- 修改 `TOOL_CONFIG_URL`=`https://git.code.tencent.com/TCA/tca-tools/puppy-tools-config.git`
- 前往[腾讯工蜂网站](https://git.code.tencent.com)注册账号,作为拉取工具使用(已经注册过的可以直接使用)
- 将腾讯工蜂的账号密码填写到`TOOL_LOAD_ACCOUNT`中(由于腾讯工蜂的开源仓库也要求使用账号才能拉取,所以此处必须填写账号密码)
-`<Server IP地址>`替换成实际的serve ip(可包含端口号)。

### 5. 配置client/codedog.ini文件(分布式节点模式无需配置)
填写以下必填项:`token`,`org_sid`,`team_name`,`source_dir`
Expand Down
12 changes: 4 additions & 8 deletions doc/en/guide/客户端/本地分析.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,14 @@
## 分析配置

### 配置客户端 `config.ini` 文件

1.`<Server IP地址>` 替换成实际的TCA平台IP(可包含端口号)

2. 国内使用github拉取网络较慢,推荐使用腾讯工蜂拉取,需要修改以下配置:
- 修改 `TOOL_CONFIG_URL=https://git.code.tencent.com/TCA/tca-tools/puppy-tools-config.git`
-[腾讯工蜂](https://git.code.tencent.com)的账号密码填写到`TOOL_LOAD_ACCOUNT `中。(注:没有腾讯工蜂账号的需要注册;由于腾讯工蜂的开源仓库也要求使用账号才能拉取,所以此处必须填写账号密码)
-`<Server IP地址>` 替换成实际的TCA平台IP(可包含端口号)

### 配置客户端 `codedog.ini` 文件

`codedog.ini`获取方法:
- 方法一: 下载TCA源码或[开源版release](https://github.com/Tencent/CodeAnalysis/releases)的客户端包,在源码目录中复制`CodeAnalysis/client/codedog.ini`并按文件内配置说明进行修改。
- 方法二: 在TCA平台平台上配置好对应信息后,下载配置文件到本地使用。
- 方法一: 打开TCA源码`CodeAnalysis/client/codedog.ini`,填写配置信息
- 方法二: 从[开源版release](https://github.com/Tencent/CodeAnalysis/releases)下载客户端包,解压后打开codedog.ini,填写配置信息。
- 方法三: 在TCA平台平台上配置好对应信息后,下载配置文件到本地使用。

![下载配置文件](../../../images/start_scan_03.png)

Expand Down
12 changes: 4 additions & 8 deletions doc/zh/guide/客户端/本地分析.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,14 @@
## 分析配置

### 配置客户端 `config.ini` 文件

1.`<Server IP地址>` 替换成实际的TCA平台IP(可包含端口号)

2. 国内使用github拉取网络较慢,推荐使用腾讯工蜂拉取,需要修改以下配置:
- 修改 `TOOL_CONFIG_URL=https://git.code.tencent.com/TCA/tca-tools/puppy-tools-config.git`
-[腾讯工蜂](https://git.code.tencent.com)的账号密码填写到`TOOL_LOAD_ACCOUNT `中。(注:没有腾讯工蜂账号的需要注册;由于腾讯工蜂的开源仓库也要求使用账号才能拉取,所以此处必须填写账号密码)
-`<Server IP地址>` 替换成实际的TCA平台IP(可包含端口号)

### 配置客户端 `codedog.ini` 文件

`codedog.ini`获取方法:
- 方法一: 下载TCA源码或[开源版release](https://github.com/Tencent/CodeAnalysis/releases)的客户端包,在源码目录中复制`CodeAnalysis/client/codedog.ini`并按文件内配置说明进行修改。
- 方法二: 在TCA平台平台上配置好对应信息后,下载配置文件到本地使用。
- 方法一: 打开TCA源码`CodeAnalysis/client/codedog.ini`,填写配置信息
- 方法二: 从[开源版release](https://github.com/Tencent/CodeAnalysis/releases)下载客户端包,解压后打开codedog.ini,填写配置信息。
- 方法三: 在TCA平台平台上配置好对应信息后,下载配置文件到本地使用。

![下载配置文件](../../../images/start_scan_03.png)

Expand Down

0 comments on commit 4686723

Please sign in to comment.