部署与配置客户端
通过源代码
依赖环境
系统环境
- Linux，Windows或macOS
环境准备
- Python 3.7，安装指引
使用步骤
安装第三方库
# 源码根目录下执行
pip3 install -r client/requirements/app_reqs.pip
安装第三方工具
# 源码根目录
cd client/requirements
# 执行安装脚本
# Linux/macOS环境
./install.sh
# Windows环境
./install.bat
配置客户端
配置
client/config.ini文件将
<Server IP地址>替换成实际的serve ip（可包含端口号）。
配置
client/codedog.ini文件必填项：
token、org_sid、team_name、source_dir个人令牌 -
token：从 TCA 页面获取，前往[个人中心]-[个人令牌]-复制Token
团队编号 -
org_sid：进入 TCA 项目概览页，从 URL 中获取项目名称 -
team_name：：进入 TCA 项目概览页，从 URL 中获取提示
项目概览URL格式：
http://{域名}/t/{org_sid}/p/{team_name}/profile分析路径 -
source_dir: 本地代码目录路径
提示
如果项目代码为编译型语言（比如：C/C++，C#，Go，Java，Kotlin，Objective-C等），且使用的分析方案中配置了编译型工具（如图，使用了OC推荐规则包），需要填写
build_cmd编译命令。其他可选项按需填写，不填写时按默认配置执行
启动客户端
# 源码根目录
cd client
# 执行客户端脚本
python3 codepuppy.py localscan
注意
Client 的实现及启动脚本均依赖 Python3 版本为 3.7，可执行 python3 --version 查看版本。若版本有误，可安装版本为3.7的python并软链接到python3命令。
提示
codedog.ini各项参数可由命令行传入，获取详细参数说明可运行python3 codepuppy.py localscan -h使用
localscan命令启动本地单次的代码分析，如需启动分布式并行分析任务，请参考使用分布式节点模式进行配置。
通过Docker-Compose
提示
适用于快速上手体验。使用docker运行，可以免去客户端环境依赖的安装，避免环境兼容性问题。
但是由于环境受限于docker，会无法复用本地的编译环境，部分需要编译的工具无法使用。
使用步骤
配置客户端
配置
client/config.ini文件配置
client/codedog.ini文件
提示
同通过源代码使用-配置客户端
构建镜像
docker build -t tca-client .
启动客户端
方案一：直接使用docker运行
进入client目录，执行以下命令
# 按照实际情况填写`SOURCE_DIR`环境变量值
export SOURCE_DIR=需要扫描的代码目录绝对路径
docker run -it --rm -v $PWD:/workspace/client -v $SOURCE_DIR:/workspace/src --name tca-client tca-client
方案二：使用docker内bash终端运行
进入docker容器内的bash终端
# 按照实际情况填写`SOURCE_DIR`环境变量值 export SOURCE_DIR=需要扫描的代码目录绝对路径 docker run -it --rm -v $PWD:/workspace/client -v $SOURCE_DIR:/workspace/src --name tca-client tca-client bash通过命令行启动client代码
python3 codepuppy.py localscan
通过可执行文件
依赖环境
系统环境
- Linux，Windows或macOS
使用步骤
下载客户端
从发布页面下载与系统相对应的客户端压缩包到本地。
解压缩。
配置客户端
配置
client/config.ini文件配置
client/codedog.ini文件
提示
同通过源代码使用-配置客户端
启动客户端
进入到client目录下，执行客户端
./codepuppy localscan