Yapi 部署

記錄一下部署yapi的過程 需部署系統版本信息

• 系統版本 : ubuntu 18.04 Lts
• nginx : 10.15.1
• mongoDb : 4.2.0

目錄 :

• 系統環境配置
• MongoDB
• Yapi
• pm2管理

1 系統環境配置

node 安裝

# 安裝nodejs
sudo apt update
sudo apt install nodejs
sudo apt install npm 
# 使用n來管理node版本
/**
* sudo n lts 長期支持
* sudo n stable 穩定版
* sudo n latest 最新版
* sudo n 8.4.0 直接指定版本下載
*/
sudo npm install -g n
# 升級npm
sudo npm i -g npm
複製代碼

2 MongoDb

安裝 mongoDb

** 注意：這個版本的MongoDB僅爲如下64位 LTS（長期支持）Ubuntu版本提供軟件包: **

• 16.04 LTS
• 18.04 LTS

這裏仍是使用的最簡單的作法,也就是沒有設置了驗證的mongoDb

wget -qO - https://www.mongodb.org/static/pgp/server-4.2.asc | sudo apt-key add -

# 這條語句是官網自動生成的，最好仍是去官網弄下來,這裏使用的是18.04 Lts
# 官網地址：https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.2.list

sudo apt-get update

# 這裏直接使用的是最新版
sudo apt-get install -y mongodb-org

# 特定版本請使用這句
sudo apt-get install -y mongodb-org=4.2.0 mongodb-org-server=4.2.0 mongodb-org-shell=4.2.0 mongodb-org-mongos=4.2.0 mongodb-org-tools=4.2.0

複製代碼

通常來講，安裝完成以後，mongo會直接啓動，這個時候輸入mongo應該是會進入到數據庫的
若是進不去,或者是啓動不了,輸入mongod試試,通常會有提示錯誤信息

配置 mongoDb

如下文件都是必須存在,也就是說,mongoDb並不會根據這個配置去給你自動生成文件,至少我試了不會

sudo vim /etc/mongod.conf

# mongod.conf 基本目錄
storage:
  dbPath: /var/lib/mongodb # 數據庫儲存位置
  journal:
    enabled: true
    
systemLog:
  destination: file
  logAppend: true
  path: /var/log/mongodb/mongod.log # 日誌文件位置

# network interfaces
net:
  port: 27017 # 端口號
  bindIp: 127.0.0.1 # 默認是容許 127.0.0.1訪問,若是須要其餘,設置成 0.0.0.0就能夠了

processManagement:
  timeZoneInfo: /usr/share/zoneinfo
複製代碼

3 Yapi

部署 Yapi

這裏官網有兩種部署方式,我採用的是命令行部署,具體可查閱 Yapi官方文檔

mkdir yapi
cd yapi
# 或者下載 zip 包解壓到 vendors 目錄（clone 整個倉庫大概 140+ M，能夠經過 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令減小，大概 10+ M）
git clone https://github.com/YMFE/yapi.git vendors
# 複製完成後請修改相關配置
cp vendors/config_example.json ./config.json 
cd vendors
npm install --production --registry https://registry.npm.taobao.org
# 安裝程序會初始化數據庫索引和管理員帳號，管理員帳號名可在 config.json 配置
npm run install-server
複製代碼

配置Yapi

配置文件config.json在Yapi的安裝目錄下

# config.json
{
  "port": "8082", # 啓動端口
  "adminAccount": "XXXXXXXXXX", # 管理員帳號 
  "db": {
    "servername": "127.0.0.1", # 數據庫地址
    "DATABASE": "yapi", # 數據庫名 這裏數據庫必須存在 mongoDb,否則不會自動建立,會沒法登陸
    "port": 27017, # 數據庫端口
    "user": "", # 數據庫帳號 沒有添加mongdb驗證不須要填寫
    "pass": "", # 數據庫密碼 沒有添加mongdb驗證不須要填寫
    "authSource": ""
  },
  # email 配置,這個不會就百度
  "mail": {
    "enable": true,
    "host": "smtp.qq.com",
    "port": 465,
    "from": "xxxxx@qq.com",
    "auth": {
      "user": "xxxx@qq.com",
      "pass": "mpomxafgpildbegf"
    }
  }
}

# 啓動yapi，請訪問 127.0.0.1:{config.json配置的端口}，初次運行會有個編譯的過程，請耐心等候
node server/app.js 
複製代碼

不出意外,這個時候訪問相應的地址,能夠直接進入到Yapi的首頁,這個時候就證實Yapi是安裝成功了.

4 pm2

pm2在這裏的主要做用,是用來保持yapi的啓動狀態,由於使用上面那種啓動方式,你必須開着一個窗口,關閉了,也就沒了.

安裝pm2

npm install -g pm2

# 安裝完成以後輸入 pm2 -v ,出現版本信息,就是安裝成功了
複製代碼

配置啓動項

pm2 start node (安裝目錄下)server/app.js --name='yapi'

# 啓動服務
pm2 start yapi
複製代碼

這個時候yapi應該是正常使用了