Arbess 是一款开源免费的 CI/CD 工具，今天我们将为大家讲解如何快速安装和配置 Arbess，助力你迅速启动自动化构建、测试与发布流程。无论是新手还是资深开发者，Arbess 的简洁安装流程和强大功能都将带你迈向高效开发之路！

安装 Arbess 非常简单，只需几步，你就可以在本地或服务器上运行 Arbess。

下载Windows exe安装包  https://download.tiklab.net/arbess

下载完成后会得到 tiklab-arbess-1.0.2.exe格式类似的可执行文件

选择安装位置，默认安装在 C:\Program Files (X86) 下，点击完成即可安装成功。 

安装完成后点击桌面Arbess图标即可启动。

启动完成后，这样你就可以通过 

 访问 Arbess 界面了，并且Abess支持多种登录类型，本地登录与统一登录。

初始化账号为：admin ,密码为：123456，

使用本地的账号体系登录，支持账号密码，企业微信，钉钉，Ladp 等方式登录。

使用统一的账号体系来登录应用，需要安装 soular （账号与门户中心）支持，安装后可以使用一个账号访问多个应用。

配置统一登录需要更改 Arbess 配置文件配置，具体配置如下：

Arbess支持用户自定义，数据库，备份，统一登录等配置，用户可以根据自己的需求来更改，只需要编辑默认文件

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

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

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

  url: jdbc:postgresql://localhost:5432/arbess_ee?stringtype=unspecified

可以自定义配置备份的时间，以及备份文件存储路径。

统一登录可以使TikLab下的多个应用使用同一用户登录。

可以安装多个Agent来连接一个配置端，做到一个配置端，多个执行端，分布式部署。

如果在安装过程中遇到了问题，Arbess提供了丰富的文档和教程，帮助用户轻松解决问题。前往 Arbess文档中心，获得详细的配置说明和常见问题解答，同时也可以随时向活跃的社区

https://doc.tiklab.net/document/322b16350ed8

Arbess入门指南(1.1) - Windows环境下安装配置

        在数字经济时代，企业数字化转型已不再是选择题，而是必答题。然而，对于许多企业，尤其是中小企业而言，数字化转型之路并非坦途，面临着技术、资金、人才等多重挑战。

"星光计划"助力初创、中小企业开启高效研发之旅

针对 IntelliJ IDEA 环境推出 PostIn 插件，版本号1.0.1， PostIn 插件是一个针对 IntelliJ IDEA 环境的工具，集成到 IDEA 侧面板中，便于快速访问，帮助开发人员高效地管理API定义。插件可自动生成 API 文档并一键同步到 PostIn 的项目中。

一键智能解析：在IDEA中扫描JAVA代码，通过添加的注释自动识别接口路径、参数、返回值，无需手动整理！

全格式文档生成：秒级导出API标准文档，无缝对接PostIn平台！

动态同步更新：代码改动后，文档实时同步更新，杜绝“代码更新、文档滞后”产生的一系列问题！

自定义模板：支持团队统一配置文档样式、字段注释规范，让协作更专业！

省时省力：3秒生成100个接口文档，避免手工复制粘贴占用开发时间！

简单易用：无需配置复杂环境，安装即用，操作简单！

零误差：代码即文档，逻辑与描述100%一致，避免人为错误！

高效协作：代码与文档实时同步，解决了文档滞后代码、沟通成本高等一系列问题！

本节将详细介绍 PostIn 插件下载、安装。

方式1：在 IntelliJ IDEA 中安装 PostIn 插件。打开 IDEA 设置，进入 Plugins（插件）页面，搜索 “PostIn” 并安装 “PostIn” 插件。

方式2：在 Jetbrains Marketplace 中下载后通过本地安装

，打开 IDEA 设置，进入 Plugins（插件）页面，点击Installed右侧的设置按钮，选择"install plugin from disk... "，从磁盘安装插件。

插件仅支持 IntelliJ IDEA 2024.1.7 版本。

安装结束后，在idea右侧侧边栏显示PostIn。

本节将详细介绍 PostIn 插件配置。

进入插件后，显示扫描接口， 上报接口，设置三个按钮。

配置PostIn插件，点击“设置”按钮，进入PostIn插件的配置。

需要配置PostIn服务的URL（注意配置的URL尾部不需要带"/"），以及上报接口的所属空间ID，上报接口的所属空间ID可以在PostIn空间详情。

