diff --git a/README.md b/README.md index 275addb..b52a7b0 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,73 @@ [![Build Status](https://travis-ci.org/thx/rap2-delos.svg?branch=master)](https://travis-ci.org/thx/rap2-delos) -RAP2 是在 RAP1 基础上重做的新项目,它包含两个组件(对应两个 Github Repository)。 +RAP2 是在 RAP1 基础上重做的新项目,它能给你提供方便的接口文档管理、Mock、导出等功能,包含两个组件(对应两个 Github Repository)。 - rap2-delos: 后端数据 API 服务器,基于 Koa + MySQL[link](http://github.com/thx/rap2-delos) - rap2-dolores: 前端静态资源,基于 React [link](http://github.com/thx/rap2-dolores) + +**Rap 官方服务站点,无需安装直接体验: [rap2.taobao.org](http://rap2.taobao.org)** + +**有急事来官方钉钉群,响应更迅速: 11789704** + +***2019-10-31:现已支持 Docker 一键部署,欢迎大家体验&反馈*** + ***2019-09-27:更新的用户请注意按照下面指引安装 pandoc 以启用文档导出功能*** -### Resources -- [Official Site 官网: rap2.taobao.org](http://rap2.taobao.org) -- 钉钉群 ID: 11789704 -- [热心网友提供的部署文档,供参考](https://github.com/thx/rap2-delos/issues/119) +## 推荐使用 Docker 快速部署 + +### 安装 Docker + +国内用户可参考 [https://get.daocloud.io/](https://get.daocloud.io/) 安装 Docker 以及 Docker Compose (Linux 用户需要单独安装),建议按照链接指引配置 Docker Hub 的国内镜像提高加载速度。 + +### 配置项目 + +在任意地方建立目录 rap + +把本仓库中的 [docker-compose.yml](https://raw.githubusercontent.com/thx/rap2-delos/master/docker-compose.yml) 放到 rap 目录中 -## 快速部署(Docker) +Rap 前端服务的端口号默认为 3000,你可以在 docker-compose.yml 中按照注释自定义 + +在 rap 目录下执行下面的命令: ```sh -# 1. 安装docker -# 2. 修改docker-compose.xml中的配置。默认使用mysql和redis的镜像。可修改为自己的配置 -# 3. 下载源码并执行。 +# 拉取镜像并启动 docker-compose up -d -# ⚠️注意: 第一次运行需要手动初始化mysql数据库。分别执行以下命令: +# 启动后,第一次运行需要手动初始化mysql数据库 +# ⚠️注意: 只有第一次该这样做 docker-compose exec delos node scripts/init # 部署成功后 访问 -http://localhost:38081 # 前端 +http://localhost:3000 # 前端(可自定义端口号) http://localhost:38080 # 后端 -# 如果仍然有问题,重新启动 +# 如果访问不了可能是数据库没有链接上,关闭 rap 服务 docker-compose down -# 重新运行 +# 再重新运行 docker-compose up -d ``` -## 部署 +**⚠️注意:第一次运行后 rap 目录下会被自动创建一个 docker 目录,里面存有 rap 的数据库数据,可千万不要删除。** + +#### 镜像升级 + +Rap 经常会进行 bugfix 和功能升级,用 Docker 可以很方便地跟随主项目升级 + +```sh +# 拉取一下最新的镜像 +docker-compose pull +# 暂停当前应用 +docker-compose down +# 重新构建并启动 +docker-compose up -d --build +# 清空不被使用的虚悬镜像 +docker image prune -f +``` + +## 手动部署 ### 环境要求 diff --git a/docker-compose.yml b/docker-compose.yml index 13102a6..69f94cb 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,12 +9,14 @@ services: dolores: image: rapteam/rap2-dolores:latest ports: - - 38081:38081 + #冒号前可以自定义前端端口号,冒号后不要动 + - 3000:38081 # backend delos: image: rapteam/rap2-delos:latest ports: + # 这里的配置不要改哦 - 38080:38080 environment: - SERVE_PORT=38080