GitPuk 代码管理工具安装配置与入门实战

GitPuk 是一款国产开源免费的代码管理工具，简洁易用。本文将讲解如何快速安装和配置 GitPuk，以及入门教程。

1、安装

支持 Windows、Mac、Linux、Docker 等操作系统。

1.1 Linux 安装

本文以 Ubuntu 为例

下载访问官网获取安装包，或通过命令在线安装。
```
wget -O tiklab-gitpuk-1.1.4.deb [下载地址]
```
安装上传之后执行以下命令安装，默认安装在 opt 目录下。
```
dpkg -i tiklab-gitpuk-1.1.4.deb # Ubuntu 安装命令
```
启动安装之后会在 opt 目录下出现一个名字为 tiklab-GitPuk 的文件夹，在 tiklab-GitPuk 下的 bin 文件夹下，执行 ./gitpuk start 命令，启动项目。
```
./gitpuk start
```

1.2 Docker 安装

下载访问官网获取安装包，或通过命令在线安装。
```
wget -O tiklab-gitpuk-1.1.4.tar.gz [下载地址]
```
安装安装包名字为 tiklab-gitpuk-1.1.4.tar.gz，下载完成执行以下命令加载镜像。
```
docker load -i tiklab-gitpuk-1.1.4.tar.gz
```
启动加载完成后，执行以下命令镜像启动。
```
docker run -itd -p 9800:9800 tiklab-gitpuk:1.1.4
```

1.3 Windows 安装

下载：访问官网获取安装包
安装：双击可执行文件 --> 选择安装位置 --> 点击安装
启动：安装完成后点击桌面 GitPuk 图标即可启动

1.4 MacOS 安装

下载：访问官网获取安装包
安装：双击可执行文件 --> 将 tiklab-gitpuk-1.1.4.app 拉入应用程序中即可
启动：安装完成后点击启动 GitPuk 图标即可启动

2、登录

启动完成后，浏览器中访问 http://ip:9800 就可以打开 GitPuk 界面，默认登录账号密码为 admin/123456。
同时支持企业微信、钉钉、LDAP 登录方式，需要先去配置相关文档。

![图片]

登入页面

![图片]

GitPuk 登入首页

支持登录方式：

支持类型	说明
账号登录	默认登录方式
企业微信登录	企业微信用户扫描登录
钉钉登录	钉钉用户扫描登录
LDAP 登录	LDAP 用户登录

3、配置

进入项目 config 文件下，修改 application.yaml 可自定义配置。

3.1 自定义应用端口

修改文件中的 server.port 的值为自己想要配置的端口，重新启动即可。

![图片]

3.2 配置数据库

使用的数据库为 PostgreSQL，GitPuk 同时支持使用外部数据库以及内嵌数据库。默认使用内嵌数据库。
外部数据库：用户自己定义链接数据库的地址，用户名，密码等。
内嵌数据库：使用系统内置的数据库。

（1）使用外部数据库

注意：使用外部数据库的时候，需要将内嵌数据库 postgresql.embbed.enable 后面的数据修改为 false。

![图片]

属性说明：

字段	说明
jdbc.url	数据库地址，修改为自己的外部数据库地址
jdbc.username	数据库用户，修改为自己的外部数据库用户
jdbc.password	数据库密码，修改为自己的外部数据库密码

（2）使用内嵌数据库

默认使用的是内嵌数据库。

![图片]

属性说明：

字段	描述
postgresql.embbed.enable	是否使用内嵌数据库，true(使用)、false(不使用)。如果配置 false，需要把 jdbc 下的数据库连接信息更改为自己的数据库地址、用户、密码
postgresql.embbed.database	内嵌数据库名字。如果需要修改内嵌数据库名字，同时也要修改 jdbc.url 后面的数据库名字
postgresql.db.port	内嵌数据库的端口。如果需要更改，同时也要修改 jdbc.url 后面的数据库端口
postgresql.db.username	内嵌数据库用户名。如果需要更改，同时也要修改 jdbc.username 值
postgresql.db.password	内嵌数据库密码。如果需要更改，同时也要修改 jdbc.password 值
postgresql.db.address	内嵌数据库存储地址。注意：如果更改该目录，该路径目录必须为空目录，否则会导致数据库无法启动

