1.点击添加扫描计划，打开创建扫描计划的弹窗

1.点击编辑图标，打开编辑扫描计划的弹窗。

2.添加计划名称、选择分支、扫描方案执行修改。

点击仓库名字进入仓库详情，点击代码扫描进入扫描计划列表。

1.点击扫描计划的执行按钮，执行扫描。

2.点击扫描计划名字进入扫描计划详情——>点击扫描按钮执行扫描。

3.点击执行扫描，会自动打开扫描日志弹窗。执行完成后也可以在扫描报告的日志图标打开日志。

代码扫描

更好地组织和管理多个相关的代码仓库。

管理员可以创建多个仓库组，可以选择仓库组权限，可选择全局或私有。

登入GitPuk-->点击仓库组-->点击右上角的创建仓库组-->输入仓库组名称-->选择仓库的权限-->点击确定即可。

登入GitPuk-->点击仓库组-->点击创建仓库组的设置-->即可编辑仓库组信息。

登入GitPuk-->点击查询-->选择你要查询的仓库权限-->输入仓库组名称即可。

登入GitPuk-->点击仓库组-->点击要删除的仓库组设置-->点击确定输入名称即可。

在仓库界面中点击创建仓库 -> 进入新建仓库列表 —> 填写信息。

在仓库界面中点击创建仓库 ->选择导入仓库 ->选择第三方应用 ->配置第三方应用access Token->导入仓库

支持GitLab、Gitee、GitHub、bitbucket第三方代码仓库工具的导入。

点击要编辑的仓库设置-->点击仓库信息-->输入要编辑的内容点击确定即可。

点击仓库-->点击右上角搜索-->选择创建的仓库权限-->输入仓库名称即可。

点击仓库-->选择要删除的仓库-->点击仓库的设置-->点击删除仓库输入名称即可。

仓库管理

1.打开添加扫描方案，点击+ 按钮打开添加扫描方案弹窗。

2.添加sonar扫描方案，扫描方式选择sonar。需要先在扫描环境中添加扫描环境，执行环境就是maven环境、sonar环境，sonar需要自己下载。

3.添加规则包扫描方案，扫描方式选择规则包扫描，选择该扫描方案检测的语言，再添加规则包点击确定创建扫描方案。

进入方式： 点击设置图标—— >扫描配置——>扫描方案

鼠标放入扫描方案。点击... 图标，选择删除打开删除弹窗。默认的扫描方案不可删除。

进入方式： 点击设置图标—— >扫描配置——>扫描规则集

点击规则集名字——>点击规则名称，打开规则详情。

进入方式： 点击设置图标—— >扫描配置——>扫描环境，代码扫描分为sonar扫描、规则包扫描，sonar方式扫描需要配置maven以及sonar连接信息。

点击添加配置按钮打开添加环境配置弹窗，环境配置类型选择maven。 地址：maven安装的地址+/bin 

环境配置类型选择sonar。sonar扫描需要安装sonar ,通过配置sonar地址、认证信息连接到sonar。

点击... 图标，打开删除弹窗删除扫描环境。

1. 查询代码文件，支持切换分支、标签的代码。

2.查询代码文件内容，点击文件名字，进入文件内容。

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

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

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

进入方式： 点击设置图标—— >仓库配置——>SSH密钥

       ssh-keygen -t rsa -C "账号邮箱"         //创建新的 SSH 私钥与公钥密钥对，输入账号邮箱作为标签

  Enter file in which to save the key (/Users/you/.ssh/id_rsa)      //推荐使用默认地址

 Enter passphrase (empty for no passphrase)  //此处直接回车即可；若设置密码，则每次使用 SSH 方式推送代码时都会要求输入密码

 Enter same passphrase again  //  直接回车

点击新建密钥按钮，打开新建密钥弹窗。输入标题、公钥、过期时间点击确定创建密钥。生成密钥，可以点击怎么生成公钥跳转密钥生成方式；过期时间，点击图标查看说明（超过过期时间公钥将自动失效，如未设置视为「永久有效」）

