sourcefare支持代码安全漏洞、编码缺陷和合规性问题扫描，以及代码重复率、复杂度、覆盖率扫描，支持常见的Java、JavaScript、Go、Python、C++等语言。sourcefare支持配置代码扫描方案配置，以及质量门禁配置。

sourcefare内置多种扫描规则，根据语言内置代码扫描方案。

点击响应的扫描规则集，可查看详细的扫描规则。

代码扫描方式可以自定义设置，进入系统设置→扫描方案，进行自定义添加。

点击添加方案，可以自定义选择扫描规则。

自定义扫描规则创建完毕后，在新建项目可选择自定义的扫描规则。

在项目中可设置代码质量门禁，超过设定的门禁表示代码扫描不通过。也可以关闭门禁，关闭门禁问题数量不影响代码扫描结果。

门禁设置完成后，点击扫描按钮执行扫描。扫描的问题超过设置的门禁，扫描不通过。

扫描的问题未超过设置的门禁，扫描通过。

扫描配置

本文将介绍如何创建项目，并上传代码压缩包并进行代码扫描。

安装启动完毕后，默认可以通过 http://ip:8900 访问，默认用户名/密码为admin/123456。
默认支持通过账号密码登录，满足基础登录需求。若需要使用企业微信、钉钉或 LDAP 等高级登录方式，可参阅sourcefare文档获取相关配置说明。​

进入系统后，可根据不同需求来创建不同的项目。sourcefare支持服务器扫描和客户端扫描，服务器扫描分为代码压缩包上传扫描和Git代码仓库扫描，客户端扫描提供给CICD工具Arbess集成扫描。


在项目页面点击新建项目，配置项目的基本信息，如名称，项目权限，成员等。​﻿

流水线信息输入完毕之后，点击下一步配置扫描，扫描方式选择服务器扫描（包上传），扫描方案安装代码选择相应的扫描方案、扫描环境、以及是否进行覆盖测试。

项目创建成功之后，需要对访问项目的成员进行管理。首先添加系统用户，依次点击系统设置->用户与权限->用户，在用户页面对系统用户进行管理。​

系统用户添加完成之后，可以对项目成员进行添加，在项目详情→设置→成员，进入成员编辑页面。

如果用户在创建项目未选成员，那么流水线默认有创建人和admin两个成员。点击添加用户，添加的成员列表从系统用户列表获取。点击添加用户，勾选添加用户，点击确定即可成功添加流水线成员。

添加项目成员后，可以对成员分配权限、修改角色，点击流水线详情→设置→权限，可浏览到内置角色，也可以对角色进行新增。

在流水线详情→设置→成员，点击“角色修改”，对成员角色进行修改。成员角色可多选。

例如创建Java代码扫描，选择如下信息，完成创建。

完成创建后，进入项目详情，在扫描报告页面，上传代码压缩包。

成功上传代码包后，扫描报告页面显示为扫描记录列表，点击扫描按钮执行扫描。

扫描完成后，点击报告编号即可查看详细代码扫描报告。


代码包上传扫描

本文将介绍如何创建项目，使用Git方式进行代码扫描。

​流水线信息输入完毕之后，点击下一步配置扫描，扫描方式选择服务器扫描（Git），服务器扫描（Git）方式支持GitPuk代码仓库，需要提前在系统设置→集成开放进行维护。

点击添加仓库服务，输入GitPuk服务地址以及用户名密码进行添加。配置服务集成后，选择扫描方案、扫描环境、以及是否进行覆盖测试。

完成创建后，进入项目详情，在扫描报告页面，点击右上角扫描按钮进行代码扫描。

Git方式代码扫描

扫描完成后在扫描报告页面显示代码扫描历史列表。

点击相应代码扫描编号，查看详细报告。代码扫描报告首页展示报告概览，通过扫描出的问题和设置的阈值展示代码扫描结果。

点击问题TAB显示当次扫描历史出的所有问题列表。点击问题编号可查看详细问题描述。

在问题列表点击问题的描述信息，可浏览详细问题描述。以及对问题进行处理。

在度量TAB可显示当前代码扫描历史的重复率、复杂度、覆盖率等报告。

在代码tab可查看扫描问题所在代码的路径。

扫描报告

快速入门

sourcefare

sourcefare - 文档

1.sourcefare社区版需要升级企业版，首先先需要确定当前版本，在设置→系统→版本与许可证，可以找到当前的版本类型，点击“企业版特性”可以浏览到社区版和企业版功能对比。

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

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

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

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

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

