Skip to content

Commit

Permalink
docs: 更新演示地址
Browse files Browse the repository at this point in the history
  • Loading branch information
@fjc0k
fjc0k committed Feb 10, 2023
1 parent 3f18898 commit 78a2d81
Showing 1 changed file with 36 additions and 34 deletions.
70 changes: 36 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@

---

演示地址： [https://docker-yapi.herokuapp.com/](https://docker-yapi.herokuapp.com/)
演示地址： [https://dockeryapi-fjc0kb.b4a.run/](https://dockeryapi-fjc0kb.b4a.run/)

管理员账号：`admin@docker.yapi`

管理员密码：`adm1n`

仅供测试，服务每次部署都会重置，请不要将重要数据放在上面。

> 演示服务所需资源由 [Back4App](https://www.back4app.com/) 免费提供。
---

<!-- TOC depthFrom:2 -->
Expand Down Expand Up @@ -79,58 +81,58 @@ git clone https://gitee.com/fjc0k/docker-YApi.git

#### 基础配置

| 环境变量名称 | 类型 | 说明 | 示例 |
|---------------------|---------|--------------------------------------------------------------------------------------------|---------------------------------|
| 环境变量名称 | 类型 | 说明 | 示例 |
| ------------------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------- |
| YAPI_ADMIN_ACCOUNT | string | 管理员账号（邮箱） | admin@foo.bar |
| YAPI_ADMIN_PASSWORD | string | 管理员密码 | adm1n |
| YAPI_ADMIN_PASSWORD | string | 管理员密码 | adm1n |
| YAPI_CLOSE_REGISTER | boolean | 是否关闭注册，由于 docker-YApi 已[内置相关插件](#内置插件)，你可在关闭注册后在后台手动添加用户 | true |
| YAPI_NPM_REGISTRY | string | npm 源，目前仅在安装插件时使用，默认官方源，国内可以设为淘宝源加速 | https://registry.npm.taobao.org |
| YAPI_NPM_REGISTRY | string | npm 源，目前仅在安装插件时使用，默认官方源，国内可以设为淘宝源加速 | https://registry.npm.taobao.org |

#### 数据库配置

| 环境变量名称 | 类型 | 说明 | 示例 |
|------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| YAPI_DB_SERVERNAME | string | MongoDB 服务地址 | yapi-mongo |
| YAPI_DB_PORT | number | MongoDB 服务端口 | 27017 |
| YAPI_DB_DATABASE | string | 使用的 MongoDB 数据库 | yapi |
| YAPI_DB_USER | string | 登录 MongoDB 服务的用户名 | root |
| YAPI_DB_PASS | string | 登录 MongoDB 服务的用户密码 | r00t |
| YAPI_DB_AUTH_SOURCE | string | MongoDB 身份认证所用库 | admin |
| YAPI_DB_CONNECT_STRING | string | 使用 MongoDB 集群时配置 | mongodb://127.0.0.100:8418,127.0.0.101:8418/yapidb?slaveOk=true |
| 环境变量名称 | 类型 | 说明 | 示例 |
| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| YAPI_DB_SERVERNAME | string | MongoDB 服务地址 | yapi-mongo |
| YAPI_DB_PORT | number | MongoDB 服务端口 | 27017 |
| YAPI_DB_DATABASE | string | 使用的 MongoDB 数据库 | yapi |
| YAPI_DB_USER | string | 登录 MongoDB 服务的用户名 | root |
| YAPI_DB_PASS | string | 登录 MongoDB 服务的用户密码 | r00t |
| YAPI_DB_AUTH_SOURCE | string | MongoDB 身份认证所用库 | admin |
| YAPI_DB_CONNECT_STRING | string | 使用 MongoDB 集群时配置 | mongodb://127.0.0.100:8418,127.0.0.101:8418/yapidb?slaveOk=true |
| YAPI_DB_OPTIONS | json | Mongoose 连接 MongoDB 服务时的额外选项，一般不用设置。请参考: [Mongoose.prototype.connect()](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-connect) | {} |

#### 邮件配置

| 环境变量名称 | 类型 | 说明 | 示例 |
|---------------------|---------|------------------------------------------------------------------------------------------------------------|--------------------------------------|
| YAPI_MAIL_ENABLE | boolean | 是否启用 | true |
| YAPI_MAIL_HOST | string | 邮件服务地址 | smtp.163.com |
| YAPI_MAIL_PORT | number | 邮件服务端口 | 465 |
| YAPI_MAIL_FROM | string | 发送人邮箱 | foo@163.com |
| YAPI_MAIL_AUTH_USER | string | 登录邮件服务的用户名 | bar@163.com |
| YAPI_MAIL_AUTH_PASS | string | 登录邮件服务的用户密码 | f00bar |
| 环境变量名称 | 类型 | 说明 | 示例 |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| YAPI_MAIL_ENABLE | boolean | 是否启用 | true |
| YAPI_MAIL_HOST | string | 邮件服务地址 | smtp.163.com |
| YAPI_MAIL_PORT | number | 邮件服务端口 | 465 |
| YAPI_MAIL_FROM | string | 发送人邮箱 | foo@163.com |
| YAPI_MAIL_AUTH_USER | string | 登录邮件服务的用户名 | bar@163.com |
| YAPI_MAIL_AUTH_PASS | string | 登录邮件服务的用户密码 | f00bar |
| YAPI_MAIL_OPTIONS | json | 传递给 Nodemailer 的额外选项，一般不用设置。请参考：[Nodemailer > SMTP transport](https://nodemailer.com/smtp/) | {"tls":{"rejectUnauthorized":false}} |

#### LDAP 登录配置

[点击查看 YApi 仓库下 LDAP 相关的 issues 👉](https://github.com/YMFE/yapi/issues?utf8=%E2%9C%93&q=ldap)

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

#### 插件配置

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

## 内置插件
Expand Down

0 comments on commit 78a2d81

Please sign in to comment.