3.3 数据地址

DATA_HOME 为数据文件存放地址。

# 数据存放地址

![图片]

属性说明：

属性	值
DATA_HOME	数据文件存放地址

4、快速入门

4.1 仓库管理

创建仓库 在仓库界面中点击创建仓库输入对应内容即可。

![图片]

属性说明：

字段	必填	说明
仓库名称	是	仓库名称
仓库地址	是	分为仓库组的选择、仓库地址
权限	是	分为全局、私有
初始化仓库	否	初始化 README.md 文件.gitignore 文件

导入第三方 git 仓库 在仓库界面中点击创建仓库选择导入仓库即可。支持 GitLab、Gitee、GitHub、bitbucket 第三方代码仓库工具的导入。

![图片]

编辑仓库 点击要编辑的仓库设置即可。
查询仓库 点击右上角搜索框，输入对应内容即可。

![图片]

删除仓库 进入仓库设置页面，点击删除仓库即可。

![图片]

4.2 代码管理

拉取代码 进入你创建的代码库后，可点击右上角克隆选择你要拉的方式。

![图片]

下载 GitPuk 除了拉取之外也同样支持下载，可以选择你要的格式进行下载。

![图片]

新建文件文件夹 进入到 GitPuk 仓库中，点击右上角加号即可新建文件或文件夹。

![图片]

查询代码文件内容
1. 查询代码文件，支持切换分支、标签的代码。
2. 查询代码文件内容，点击文件名字，进入文件内容。

![图片]

4.3 分支管理

创建分支 点击右上角新建分支，输入对应内容即可。

![图片]

切换分支 进入设置点击分支设置，选择要切换的分支保存即可。

![图片]

查询分支 点击右上角搜索框输入对应内容即可。

![图片]

删除分支 点击分支右侧设置，点击删除即可。

![图片]

创建合并请求
1. 进入合并请求界面，点击新建合并请求按钮进入创建合并请求的界面。
![图片]
1. 将源分支合并到目标分支。选择源分支、目标分支，输入标题，选择评审人然后点击创建合并请求按钮创建合并请求，选择的源分支和目标分支提交有差异才会显示基础信息、提交记录、文件改动。
![图片]
1. 选择的源分支和目标分支存在已经开启的合并请求，只需要点击查看合并请求直接进入已经创建的合并请求详情界面，如果选择的源分支和目标分支没有差异，是创建不了合并请求。
![图片]
查询合并请求 进入仓库详情，点击合并请求查询合并请求列表，查询条件：全部、已开启、已合并、已关闭的以及模糊查询合并请求标签。

![图片]

执行合并请求
1. 执行合并前需要满足两个条件：1. 源分支和目标分支没有冲突；2. 审核通过（存在多个审核人时候，只需要一个审核通过即可执行合并）。
![图片]
1. 选择合并类型，打开确认弹窗，点击提交执行合并，合并后是否删除源分支，默认不删除。
![图片]

4.4 提交管理

查询仓库提交 查询提交：点击仓库名字后点击提交 tab，可以根据切换分支、切换用户、提交信息模糊查询。

![图片]

复制 commitId 点击复制按钮复制完整的 commitId，界面只展示了 8 位。commitId 是提交代码的时候 git 生成的标识。

![图片]

跳转当前提交代码 点击跳转代码图标。会展示对应提交的代码。

![图片]

4.5 代码扫描

GitPuk 集成开放 在系统集成中添加 sourcefare，输入对应内容点击确定即可。

![图片]

sourcefare 集成开放 在系统集成中添加 GitPuk，输入对应内容点击确定即可。

![图片]

创建项目
1. 集成后打开 SourceFare 点击新建项目。
![图片]
1. 选择和输入对应内容即可。
![图片]
编辑扫描计划
1. 打开右边操作选项，点击编辑即可。
![图片]
查询项目 点击右上方搜索框，输入对应内容。

![图片]

执行扫描计划
1. 点击扫描报告上方的扫描按钮即可。
![图片]
1. 扫描完成后可点击日志查看扫描详细。
![图片]
关联扫描计划 扫描完成后，可在 GitPuk 中关联当前扫描计划。

![图片]

GitPuk 代码管理工具安装配置与入门实战