centos8环境下部署yapi v1.9.2版本

参考文档

参考文档与yapi介绍： 内网部署 (hellosean1025.github.io)

环境

部署环境：

os: centos8
node: v12.18.3
npm:6.14.6

安装目录

/data
├── mongo   ： mongodb目录，docker-componse.yml文件所在目录
│   ├── data  ： mongodb数据目录
│   └── docker-compose.yml
└── yapi
    ├── config.json : 初始化数据库配置文件
    ├── vendors： 部署编译目录
    └── yapi-vendor-1.9.2.tgz

部署步骤

1. 安装mongodb，版本4.4（略过）,参考docker-compose.yml

version: '3.5'
services:
  mongo:
    container_name: mongo-yapi
    image: mongo:4.4
    environment:
      # 默认启动mongo后在admin中添加mongo用户，拥有最高权限
      MONGO_INITDB_ROOT_USERNAME: mongo
      MONGO_INITDB_ROOT_PASSWORD: mongo
    volumes: 
      - /etc/localtime:/etc/localtime
      - /etc/timezone:/etc/timezone
      - /data/yapi/mongo/data:/data/db
    network_mode: host

2. 下载部署包，修改配置

cd /data/yapi
mkdir yapi
cd yapi
wget http://registry.npm.taobao.org/yapi-vendor/download/yapi-vendor-1.9.2.tgz
tar -zxvf yapi-vendor-1.9.2.tgz
mv package vendors
cd vendors

# 拷贝文件到上级目录
cp config_example.json ../config.json

# 编辑文件, 修改内容
vim ../config.json

 config.json内容如下（写了注释，复制贴到文件中可能需要删掉）

{
  "port": "3000",
  "adminAccount": "admin@admin.com",
  "timeout":120000,
  "db": {
    // 数据库地址
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    // mongodb中配置的初始化的用户
    "user": "mongo",
    "pass": "mongo",
    "authSource": "admin"
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

3. 安装依赖

npm install --production --registry https://registry.npm.taobao.org --unsafe-perm

# 这一步必须要
npm install mongoose@5.9.10 --unsafe-perm


npm run install-server

安装成功：

[root@node0 vendors]# npm run install-server

> yapi-vendor@1.9.2 install-server /data/yapi/yapi/vendors
>  node server/install.js

log: mongodb load success...
初始化管理员账号成功,账号名："admin@admin.com"，密码："ymfe.org"

4. 启动服务：

node server/app.js

看到日志表示成功：

[root@node0 vendors]# node server/app.js 
log: -------------------------------------swaggerSyncUtils constructor-----------------------------------------------
log: 服务已启动，请打开下面链接访问: 
http://127.0.0.1:3000/
log: mongodb load success...

5.访问地址测试是否已部署成功(这里IP是我局域网IP)：http://192.168.2.10:3000

初始账号名：admin@admin.com，密码：ymfe.org

登录成功！

异常情况处理

npm install --production --registry https://registry.npm.taobao.org 出现异常：

> dtrace-provider@0.8.8 install /data/yapi/yapi/vendors/node_modules/dtrace-provider
> node-gyp rebuild || node suppress-error.js

gyp ERR! configure error 
gyp ERR! stack Error: EACCES: permission denied, mkdir '/data/yapi/yapi/vendors/node_modules/dtrace-provider/build'
gyp ERR! System Linux 4.18.0-305.el8.x86_64
gyp ERR! command "/usr/local/node-v12.18.3-linux-x64/bin/node" "/usr/local/node-v12.18.3-linux-x64/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
gyp ERR! cwd /data/yapi/yapi/vendors/node_modules/dtrace-provider
gyp ERR! node -v v12.18.3
gyp ERR! node-gyp -v v5.1.0
gyp ERR! not ok 

> core-js@2.6.12 postinstall /data/yapi/yapi/vendors/node_modules/core-js
> node -e "try{require('./postinstall')}catch(e){}"

解决： npm install增加 --unsafe-perm 参数

npm run install-server 出现异常：

> yapi-vendor@1.9.2 install-server /data/yapi/yapi/vendors
>  node server/install.js

/data/yapi/yapi/vendors/server/utils/commons.js:25
jsf.extend('mock', function () {
    ^

TypeError: jsf.extend is not a function
    at Object.<anonymous> (/data/yapi/yapi/vendors/server/utils/commons.js:25:5)
    at Module._compile (internal/modules/cjs/loader.js:1137:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)
    at Module.load (internal/modules/cjs/loader.js:985:32)
    at Function.Module._load (internal/modules/cjs/loader.js:878:14)
    at Module.require (internal/modules/cjs/loader.js:1025:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (/data/yapi/yapi/vendors/server/install.js:3:17)
    at Module._compile (internal/modules/cjs/loader.js:1137:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)
    at Module.load (internal/modules/cjs/loader.js:985:32)
    at Function.Module._load (internal/modules/cjs/loader.js:878:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)
    at internal/main/run_main_module.js:17:47
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! yapi-vendor@1.9.2 install-server: ` node server/install.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the yapi-vendor@1.9.2 install-server script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2021-07-05T09_42_09_710Z-debug.log

解决： 安装指定版本的 json-schema-faker@0.5.0-rc16，参考上面部署步骤

npm install json-schema-faker@0.5.0-rc16 --unsafe-perm