至此，PostIn上报接口的IDEA插件已全部下载、安装、配置结束。

本节将详细介绍怎么使用PostIn插件上报接口，生成详细的接口文档。

首先需要在接口文件controller 中添加注释，包含接口协议、导入接口文件夹名称、接口地址。

● @pi.protocol：定义了接口的协议。

● @pi.groupName：定义了接口的文件夹名称。

● @pi.path：定义了该接口的基本 URL 路径。

其次，需要在接口前添加接口详细信息的注释，包含接口名称、接口详细URL、请求方式、请求类型、请求参数。通过请求类型的不同，可以分为两种。

 * @pi.param: model=io.tiklab.postin.workspace.model.WorkspaceFollow

● @pi.name：定义了接口的名称。

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/createWorkspaceFollow

● @pi.methodType：定义了接口请求方式。

● @pi.request-type：定义了接口请求类型。

 * @pi.param: name=id;dataType=string;value=workspaceId;desc=当前删除的id

 * @pi.param: name=id2;dataType=string;value=workspaceId2;desc=当前删除的id2

● @pi.url：和@pi.path共同组成了接口的完整路径，举例接口的完整路径：/workspaceFollow/deleteWorkspaceFollow

注释添加完成后，在PostIn插件点击“扫描接口”按钮，扫描当前项目所有接口。

扫描出接口后，用户可单选、多选或全选接口后提交上报。例如，接口总共有7个，按Ctrl选择其中3个，点击“上传接口”按钮，系统弹出”确认上传接口“二次确认弹窗。

点击“是”，选择的接口上传到PostIn系统。

当接口进行更新之后，还可以利用PostIn插件对接口进行更新。

接口成功上传PostIn后，对接口信息进行修改，只要接口路径（即@pi.path和@pi.url组成的路径）未进行修改，再次上传接口，会对当前接口进行更新。

接口路径（即@pi.path和@pi.url组成的路径）修改之后，再次上传接口，接口会按照新接口进行添加。

上报成功之后，可以在PostIn和 IntelliJ IDEA 环境信息对比。

下图为请求为字段，上报PostIn前后信息对比。

请检查配置的PostIn服务器URL是否正确，注意地址尾部不需要带"/"

PostIn V1.0.8版本发布，IDEA 插件支持一键扫描上报，让接口定义不再繁琐

系统全面支持各种附件的上传，上传后文件可以再次下载到本地，对部分文件支持在线预览

（1）登录系统后，选择您想要存储文件的知识库，并进入该知识库的文档页面，点击添加按钮即可找到上传本地文件链接。

找到”上传本地文件“的链接并点击

（2）点击链接后，会弹出选择本地文件的窗口，找到您想要上传的文件后，双击或者选中文件后点击打开按钮，文件自动上传到系统并展示在知识库左侧。

（3）您还可以按照自己的习惯新建目录，并将文件移动至特定目录，便于进一步整理和分类文件。

（4）上传后的文件可以继续下载到本地或分享给他人。

对于未解析文件，系统提供存储和下载

sward V1.0.8版本发布，全面支持各种附件上传预览

 GitPuk是一款国产开源免费的代码管理工具，工具简洁易用，开源免费，本周GitPuk发布v1.1.1版本，新增JavaScript语言扫描、支持mysql数据库类型、添加ububtu包、代码推送规则设置、集成arbess的Cl/CD功能。

优化了仓库角色，优化了系统角色

2.点击仓库左下角的设置，打开仓库配置后点击推送设置

3.点击新建推送规则，输入对应的内容点击确定即可

2.进入后，点击左侧的Cl/CD后，打开关联流水线

3.打开后系统会跳转至系统集成，点击添加地址输入对应的内容，点击确定即可

GitPuk V1.1.1版本发布，集成arbess CI/CD功能

​Arbess 是一款国产开源免费的 CI/CD 工具，包含流水线管理、流水线设计、流水线执行、测试报告、统计分析等模块，支持丰富多样的任务类型，界面操作简洁明了、开源免费。本周Arbess V1.1.4 版本发布，支持Mysql数据库，Ubuntu系统，增加SSH及Hadess上传下载任务。

流水线新增SSH上传、SSH下载任务。

流水线新增Hadess上传、Hadess下载任务。

优化任务主机部署的配置与部署策略。