点击密钥编辑图标，打开更新密钥弹窗，更新标题、过期时间

点击...图标——>选择删除,打开删除弹窗——>点击确认，删除密钥。删除密钥后该密钥就不能作为SSH方式拉取和推送代码的验证

进入方式： 点击设置图标—— >仓库配置——>资源监控

其他功能

进入创建的git仓库点击分支-->点击右上角的新建分支-->输入分支名称选择分支来源即可。

点击左下角设置-->点击分支设置-->点击切换分支-->选择你要切换的分支更新即可。

点击分支-->点击右上角搜索-->输入分支名称回车即可。

点击分支-->选择要删除的分支-->点击右边的设置-->选择删除点击确定即可。

1.进入合并请求界面，点击新建合并请求按钮进入创建合并请求的界面。

2.将源分支合并到目标分支。选择源分支、目标分支 ，输入标题，选择评审人然后点击创建合并请求按钮创建合并请求，选择的源分支和目标分支提交有差异才会显示基础信息、提交记录、文件改动。

3.选择的源分支和目标分支存在已经开启的合并请求，只需要点击查看合并请求直接进入已经创建的合并请求详情界面。

4.如果选择的源分支和目标分支没有差异，是创建不了合并请求。

进入仓库详情，点击合并请求查询合并请求列表，查询条件：全部、已开启、已合并、已关闭的以及模糊查询合并请求标签。

1.执行合并前需要满足两个条件：1. 源分支和目标分支没有冲突 ； 2. 审核通过（存在多个审核人时候，只需要一个审核通过即可执行合并）

2.选择合并类型，打开确认弹窗，点击提交执行合并，合并后是否删除源分支，默认不删除。

分支管理

快速入门

GitPuk

GitPuk - 文档

在我们开发过程中为了管理代码、加强团队协作经常会使用代码管理工具。市面上主流产品有github、gitlab、gitee、bitbucket以及云效等代码管理工具，这里给大家推荐另外一款开源免费、简洁易用的代码管理工具GitPuk。

功能包括仓库组、代码库、分支、分支合并、代码扫描、git-lfs大文件存储等其他功能。

更好地组织和管理多个相关的代码仓库。通过创建仓库组，团队可以更有效地对一系列相关联的项目进行分类。

简洁的仓库管理界面，易用的属性，极大的提高了开发的效率。

包含代码、提交信息、分支、标签、扫描等主要功能

通过http、ssh协议推送拉取代码，使用ssh需要先添公钥。

代码库内有提交次数统计、提交频率统计。

每个项目拥有独立的成员与权限管理模块，并且支持自定义权限。

多分支管理结合分支的合并功能，在团队开发中极大的增加了协同能力，不同分支的代码文件对比，明确的看到代码的变动情况。

提高开发团队在多个分支之间高效协作。GitPuk 能够自动检测冲突，并为开发者提供直观的冲突解决方案，确保代码合并的准确性和一致性。

代码扫描是一种自动化工具，旨在分析源代码以发现潜在的错误、安全漏洞和代码质量问题。

概览分为系统级别概览、仓库级别的概览。系统概览展示最近访问的仓库以及所有仓库提交、成员的提交、以及待办信息，仓库级别概览展示该仓库的最近的提交、提交数量、该仓库的待办事项。

可以详细的记录仓库代码提交信息以及提交的代码，能够明确的知道每次提交代码相对于上次提交的修改、添加、删除。

标签用于标记特定的版本或发布，帮助团队在更新和部署时保持一致。

通过使用 Git LFS，开发者能够更加高效地管理大文件，提升团队协作的流畅性与效率。

节省存储空间、提高系统性能、简化备份和恢复、维护数据整洁。

统计仓库代码的提交次数、代码提交频率。

GitPuk优势分为安全可靠、系统集成、简洁易用、支持多版本多终端、开源免费。

