Sign inSign up

sunhaojava/yapi

By sunhaojava

Updated about 6 years ago

yapi

Image
0

379

sunhaojava/yapi repository overview

Docker for YApi

一键部署YApi

⚠️注意

⚠️注意:本仓库目前只支持安装,暂不支持升级,请知晓。如需升级请备份mongoDB内的数据。

使用

默认密码是:ymfe.org,安装成功后进入后台修改

可修改变量

环境变量默认值描述是否必填
HOME/homeyapi部署在容器中的目录
PORT3000yapi在容器内的端口
ADMIN_EMAIL[email protected]默认管理员账号
NOTIFY_UPGRADEtrue开启版本通知功能
DISABLE_REGISTERfalse禁止用户注册 yapi 平台
DB_HOST-MongoDB地址 (*) 是
DB_NAME-使用的数据库名称 (*) 是
DB_PORT-MongoDB端口 (*) 是
DB_USER-MongoDB用户名 (*) 是
DB_PWD-MongoDB密码 (*) 是
MAIL_ENABLEfalse是否启用邮箱
MAIL_HOST-邮箱smtp地址
MAIL_PORT-邮箱smtp端口
MAIL_FROM-发件人
MAIL_USER-发件人账号
MAIL_PWD-发件人账号密码

docker-compose 部署

docker-compose.yml

version: '2.1'
services:
  yapi:
    image: sunhaojava/yapi:1.9.2
    container_name: yapi
    restart: always
    volumes:
      - ./yapi.log:/home/vendors/log
    env_file:
      - .env
    ports:
      - "xxxx:3000"

.env

# yapi的工作目录
HOME=/home
# yapi端口
PORT=3000
# 初始账号
[email protected]
# 版本通知
NOTIFY_UPGRADE=true
# 禁止注册
DISABLE_REGISTER=true
# 数据库host
DB_HOST=xxxxx
# 数据库名
DB_NAME=yapi
# 数据库端口
DB_PORT=00000
# 数据库用户名
DB_USER=yapi
# 数据库密码
DB_PWD=yapi
# 是否启用邮箱
MAIL_ENABLE=true
# 邮箱smtp地址
MAIL_HOST=xxxxxx
# 邮箱smtp端口
MAIL_PORT=25
# 发件人
[email protected]
# 发件人账号
[email protected]
# 发件人密码
MAIL_PWD=xxxxxx

启动方法

  1. 启动服务:docker-compose up -d

如何构建镜像

  1. ./build.sh 1.9.2
  2. 后面的参数是YAPI的版本号

如何找到该镜像

  1. 我发布在docker-hub上
  2. 地址sunhaojava/yapi
  3. get it via docker pull sunhaojava/yapi

其他

📧联系@sunhao.java

✨欢迎 Star && Fork

Tag summary

Content type

Image

Digest

Size

619.6 MB

Last updated

about 6 years ago

docker pull sunhaojava/yapi