优化部署长时间一直运行问题。

优化任务Kubernetes的配置与执行逻辑。

新增支持Mysql数据库，安装完毕之后，根据自己安装的系统找到配置文件application.yaml，不同系统yaml文件默认位置：


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

使用MySQL数据库，需要将数据库连接信息修改为如下连接。

jdbc:
  driverClassName: com.mysql.cj.jdbc.Driver
  url: jdbc:mysql://localhost:3306/tiklab_arbess?characterEncoding=utf8&useSSL=false
  username: root
  password: darth2020

 其中数据库名需要提前在MySQL创建空的数据库，启动系统服务，系统会自动初始化数据。

支持Ubuntu系统安装，进入TikLab官网下载Ubuntu系统安装包。

下载，Ubuntu安装包下载地址，下载安装包，如 tiklab-arbess-*.*.*.deb 安装包。

安装，上传到服务器，使用 dpkg 命令安装。

启动，进入/opt/tiklab-arbess/bin目录下，执行sh startup.sh即可启动成功。

流水线新增SSH上传、下载功能，构建完成后上传指定目录，或者下载指定文件进行部署。

例如需要配置流水线，克隆代码、构建后将安装包上传至服务器，首先添加源码，这边添加GitPuk源码。

添加构建任务，以Maven构建为例，点击新阶段→构建→Maven构建。

其中模块地址输入${DEFAULT_CODE_ADDRESS}，即克隆源码地址，也可以输入绝对路径进行构建。
添加SSH上传任务，点击新阶段→工具→SSH上传。

添加上传SSH服务器地址、上传位置、文件，下图设置在构建位置用文件匹配规则上传文件。

设置完成之后点击右上角运行，运行流水线。

运行过程中，或者运行成功之后，都可以查看具体运行日志。

SSH上传成功之后，在目标服务器设置路径下，可以找到相应构建的安装包。

例如通过SSH下载安装包文件到客户端，流水线部署到客户端。首先添加SSH下载，点击新阶段→工具→SSH下载。

设置将服务器上/home/chen/tiklab.tar.gz文件，下载到192.168.10.211客户端的/opt下。

下载成功之后在客户端对安装包进行部署。点击新阶段→部署→主机部署。

这边部署文件可以使用绝对路径，也可以使用模糊路径+部署文件匹配规则进行定位。
流水线任务添加成功之后，点击右上角运行，运行流水线。

流水线新增Hadess上传、下载功能，构建完成后上传Hadess制品库，或者下载指定文件进行部署。

例如需要配置流水线，克隆代码、构建后将安装包上传Hadess制品库，首先添加源码，这边添加GitPuk源码。

其中模块地址输入${DEFAULT_CODE_ADDRESS}，即克隆源码地址，也可以输入绝对路径进行构建。
添加Hadess上传任务，点击新阶段→工具→Hadess上传。

其中Hadess服务需要登录Hadess查看，登录后点击制品库，找到上传制品库的地址。

Hadess上传成功之后，在登录Hadess找到对应制品库，可以找到相应的制品。

例如下载Hadess制品库的安装包文件到服务器，流水线部署到服务器。首先添加Hadess下载，点击新阶段→工具→Hadess下载。

设置将Hadess制品库文件，下载到服务器的/opt下。

下载成功之后在服务器对安装包进行部署。点击新阶段→部署→主机部署。

Arbess V1.1.4版本发布，支持Mysql数据库，Ubuntu系统，新增SSH及Hadess上传下载任务

Hadess是一款国产开源免费的制品管理工具，包含制品库管理、制品搜索、制品扫描等模块。本周Hadess发布V1.1.1版本，新增pypi、composer制品类型及允许批量删除版本。

优化了制品详情的弹窗，修复了删除制品最后一个版本，制品列表刷新问题

1.点击新建制品库，在选择自己要创建的类型后点击pypi输入名称后点击确定。

2.进入你刚刚创建的pypi制品库，点击操作指南根据操作指南上面的步骤即可。

1.点击新建制品库，在选择自己要创建的类型后点击composer输入名称后点击确定。

2.进入你刚刚创建的composer制品库，点击操作指南根据操作指南上面的步骤即可。

1.点击你创建的制品库，点击制品，在制品中选择版本。

2.点击右上角的打开批量操作，选中你要删除的版本，点击批量删除即可。