PostIn简明安装教程(入门级)

PostIn是一款开源免费的接口管理工具，包含接口调试、接口文档设计、数据MOCK等模块，本文将介绍如何快速安装配置，以快速入门上手。

1、服务端安装

私有部署版本支持多种操作系统，包括 Linux、Docker、Windows及macOS，方便团队根据自身环境灵活选择安装方式。

1.1 Linux 安装

下载，Linux 安装包下载地址：下载Linux安装包，下载安装包如tiklab-postin-x.x.x.rpm
安装，上传到服务器，使用 rpm 命令安装，默认安装目录在/opt下

rpm -ivh --nodeps tiklab-postin-x.x.x-1.x86_64.rpm

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

1.2 Docker 安装

Docker安装包下载地址：下载Docker安装包。

下载完成后，得到 tiklab-postin-x.x.x.tar.gz 的文件

在执行以下命令加载镜像

docker load -i tiklab-postin-x.x.x.tar.gz

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

docker run -itd -p 9300:9300 tiklab-postin-x.x.x

1.3 Windows 安装

Windows安装包下载地址：下载Windows安装包。

下载完成后，获取名为 tiklab-postin-.x.x.x.exe 的可执行文件。

双击运行可执行文件，选择安装位置并点击安装。

安装完成后，点击桌面快捷方式启动 PostIn 服务。

1.4 macOS 安装

Mac安装包下载地址：下载Mac安装包

下载完成后，获取名为 tiklab-postin-.x.x.x.dmg 的可执行文件。

双击打开 .dmg 文件，将 Postin 拖入应用程序文件夹。

安装完成后，点击应用程序文件夹中的 PostIn 快捷方式启动服务。

2、桌面端安装

Postin桌面端支持Windows、macOS 。

2.1 Windows 安装

Windows安装包下载地址：下载Windows桌面端。

下载完成后，获取名为 tiklab-postin-client-x.x.x.exe 的可执行文件。

双击运行可执行文件，选择安装位置并点击安装。

安装完成后，点击桌面快捷方式启动 PostIn 。

2.2 macOS 安装

Mac安装包下载地址：下载Mac桌面端

下载完成后，获取名为 tiklab-postin-client-x.x.x.dmg 的可执行文件。

双击打开 .dmg 文件，将 PostIn 拖入应用程序文件夹。

安装完成后，点击应用程序文件夹中的 PostIn 快捷方式启动桌面端。

3、登录

启动后，默认可以通过 http://localhost:9300 访问。若在局域网内，您也可以使用启动设备的 IP 地址加端口号（如 192.168.1.100:9300）进行访问。

3.1 默认账号

默认支持通过账号密码登录，满足基础登录需求。若需要使用企业微信、钉钉或 LDAP 等高级登录方式，可参阅 PostIn 文档获取相关配置说明。

用户名：admin 密码：123456

首页：

4、配置

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

yaml文件默认位置：

系统	默认位置
Windows	默认在安装目录 --> conf目录下
Mac	默认在app下的Contents --> conf 目录下
Linux	默认在/opt/tiklab/postin/conf 目录下
Docker	默认在镜像文件内/usr/local/apps/postin/conf 目录下

4.1 启动端口

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

属性	值
server.port	系统启动的端口号（可更改）

4.2 数据存储

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

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

4.3 数据库

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

属性	值
postgresql.embbed.enable	是否使用内嵌数据库，true:使用 false:不使用。如果配置为false，需要把该文件中jdbc下的数据库连接信息更改为自己的数据库地址，用户名以及密码。
postgresql.database	是否使用内嵌数据库默认连接的数据库，默认为postin_db如果更改次默认值需要把jdbc下的数据库连接信息更改为新的数据地址。
postgresql.db.port	使用内嵌数据库的启动端口，默认为9201，如果更改需要同时把jdbc.url中的数据库连接地址端口更改。
postgresql.db.username	使用内嵌数据库的用户名，默认为postgres，如果更改需要同时把jdbc.username中的数据库连接地址用户名更改。
postgresql.db.password	使用内嵌数据库的密码，默认为darth2020，如果更改需要同时把jdbc.password中的数据库连接地址密码更改。
postgresql.db.address	使用内嵌数据库的数据库文件保存位置，默认为${DATA_HOME}/postgresql，即默认的应用数据目录下的postgresql目录。注：如果更改该目录，该路径目录必须为空目录，否则会导致数据库无法启动。
jdbc.url	默认是：jdbc:postgresql://localhost:9301/postin_db?stringtype=unspecified 其中 9301 为端口号，postin_db为数据库名字，这两个可更改但是端口号必须与postgresql.db.port 保持一致数据库名字必须与postgresql.database 保持一致
jdbc.username	数据库登录名，必须与postgresql.db.username一致
jdbc.password	数据库登录密码，必须与postgresql.db.password一致

4.4 统一登录

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

属性	说明
soular.embbed.enable	是否为统一登录，true: 本地模式 false：统一模式
soular.address	Soular的应用地址，统一模式必填

4.5 自定义配置示例

支持多种自定义配置选项，以下是一些常见的配置示例：

#linux配置示例


#应用数据存放地址

DATA_HOME: /opt/postin-ee



#端口号

server:

     port: 9300
 


#配置数据库

jdbc:

   driverClassName: org.postgresql.Driver

   url: jdbc:postgresql://localhost:9301/tiklab_postin_ee?stringtype=unspecified

   username: postgres

   password: darth2020
 


#是否为统一登录

soular:

    embbed:

        enable: true                        #true代表本地登录，false则表示统一登录

  # address: http://192.168.10.34:8091      #统一登录的地址
 


#自己本地的服务地址

base:

    url: http://


#是否配置内嵌数据库
postgresql:

    database: tiklab_postin_ee     #内嵌数据库名称

    embbed:

        enable: true               #是否为内嵌数据库，true表示内嵌，false表示外部

    db:                            #内嵌数据库基本配置

        port: 9301                 #内嵌数据库的端口号

        username: postgres         #账号

        password: darth2020        #密码
 
        address: ${DATA_HOME}/postgresql       #数据库存放地址
 


#备份数据

backups:

    dir: /data/postin               #备份的数据存放地址

    time: 0 0 2 * * ?               #备份时间，corn表达式格式，默认为凌晨两点。

5、更新

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

Postin的升级脚本位置：

系统	默认位置
Windows	进入默认安装目录 --> 进入bin目录 --> 执行update.bat脚本。
Mac	进入app下的Contents --> 进入bin目录 --> 执行update.sh脚本。
Linux	默认在/opt/postin-ee/bin 目录下 --> 执行update.sh脚本。
Docker	默认在镜像文件内/usr/local/postin-ee/bin 目录下 --> 执行update.sh脚本。