docs(deployment): update deployment on ecs

ly525 · 小小鲁班
1 parent d5142a3a
Showing 5 changed files with 58 additions and 287 deletions
README.en.md
README.md
deploy/ubuntu-install.sh
docs/en/getting-started/deployment.md
docs/zh/getting-started/deployment.md
@@ -12,6 +12,22 @@
 <img src="https://s2.ax1x.com/2019/10/11/u7WzUx.gif" style="margin: 10px;" width="60%" />
+### let's go through it real quick.
+> in short
+
+```shell
+docker pull ubuntu
+docker run -it -p 1234:80 -p 1235:1337  -v `pwd`:/app ubuntu
+apt update && apt install -y wget git
+wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash
+
+# after the installation finished
+# 1. visit ：http://localhost:1235/admin, add your admin account
+# 1.2 config the api permissions, see more here：https://ly525.github.io/luban-h5/en/getting-started/quick-start.html#_2-something-important
+
+# 2. front-end
+# 2.1 visit https://localhost:1235 to get the front-end of luban-h5
+```
 ## Links
 - Documents
@@ -28,6 +28,9 @@ Mobile Page Builder&amp;Generator with Drag&amp;Drop
 ```shell
 docker pull ubuntu
 docker run -it -p 1234:80 -p 1235:1337  -v `pwd`:/app ubuntu
+# 使用清华大学 Ubuntu 软件镜像
+sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list
+apt update && apt install -y wget git
 wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash
 # 安装完成之后
@@ -5,7 +5,7 @@
  # @Author: ly525
  # @Date: 2019-11-30 13:24:57
  # @LastEditors  : ly525
- # @LastEditTime : 2020-01-05 21:39:42
+ # @LastEditTime : 2020-01-11 12:20:31
  # @FilePath: /luban-h5/deploy/ubuntu-install.sh
  # @Github: https://github.com/ly525/luban-h5
  # @Description:
@@ -330,16 +330,19 @@ function install_luban-h5 {
     cd ~/
     git clone https://github.com/ly525/luban-h5
-    # 鲁班前端
-    cd luban-h5/front-end/h5 && yarn && yarn build # build editor and preview engine
+    # # 鲁班前端
+    # cd luban-h5/front-end/h5 && yarn && yarn build # build editor and preview engine
-    cd -
+    # cd -
-    # 鲁班后端
-    cd luban-h5/back-end/h5-api/ && yarn && yarn build # build strapi admin
-    pm2 start server.js
-    pwd
-    success luban-h5
+    # # 鲁班后端
+    # cd luban-h5/back-end/h5-api/ && yarn && yarn build # build strapi admin
+    # pm2 start server.js
+    # pwd
+    # success luban-h5
+
+    ./luban-h5.sh init
+    ./luban-h5.sh start
   fi
 }
@@ -369,7 +372,7 @@ install_yarn
 set_npm_mirror
 install_strapi
 install_pm2
-install_nginx
+# install_nginx
 install_luban-h5
 exitBanner
+
 # Deployment
 ## Aliyun/Tencent Cloud/Digital Ocean
-#### 1. on your server(centos)
-First of all, you need to install some basic software packages, please install them yourself (refer to its official website documents for details)
-
-1. Node
-1. Npm
-1. Nginx
-1. Yarn
-1. Pm2
-
-> The following scripts are just for your information
+1. Preinstall
+  > First of all, you need to install some basic software on your server(centos), please install them yourself (refer to its official website documents for details)
+  >  `node、npm、yarn、pm2`
+The following scripts are just for your information
 ```bash
 # install yarn
 curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
@@ -29,135 +24,23 @@ npm install pm2 -g
 # pm2 stop server
 # pm2 restart server
 # pm2 stop all
-
 ```
-Nginx profile demo
-
-```nginx
-server {
-  listen 443;
-  server_name your_domain;
-
-  client_body_buffer_size 20M;
-  client_max_body_size 20M;
-  proxy_buffer_size 20M;
-  proxy_buffers 32 20M;
-  proxy_busy_buffers_size 20M;
-
-  # https ssl config
-  ssl on;
-  ssl_certificate cert/your-https.pem;
-  ssl_certificate_key cert/your-https.key;
-  ssl_session_timeout 5s;
-  ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
-  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
-  ssl_prefer_server_ciphers on;
-
-  gzip on;
-  gzip_min_length 1k;
-  gzip_buffers 4 16k;
-  gzip_disable "MSIE [1-6]\.";
-  gzip_comp_level 3;
-  gzip_types image/png application/json text/plain application/x-javascript text/css application/xml text/javascript application/javascript;
-
-
-  location ~ ^/(upload|content-manager|users-permissions|works|admin|psd-files|workforms|third-libs|engine-assets) {
-    proxy_set_header Host $host;
-    proxy_set_header X-Real-IP $remote_addr;
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_pass http://localhost:1337;
-  }
-  location / {
-
-    root /home/centos/luban-h5-dist/front-end/;
-    #try_files $uri $uri/ /index.html;
-  }
-
-}
-```
-
-#### 2. on local machine
-Do the following in the root path of the project:
+2. Run the code on the server
 ```bash
