From a600021e43eb02cc1003dbf77026393dbb534034 Mon Sep 17 00:00:00 2001 From: Zhu Liang Date: Mon, 17 Jun 2019 00:17:42 +0800 Subject: [PATCH] docs(deploy): update docs (#69) --- docker/README.md | 27 +----------------- docs/guide/reliable-web-deploy.md | 41 ++++++++++++++++++---------- docs/zh/guide/reliable-web-deploy.md | 36 ++++++++++++++++-------- 3 files changed, 51 insertions(+), 53 deletions(-) diff --git a/docker/README.md b/docker/README.md index e60ed62..f449e07 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,28 +1,3 @@ # Dockerfiles ---- - -You need to run both `database` and `app` containers - -## Running both together with docker-compose - -```bash -# cd to project root where docker-compose.yml is located -$ docker-compose up -``` - -```bash -# add seed to db, otherwise 500 will be thrown -$ NODE_ENV=production npm run db:seed:all -``` - -## Starting them separately - -### Database container - reliable-mysql - -- [Dockerfile](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/Dockerfile) -- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/README.md) - -### Reliable main app container (backend and frontend) - reliable-web -- [Dockerfile](https://github.com/macacajs/reliable/blob/master/Dockerfile) -- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-web/README.md) +Refer to the [Docker docs](https://macacajs.github.io/reliable/guide/reliable-web-deploy.html) on official website. diff --git a/docs/guide/reliable-web-deploy.md b/docs/guide/reliable-web-deploy.md index d94a69e..1e3e59a 100644 --- a/docs/guide/reliable-web-deploy.md +++ b/docs/guide/reliable-web-deploy.md @@ -2,11 +2,11 @@ --- -## Docker Deploy +Note: You need to run both the database container (`reliable-mysql`) and the app (`reliable-web`) container for reliable to work. -### Using [docker-compose](https://docs.docker.com/compose/) (recommended) +## Using [docker-compose](https://docs.docker.com/compose/) (recommended) -## production +### production ``` # start services @@ -18,16 +18,22 @@ $ docker-compose -p reliable -f docker-compose.yml up -d $ docker-compose -p reliable -f docker-compose.yml down ``` -execute `docker ps`, we can see: +Execute `docker ps`, we can see: ``` -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -8b2941c9774a macacajs/reliable-web "./entrypoint.sh npm…" 12 minutes ago Up 12 minutes (healthy) 0.0.0.0:9900->9900/tcp reliable_web_1 -b726a3232cdc macacajs/reliable-mysql "docker-entrypoint.s…" 12 minutes ago Up 12 minutes 3306/tcp reliable_mysql_1 -ffb2ab9f12fb macacajs/reliable-nginx "nginx -g 'daemon of…" 12 minutes ago Up 12 minutes 0.0.0.0:9920->80/tcp reliable_nginx_1 +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d42a6be2a061 macacajs/reliable-web:test3 "./entrypoint.sh npm…" 3 minutes ago Up 3 minutes (healthy) 0.0.0.0:9900->9900/tcp reliable-web +4d7d43591802 macacajs/reliable-mysql "docker-entrypoint.s…" 20 minutes ago Up 20 minutes 0.0.0.0:3306->3306/tcp, 33060/tcp reliable-mysql ``` -go into the MySQL +During the first deployment, seed the database before accessing the web portal. Otherwise 500 will be thrown: + +```bash +$ NODE_ENV=production npm run db:seed:all +``` + +To go into the MySQL: ```bash $ docker exec -it reliable_mysql_1 mysql -uroot -preliable @@ -36,7 +42,7 @@ mysql> show tables; mysql> select * from reliable.jobNames; ``` -## development +### development ``` # start services @@ -48,11 +54,16 @@ $ docker-compose down Reliable server is running on `http://127.0.0.1:9900` by default. -Nginx server is running on `http://127.0.0.1:9920` by default. - Edit [docker-compose.yml](https://github.com/macacajs/reliable/blob/master/docker-compose.yml) to fit your need. -### Using [docker](https://docs.docker.com/) +## Using [docker](https://docs.docker.com/) + +### Database container - reliable-mysql + +- [Dockerfile](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/Dockerfile) +- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/README.md) + +### Reliable main app container (backend and frontend) - reliable-web +- [Dockerfile](https://github.com/macacajs/reliable/blob/master/Dockerfile) +- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-web/README.md) -- [reliable-web](../../docker/reliable-web/README.md) -- [reliable-mysql](../../docker/reliable-mysql/README.md) diff --git a/docs/zh/guide/reliable-web-deploy.md b/docs/zh/guide/reliable-web-deploy.md index 8d8da18..9a44025 100644 --- a/docs/zh/guide/reliable-web-deploy.md +++ b/docs/zh/guide/reliable-web-deploy.md @@ -2,11 +2,11 @@ --- -## Docker 部署 +注意：运行 reliable 需要启动数据库容器（`reliable-mysql`）和应用容器（`reliable-web`）。 -### 使用 [docker-compose](https://docs.docker.com/compose/) (推荐) +## 使用 [docker-compose](https://docs.docker.com/compose/) (推荐) -## 生产环境 +### 生产环境 ```bash # start services @@ -21,13 +21,19 @@ $ docker-compose -p reliable -f docker-compose.yml down 执行 `docker ps` 我们能够看到以下容器： ``` -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -8b2941c9774a macacajs/reliable-web "./entrypoint.sh npm…" 12 minutes ago Up 12 minutes (healthy) 0.0.0.0:9900->9900/tcp reliable_web_1 -b726a3232cdc macacajs/reliable-mysql "docker-entrypoint.s…" 12 minutes ago Up 12 minutes 3306/tcp reliable_mysql_1 -ffb2ab9f12fb macacajs/reliable-nginx "nginx -g 'daemon of…" 12 minutes ago Up 12 minutes 0.0.0.0:9920->80/tcp reliable_nginx_1 +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d42a6be2a061 macacajs/reliable-web:test3 "./entrypoint.sh npm…" 3 minutes ago Up 3 minutes (healthy) 0.0.0.0:9900->9900/tcp reliable-web +4d7d43591802 macacajs/reliable-mysql "docker-entrypoint.s…" 20 minutes ago Up 20 minutes 0.0.0.0:3306->3306/tcp, 33060/tcp reliable-mysql ``` -进入 MySQL +第一次运行需添加初始数据，否则服务器会返回500错误： + +```bash +$ NODE_ENV=production npm run db:seed:all +``` + +如何进入 MySQL： ```bash $ docker exec -it reliable_mysql_1 mysql -uroot -preliable @@ -36,7 +42,7 @@ mysql> show tables; mysql> select * from reliable.jobNames; ``` -## 开发环境 +### 开发环境 ```bash # start services @@ -52,7 +58,13 @@ Nginx 服务默认运行在 `http://127.0.0.1:9920`。 需要按需修改 [docker-compose.yml](https://github.com/macacajs/reliable/blob/master/docker-compose.yml) 配置。 -### 其他 [Docker](https://docs.docker.com/) 服务部署 +## 其他 [Docker](https://docs.docker.com/) 服务部署 + +### Database container - reliable-mysql + +- [Dockerfile](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/Dockerfile) +- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-mysql/README.md) -- [reliable-web](../../docker/reliable-web/README.md) -- [reliable-mysql](../../docker/reliable-mysql/README.md) +### Reliable main app container (backend and frontend) - reliable-web +- [Dockerfile](https://github.com/macacajs/reliable/blob/master/Dockerfile) +- [doc](https://github.com/macacajs/reliable/blob/master/docker/reliable-web/README.md)