docker-YApi

在 Docker 中运行 YApi。

---

管理员账号：[email protected]

管理员密码：ymfe.org

---

• 要求
• 安装
• 如何配置
  • 通过环境变量配置（推荐）
    • 基础配置
    • 数据库配置
    • 邮件配置
    • LDAP 登录配置
    • 插件配置
• 如何重启
• 如何升级
• 查看日志
• YApi 相关资源推荐
• 许可

要求

你得确保在你的设备上安装了不是太老版本的 Docker 和 Docker Compose。

安装

首先，克隆本项目：

git clone https://github.com/wanrenzhizun/docker-yapi-cli.git

接下来，修改 docker-compose.yml 中 yapi-web 下的环境变量 ADMIN_ACCOUNT 为你的管理员邮箱,默认密码ymfe.org。

最后，执行 docker-compose up -d 启动服务。

然后，通过 http://localhost:40001 即可访问 YApi。

如何配置

通过环境变量配置（推荐）

通过环境变量配置的选项会覆盖通过 config.json 或者 config.js 配置的选项。

基础配置

环境变量名称	类型	说明	示例
ADMIN_ACCOUNT	string	管理员账号（邮箱）	[email protected]
VERSION_NOTIFY	boolean	是否打开新版本通知，默认true	[email protected]
CLOSE_REGISTER	boolean	是否关闭注册，由于 docker-YApi 已内置相关插件，你可在关闭注册后在后台手动添加用户	true

数据库配置

环境变量名称	类型	说明	示例
DB_SERVERNAME	string	MongoDB 服务地址	yapi-mongo
DB_PORT	number	MongoDB 服务端口	27017
DB_NAME	string	使用的 MongoDB 数据库	yapi
DB_USER	string	登录 MongoDB 服务的用户名	root
DB_PASS	string	登录 MongoDB 服务的用户密码	r00t
DB_AUTH_SOURCE	string	MongoDB 身份认证所用库	admin
DB_SLAVE_URL	string	使用 MongoDB 集群时配置	mongodb://127.0.0.100:8418,127.0.0.101:8418/yapidb?slaveOk=true

邮件配置

环境变量名称	类型	说明	示例
MAIL_ENABLE	boolean	是否启用	true
MAIL_HOST	string	邮件服务地址	smtp.163.com
MAIL_PORT	number	邮件服务端口	465
MAIL_FROM	string	发送人邮箱	[email protected]
MAIL_USER	string	登录邮件服务的用户名	[email protected]
MAIL_PASS	string	登录邮件服务的用户密码	f00bar

LDAP 登录配置

点击查看 YApi 仓库下 LDAP 相关的 issues 👉

环境变量名称	类型	说明	示例
LDAP_ENABLE	boolean	是否启用	true
LDAP_LOGIN_SERVER	string	LDAP 服务地址	ldap://ldap.foo.bar
LDAP_BASE_DN	string	登录 LDAP 服务的用户名	cn=admin,dc=foo,dc=bar
LDAP_BIND_PASSWORD	string	登录 LDAP 服务的用户密码	f00bar
LDAP_SEARCH_DN	string	查询用户数据的路径	ou=users,dc=foo,dc=bar
LDAP_SEARCH_STANDARD	string	支持两种值： 1、前端登录账号对应的查询字段，如：mail、uid 等； 2、自定义查询条件，其中 %s 会被前端登录账号替换，如：&(objectClass=user)(cn=%s)	-
LDAP_EMAIL_POSTFIX	string	登录邮箱后缀	@163.com
LDAP_EMAIL_KEY	string	LDAP 数据库存储用户邮箱的字段	mail
LDAP_USERNAME_KEY	string	LDAP 数据库存储用户名的字段	name

插件配置

环境变量名称	类型	说明	示例
YAPI_PLUGINS	json	要使用的插件列表。点击查看开源 YApi 插件列表 → 配置项数据格式： { "name": "插件名称，必须去除前缀 yapi-plugin-", "options": "插件配置，没有配置则不必设置" } 注意： 安装插件会运行 YApi 自带的打包命令，其内存消耗较大，因此，在安装插件时，物理机可用内存最好大于等于 4GB，否则，易出现内存溢出错误，导致插件安装失败。	[{"name":"gitlab","options":{}}]

授权插件等回调地址忽略拦截配置

环境变量名称	类型	说明	示例
IGNORE_PATH	jsonArray	配置的路径会在程序初始化时加入忽略列表中	["/api/plugin/oauth2/callback","/api/plugin/oauth2/callback2"]

如何重启

若你修改了配置，务必重启应用才能生效：

docker-compose restart yapi-web

如何升级 最新1.12.0版本可能对一些插件兼容不好，目前测试的yapi-plugin-gitea-auth2有问题，如果要使用，请使用1.11.0

若 YApi 有更新，本项目应会尽快跟进，之后，你可使用以下命令升级：

docker-compose pull yapi-web \
  && docker-compose down \
  && docker-compose up -d

升级不会对原有数据造成任何影响！

查看日志

如果出现意外情况，你可通过以下命令查看运行日志：

docker-compose logs yapi-web

YApi 相关资源推荐

• YApi-X 浏览器插件

  为 YApi-X 开发的浏览器跨域与文件上传插件，同时支持 YApi 官方版。

许可