-yarn add flightplan
-npm run deploy:ecs // Elastic Compute Service
-```
-
-Local deployment script
-
-```javascript
-var os = require('os');
-var plan = require('flightplan');
-
-// configuration
-local_dist_dir = './'; // root path for luban-h5
-remote_project_dir = '~/codebase/luban/luban-h5'; // root path for luban-h5 on server
-remote_project_api_dir = '~/codebase/luban/luban-h5/back-end/h5-api'; // api root path for luban-h5 on server
-
-// production server config
-plan.target('production', {
-  host: 'your host ip', // your server ip
-  username: 'centos', // your server username
-  // privateKey should be absolute path
-  privateKey: `${os.homedir}/.ssh/id_rsa` // your privateKey to rsync files
-});
-
-/**
- * 1. setup folders
- * 2. sync files
- * 3. install dependencies
- * 4. (re)start api service
- * 5. soft link nginx conf
- *
- */
-
-// init remove server path
-// plan.remote(remote => {
-//   // remove.exec(`mkdir -p ${remote_project_dir}`)
-//   remove.sudo(`yum install nginx -y`)
-//   remote.with(`mkdir -p ${remote_project_dir}`, () => {
-//     // remote.log('Install dependencies');
-//     // remote.exec('yarn');
-//     remote.exec('pwd');
-//   });
-// });
-
-
-// run commands on localhost
-plan.local(local => {
-  // local.log('=> Run build');
-  // local.exec('npm run build');
-  // local.log('=> Build finish');
-
-  local.log('=> Copy files to remote hosts');
-  // reference: https://github.com/pstadler/flightplan/issues/142
-  local.with(`cd ${local_dist_dir}`, () => {
-    // const filesToCopy = local.exec('find . -type f', { silent: true })
-    const filesToCopy = local.git('ls-files', {silent: true}) // get list of files under version control
-
-    local.transfer(filesToCopy, remote_project_dir);
-    local.log('=> Copy finish');
-
-  });
-});
-
-// run commands on the target's remote hosts
-plan.remote(remote => {
-  remote.with(`cd ${remote_project_api_dir}`, () => {
-    remote.log('Install dependencies');
-    remote.exec('yarn');
-    remote.exec('pm2 restart server')
-  });
-});
+# just run the following code on the server
+git clone https://github.com/ly525/luban-h5.git
+./luban-h5.sh init  # installation dependency, build front-end and back-end
+./luban-h5.sh start # just start the service
+./luban-h5.sh stop # stop the service
 ```
-#### Some problems that may be encountered in the middle:
-
-1. `Cannot parse privateKey: Unsupported key format` <br />For solutions, please refer: [Cannot parse privateKey: Unsupported key format](https://stackoverflow.com/questions/53400628/cannot-parse-privatekey-unsupported-key-format)
-
-
+3. How to access
+    1. configure the firewall security group and add port `1337`.
+    2. visit `http://ServerIP:1337/admin` to get the admin panel for luban-h5
+    3. config the API permissions, see more [here](https://ly525.github.io/luban-h5/en/getting-started/quick-start.html#_2-something-important)
+    4. visit `http://ServerIP:1337` to get the app
 ## Docker deployment
 > TODO
@@ -4,16 +4,8 @@
 ## 阿里云/腾讯云/Digital Ocean
 > 以 Centos 为例，Ubuntu等其它发行版，请自行调整
-1. 预安装：
-
-  - 首先需要安装一些基础的软件包，请自行安装（具体参照其官网文档）
-    -  node
-    -  npm
-    -  nginx
-    -  yarn
-    -  pm2
-
-  - 1.2 以下脚本仅供参考
+1. 首先需要安装一些基础的软件包，请自行安装（具体参照其官网文档）
+>  `node、npm、yarn、pm2`
   ```bash
   # install yarn
@@ -31,144 +23,18 @@
   # pm2 stop all
   ```
-nginx 配置文件 demo
-
-```nginx
-server {
-  listen 443;
-  server_name your_domain;
-
-  client_body_buffer_size 20M;
-  client_max_body_size 20M;
-  proxy_buffer_size 20M;
-  proxy_buffers 32 20M;
-  proxy_busy_buffers_size 20M;
-
-  ssl on;
-  ssl_certificate cert/your-https.pem;
-  ssl_certificate_key cert/your-https.key;
-  ssl_session_timeout 5s;
-  ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
-  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
-  ssl_prefer_server_ciphers on;
-
-  gzip on;
-  gzip_min_length 1k;
-  gzip_buffers 4 16k;
-  gzip_disable "MSIE [1-6]\.";
-  gzip_comp_level 3;
-  gzip_types image/png application/json text/plain application/x-javascript text/css application/xml text/javascript application/javascript;
-
-  # TODO 这边的 psd-files、engine-assets、third-libs 开发的时候，可以走 proxy_pass
-  # 生产环境的时候，最好走另外的 location，直接让 nginx 访问静态文件
-  location ~ ^/(upload|content-manager|users-permissions|works|admin|psd-files|workforms|third-libs|engine-assets) {
-    proxy_set_header Host $host;
-    proxy_set_header X-Real-IP $remote_addr;
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_pass http://localhost:1337;
-  }
-
-  location / {
-    root /home/centos/codebase/luban/luban-h5-dist/front-end/;
-    #try_files $uri $uri/ /index.html;
-  }
-
-}
-```
-
-#### 本地执行：
-请先提前调研：flightplan
-在项目根目录作如下操作：
+2. 在服务器上执行如下代码即可
 ```bash
-yarn add flightplan // 部署脚本，官方链接
-npm run deploy:ecs // 云服务器 (Elastic Compute Service, 简称 ECS)
-```
-
-本地部署脚本
-
-```javascript
-var os = require('os');
-var plan = require('flightplan');
-
-// configuration
-local_dist_dir = './'; // root path for luban-h5
-remote_project_dir = '~/codebase/luban/luban-h5'; // root path for luban-h5 on server
-remote_project_api_dir = '~/codebase/luban/luban-h5/back-end/h5-api'; // api root path for luban-h5 on server
-
-// production server config
-plan.target('production', {
-  host: 'your host ip', // your server ip
-  username: 'centos', // your server username
-  // 更新为绝对路径
-  privateKey: `${os.homedir}/.ssh/id_rsa` // your privateKey to rsync files
-});
-
-/**
- * 1. setup folders
- * 2. sync files
- * 3. install dependencies
- * 4. (re)start api service
- * 5. soft link nginx conf
- *
- * 1. 创建同步文件件
- * 2. 同步本地在 git 中的文件（你也可以在服务器端git clone）
- * 3. 在 h5-api 目录安装依赖
- * 4. 使用pm2 重启服务
- * 5. 给 nginx 文件做一个软件链接
- *
- */
-
-// init remove server path
-// 在第一步的时候，需要打开这一项：初始化服务器，现在还不完整，需要补充
-// plan.remote(remote => {
-//   // remove.exec(`mkdir -p ${remote_project_dir}`)
-//   remove.sudo(`yum install nginx -y`)
-//   remote.with(`mkdir -p ${remote_project_dir}`, () => {
-//     // remote.log('Install dependencies');
-//     // remote.exec('yarn');
-//     remote.exec('pwd');
-//   });
-// });
-
-
-// run commands on localhost
-plan.local(local => {
-  // local.log('=> Run build');
-  // local.exec('npm run build');
-  // local.log('=> Build finish');
-
-  local.log('=> Copy files to remote hosts');
-  // TODO reference: https://github.com/pstadler/flightplan/issues/142
-  local.with(`cd ${local_dist_dir}`, () => {
-    // const filesToCopy = local.exec('find . -type f', { silent: true })
-    const filesToCopy = local.git('ls-files', {silent: true}) // get list of files under version control
-
-    local.transfer(filesToCopy, remote_project_dir);
-    local.log('=> Copy finish');
-
-  });
-});
-
-// run commands on the target's remote hosts
-plan.remote(remote => {
-  remote.with(`cd ${remote_project_api_dir}`, () => {
-    remote.log('Install dependencies');
-    remote.exec('yarn');
-    remote.exec('pm2 restart server')
-  });
-});
-
-
+git clone https://github.com/ly525/luban-h5.git
+./luban-h5.sh init  # 安装依赖，构建前后端
+./luban-h5.sh start # 启动项目即可
+./luban-h5.sh stop  # 停止服务
 ```
-
-
-#### 中间可能遇到的一些问题：
-
-1. `Cannot parse privateKey: Unsupported key format` 
-
-    解决方案请参照：[Cannot parse privateKey: Unsupported key format](https://stackoverflow.com/questions/53400628/cannot-parse-privatekey-unsupported-key-format)
+3.  如何访问：
+    1.  配置防火墙安全组，添加 1337 端口，通过 `http://服务器IP:1337` 访问即可访问
+    2. `http://服务器IP:1337/admin` 为鲁班的管理后台
 ## Docker 部署