GitPuk在安全可靠通过下面多个角度体现出来

分为备份与恢复，支持定时备份、手动备份。防止数据误删，数据丢失。

识别代码中的安全隐患，提前发现和修复问题，减少后期维护的成本和时间。

包含系统权限控制、仓库权限控制，且支持自定义权限。

实时记录操作变动，追溯到那个人，什么时间操作了什么。

体系完善灵活，可单独使用，也可配置统一登录，使用soular账号中心，灵活的搭配使用Tiklb中的其他应用。

集成导入gitee、gitlab、github、bitbucket第三方应用仓库。

界面简洁，可直接使用，支持一键式部署安装。

内置多个主题色，可灵活切换，界面干净、结构清晰。

线下版本支持一键安装启动，内嵌数据库、插件、运行环境，公有云部署版本注册即可使用。

支持线上公有云版本与线下私有部署版本

GitPuk是免费开源，代码公开透明、灵活

关于GitPuk

1.GitPuk社区版需要升级企业版，首先先需要确定当前版本，在

，可以找到当前的版本类型，点击“企业版特性”可以浏览到社区版和企业版功能对比。

2.如需要升级企业版，点击右侧订阅按钮。

3.点击订阅按钮，页面打开官网，用户需要经过登录后，进入订阅管理，选GitPuk点击订阅。

4.支付完成后，在已订阅会显示订阅的产品，点击订阅的产品右侧的“licence”。

5.在弹出的窗口填入GitPuk服务器的MAC地址，即可升级企业版。

6.订阅成功后，在订阅管理可以查看已购产品订阅的版本、订阅人数、订阅有效期，已订阅的产品进行续订和扩容。

：延续当前订阅人数，增加订阅产品的有效期。

：在当前有效期之内，增加使用产品的用户数量。

社区版和企业版的区别

加入我们的技术交流群，参与互动交流，提升自我。

联系我们

产品介绍

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

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

修改文件中的DATA_HOME的值，重新启动即可

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

分为统一登录、本地登录。使用统一登录，必须要安装eas项目。即统一使用Eas的用户，部门等，这样配置可以让一个用户同时使用多个应用

GitPuk支持用户使用脚本一键升级，只需要执行应用升级脚本即可

注意：更新版本的时候需要先停止应用

GitPuk安装默认为免费版，要使用企业版功能需要再官网试用或者订阅购买Licence。

GitPuk支持用户试用一个月功能，用户可选择试用，直接使用企业版功能。

->点击左上角头像进入个人中心 -> 点击订阅进入订阅管理界面 -> 选择GitPuk --> 点击企业版试用->试用成功后下载licences

进入版本与许可证界面 ->点击导入licences，升级为社区版

Linux安装

下载后点击打开下载包——>将tiklab-gitpuk拉入应用程序

打开访达 ——>点击应用程序 ——>鼠标右击thoughtware-hadess，选择显示包内容——>修改conf文件夹下application.yaml文件可自定义配置

支持统一登录、本地登录。使用统一登录，必须要安装eas项目，即统一使用Eas的用户，部门等，这样配置可以让一个用户同时使用多个应用

Mac安装

打开安装后的包文件，点击tiklab-gitpuk.exe文件启动项目

打开安装后的包文件，编辑conf文件夹下的application.yal文件即可自定义配置

支持本地登录、统一登录。使用统一登录，必须要安装eas项目，即统一使用Eas的用户，部门等，这样配置可以让一个用户同时使用多个应用

Windows安装

下载完成后得到GitPuk的.tar.gz的文件，在执行以下命令加载镜像

加载完成后，执行以下镜像启动即可

Docker安装

安装指南

首页包含常用仓库、代码统计、合并统计、待办事项

     按最新打开的仓库排序，点击仓库table进入仓库代码界面

     时间段内，提交次数最多的5个仓库、提交次数最多的用户 统计

     时间段内，合并次数最多的5个仓库、合并次数最多的用户 统计