社区版和企业版的区别

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

联系我们

​在我们的日常研发过程中，为了持续检测和改进软件代码质量，会使用一些静态代码扫描工具。今天给大家推荐一款国产开源免费、简洁易用的静态代码扫描工具-sourcefare。

sourcefare支持代码安全漏洞、编码缺陷和合规性问题扫描，以及代码重复率、复杂度、覆盖率扫描，支持常见的Java、JavaScript、Go、Python、C++等语言，界面操作简洁明了、开源免费。

支持Java、JavaScript、Go、Python、C++等主流语言代码扫描。

支持服务器扫描（Git方式、代码压缩包上传方式）和客户端扫描（提供给CICD触发代码扫描，例如Arbess）。

私有部署支持一键安装，安装后即刻可用，无需额外配置。

直观的界面设计，结构清晰，让用户可以快速找到所需的功能模块。

免费开放源代码，支持社区协作和共享，推动项目不断发展和优化。

以下以linux Ubuntu安装为例，其它环境安装方式见官网文档。

启动后，通过 http://ip:8900 访问，默认使用admin/123456登录。系统默认支持本地账号登录，满足基础登录需求。若需要使用企业微信、钉钉或 LDAP 等高级登录方式，可参阅sourcefare文档获取相关配置说明。​

有兴趣的开发者朋友可以去Tiklab官网体验演示DEMO或下载安装使用，使用过程当中有什么好的建议或意见也欢迎加入社区-技术交流群反馈：）
体验地址：https://demo.tiklab.net/sourcefare
下载地址：https://download.tiklab.net/sourcefare


关于sourcefare

产品介绍

启动完成后，这样你就可以通过 http://localhost:8900 访问 

界面了，初始化账号为：admin ,密码为：123456，首次登录需要更改密码。

支持用户自定义，数据库，备份，统一登录等配置，用户可以根据自己的需求来更改，只需要编辑默认文件application.yaml即可。配置文件位置：默认在/opt/tiklab-sourcefare/conf 目录下。

Arbess同时支持用户使用外部数据库以及内嵌数据库。

外部数据库：用户自己定义链接数据库的地址，用户名，密码等。

内嵌数据库：使用系统内置的数据库。

支持用户自定义数据的保存位置。

dcs 是缓存配置，只能修改端口。

统一登录，即统一使用soular的用户，部门等，这样配置可以让一个用户同时使用多个应用。

程序安装结束后，可以在系统执行如下。

使用 sourcefarectl -v 或者 sourcefarectl version 查看当前安装版本。

Linux 安装配置

Docker镜像启动完毕之后，如需要将Docker镜像中的数据目录挂载到主机，需要执行如下命令

挂载完毕后，启动系统，系统会读取设置的主机数据目录和配置文件。

启动完成后，这样你就可以通过 http://localhost:8900 访问 sourcefare 界面了，初始化账号为：admin ,密码为：123456，首次登录需要更改密码。

允许自定义端口、数据存放目录、数据库连接、数据库备份策略和统一登录设置，以满足特定个性化需求。yaml文件默认位置：

允许用户自定义应用的启动端口，以便在特定网络环境下避免端口冲突或满足其他配置需求。

支持自定义数据库连接方式，用户可以选择使用内嵌数据库或指定外部数据库地址。根据需求配置数据库连接。

支持用户自定义数据存放目录的位置，帮助用户根据需要选择存储路径。

统一登录，即统一使用Soular的用户，部门等，这样配置可以让一个用户同时使用多个应用。需要安装Soular，具体安装详见Soular文档。

Docker 安装配置

启动完成后，这样你就可以通过 http://localhost:8900 访问 SourceFare 界面了，初始化账号为：admin ,密码为：123456，首次登录需要更改密码。

Windows 安装配置

MacOS 安装配置

安装配置

首页包含常用仓库、项目扫描统计、最新动态

首页

添加项目

编辑项目

查询项目

删除项目

项目

服务端执行

客户端执行

查看扫描配置

修改扫描配置

添加扫描方案

添加扫描环境

查看规则集

备份与恢复

操作日志

其他功能

使用指南

最佳实践

常见问题

v1.1.0更新日志

v1.1.5更新日志

更新日志

下载，进入官网→演示与下载→下载，下载地址：

安装，下载完成后，点击打开下载包，将tiklab-sourcefare拉入应用程序。

启动，安装完成后，点击启动sourcefare图标即可启动。

成功登录后，显示sourcefare首页。