有问题，请直接到 GitHub 提 issue：https://github.com/ly525/luban-h5/issues/new

Linux

阿里云/腾讯云/Digital Ocean 以 Centos 为例，Ubuntu等其它发行版，请自行调整

安装基础软件

  1. 请自行安装：node、npm、yarn、pm2
  2. 安装教程请参见：https://www.yuque.com/xpm1xa/rgf7kz/gpfy6g#09H3u
  1. node: https://linuxize.com/post/how-to-install-node-js-on-centos-7/
  2. pm2: https://pm2.keymetrics.io/docs/usage/quick-start/

安装参考：

  1. # install yarn
  2. curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
  3. sudo yum install yarn -y
  5. # install pm2
  6. npm install pm2 -g
  7. # pm2 examples
  8. # pm2 start server.js
  9. # pm2 stop server
  10. # pm2 restart server
  11. # pm2 stop all

在服务器上执行如下代码即可

  1. git clone https://github.com/ly525/luban-h5.git
  2. cd luban-h5
  3. ./luban-h5.sh init  # 安装依赖，构建前后端
  4. ./luban-h5.sh start # 启动项目即可
  5. ./luban-h5.sh stop  # 停止服务
  1. 如何访问：
    1. 配置防火墙安全组，添加 1337 端口，通过 http://服务器IP:1337 访问即可访问
    2. http://服务器IP:1337/admin 为鲁班的管理后台

Docker 部署

TODO，PR is welcome

=========================================================================================
分割线：下面的内容已经废弃，请忽略
=========================================================================================

已经废弃<请忽略>

保留的目的：仅作参考

阿里云/腾讯云/Digital Ocean

云服务器(centos)

首先需要安装一些基础的软件包，请自行安装（具体参照其官网文档）

  1. node
  2. npm
  3. nginx
  4. yarn
  5. pm2

以下脚本仅供参考

  1. # install yarn
  2. curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
  3. sudo yum install yarn -y
  5. # install nginx
  6. sudo yum install nginx -y
  7. # install pm2
  8. npm install pm2 -g
  9. # pm2 examples
  10. # pm2 start server.js
  11. # pm2 stop server
  12. # pm2 restart server
  13. # pm2 stop all

nginx 配置文件 demo

  1. server {
  2.   listen 443;
  3.   server_name your_domain;
  5.   client_body_buffer_size 20M;
  6.   client_max_body_size 20M;
  7.   proxy_buffer_size 20M;
  8.   proxy_buffers 32 20M;
  9.   proxy_busy_buffers_size 20M;
  11.   ssl on;
  12.   ssl_certificate cert/luban-api.pem;
  13.   ssl_certificate_key cert/luban-api.key;
  14.   ssl_session_timeout 5s;
  15.   ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
  16.   ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  17.   ssl_prefer_server_ciphers on;
  19.   gzip on;
  20.   gzip_min_length 1k;
  21.   gzip_buffers 4 16k;
  22.   gzip_disable "MSIE [1-6]\.";
  23.   gzip_comp_level 3;
  24.   gzip_types image/png application/json text/plain application/x-javascript text/css application/xml text/javascript application/javascript;
  26.   # TODO 这边的 psd-files、engine-assets、third-libs 开发的时候，可以走 proxy_pass
  27.   # 生产环境的时候，最好走另外的 location，直接让 nginx 访问静态文件
  28.   location ~ ^/(upload|content-manager|users-permissions|works|admin|psd-files|workforms|third-libs|engine-assets) {
  29.     proxy_set_header Host $host;
  30.     proxy_set_header X-Real-IP $remote_addr;
  31.     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  32.     proxy_pass http://localhost:1337;
  33.   }
  34.   location / {
  36.     root /home/centos/codebase/luban/luban-h5-dist/front-end/;
  37.     #try_files $uri $uri/ /index.html;
  38.   }
  40. }

本地执行：

请先提前调研：flightplan
在项目根目录作如下操作：

  1. yarn add flightplan // 部署脚本，官方链接
  2. npm run deploy:esc // 云服务器 (Elastic Compute Service, 简称 ECS)

本地部署脚本

  1. var os = require('os');
  2. var plan = require('flightplan');
  4. // configuration
  5. local_dist_dir = './'; // root path for luban-h5
  6. remote_project_dir = '~/codebase/luban/luban-h5'; // root path for luban-h5 on server
  7. remote_project_api_dir = '~/codebase/luban/luban-h5/back-end/h5-api'; // api root path for luban-h5 on server
  9. // production server config
  10. plan.target('production', {
  11.   host: 'your host ip', // your server ip
  12.   username: 'centos', // your server username
  13.   // 更新为绝对路径
  14.   privateKey: `${os.homedir}/.ssh/id_rsa` // your privateKey to rsync files 
  15. });
  17. /**
  18.  * 1. setup folders
  19.  * 2. sync files
  20.  * 3. install dependencies
  21.  * 4. (re)start api service
  22.  * 5. soft link nginx conf
  23.  *
  24.  * 1. 创建同步文件件
  25.  * 2. 同步本地在 git 中的文件（你也可以在服务器端git clone）
  26.  * 3. 在 h5-api 目录安装依赖
  27.  * 4. 使用pm2 重启服务
  28.  * 5. 给 nginx 文件做一个软件链接
  29.  *
  30.  */
  32. // init remove server path
  33. // 在第一步的时候，需要打开这一项：初始化服务器，现在还不完整，需要补充
  34. // plan.remote(remote => {
  35. //   // remove.exec(`mkdir -p ${remote_project_dir}`)
  36. //   remove.sudo(`yum install nginx -y`)
  37. //   remote.with(`mkdir -p ${remote_project_dir}`, () => {
  38. //     // remote.log('Install dependencies');
  39. //     // remote.exec('yarn');
  40. //     remote.exec('pwd');
  41. //   });
  42. // });
  45. // run commands on localhost
  46. plan.local(local => {
  47.   // local.log('=> Run build');
  48.   // local.exec('npm run build');
  49.   // local.log('=> Build finish');
  51.   local.log('=> Copy files to remote hosts');
  52.   // TODO reference: https://github.com/pstadler/flightplan/issues/142
  53.   local.with(`cd ${local_dist_dir}`, () => {
  54.     // const filesToCopy = local.exec('find . -type f', { silent: true })
  55.     const filesToCopy = local.git('ls-files', {silent: true}) // get list of files under version control
  57.     local.transfer(filesToCopy, remote_project_dir);
  58.     local.log('=> Copy finish');
  60.   });
  61. });
  63. // run commands on the target's remote hosts
  64. plan.remote(remote => {
  65.   remote.with(`cd ${remote_project_api_dir}`, () => {
  66.     remote.log('Install dependencies');
  67.     remote.exec('yarn');
  68.     remote.exec('pm2 restart server')
  69.   });
  70. });

中间可能遇到的一些问题：

  1. Cannot parse privateKey: Unsupported key format
    解决方案请参照：Cannot parse privateKey: Unsupported key format

Docker 部署

以下方案来自：https://github.com/yi-ge/luban-h5#docker-%E9%83%A8%E7%BD%B2，非常非常感谢。 但仅供参考，此方案不是鲁班的官方的解决方案

鲁班决定暂时不按照这种方案来做，可以先使用上面部署脚本来发布到服务器上，进行部署。 鲁班后期考虑出一个简单版本docker image的部署方案，直接拉镜像，在服务器端就能直接跑起来。

请确保您的80端口和443端口均打开，如果已经配置了其它项目，请进行手工调整。

  1. 修改yourdomain.tld为您的前端域名并解析到服务器。
  2. 修改api.yourdomain.tld为您的后端域名并解析到服务器。
  3. 依次执行以下命令。
  1. # Clone luban-h5
  2. git clone https://github.com/ly525/luban-h5.git
  3. cd luban-h5
  5. # Install require package
  6. docker run --rm -v `pwd`:/root -w /root/back-end/h5-api node:12.8.1 bash -c "yarn && NODE_ENV=production yarn build"
  8. docker run --rm -v `pwd`:/root -w /root/front-end/h5 \
  9.     --env "PUBLIC_PATH=/" \
  10.     --env "PROD_API_ORIGIN=api.yourdomain.tld" \
  11.     node:12.8.1 bash -c "yarn && NODE_ENV=production yarn build && node build/engine.webpack.js"
  13. # Start back-end
  14. docker run --detach \
  15.     --name nginx-proxy \
  16.     --publish 80:80 \
  17.     --publish 443:443 \
  18.     --volume /etc/nginx/certs \
  19.     --volume /etc/nginx/vhost.d \
  20.     --volume /usr/share/nginx/html \
  21.     --volume /var/run/docker.sock:/tmp/docker.sock:ro \
  22.     jwilder/nginx-proxy
  24. docker run --detach \
  25.     --name nginx-proxy-letsencrypt \
  26.     --volumes-from nginx-proxy \
  27.     --volume /var/run/docker.sock:/var/run/docker.sock:ro \
  28.     jrcs/letsencrypt-nginx-proxy-companion
  30. docker run -itd -m 512m \
  31.     --restart=always \
  32.     --name luban-h5-front \
  33.     -v `pwd`/front-end/h5/dist:/usr/share/nginx/html \
  34.     --env "NODE_ENV=production" \
  35.     --env "VIRTUAL_HOST=yourdomain.tld" \
  36.     --env "LETSENCRYPT_HOST=yourdomain.tld" \
  37.     --env "PROD_API_ORIGIN=api.yourdomain.tld" \
  38.     nginx
  40. # Start font-end
  41. docker run -itd -m 1024m \
  42.     --name luban-h5-api \
  43.     --restart=always \
  44.     -v `pwd`:/root -w /root/back-end/h5-api \
  45.     -p 1337:1337 \
  46.     --env "NODE_ENV=production" \
  47.     --env "VIRTUAL_PORT=1337" \
  48.     --env "VIRTUAL_HOST=api.yourdomain.tld" \
  49.     --env "LETSENCRYPT_HOST=api.yourdomain.tld" \
  50.    --restart=always node:12.8.1 \
  51.    yarn start

稍等片刻，访问https://你的域名，部署完成。

关于Nginx、SSL的配置，可以参考：https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion

docker 自我学习，请忽略

  1. docker --rm
  2.     相当于：
  3.     1. docker run hello-world(hello-world为image-name)
  4.     2. docker rm hello-world-container-id(通过 docker ps -a 查看)
  6.     在Docker容器退出时，默认容器内部的文件系统仍然被保留，以方便调试并保留用户数据。
  7.     但是，对于foreground容器，由于其只是在开发调试过程中短期运行，其用户数据并无保留的必要，因而可以在容器启动时设置--rm选项，这样在容器退出时就能够自动清理容器内部的文件系统。示例如下：
  8.     docker run --rm bba-208等价于docker run --rm=true bba-208。
  9.     显然，--rm选项不能与-d同时使用，即只能自动清理foreground容器，不能自动清理detached容器
  10.     注意，--rm选项也会清理容器的匿名data volumes。
  11.     所以，执行docker run命令带--rm命令选项，等价于在容器退出后，执行docker rm -v。
  14. Docker命令详解（run篇）
  15.     命令格式：docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
  16.     Usage: Run a command in a new container
  17.     中文意思为：通过run命令创建一个新的容器（container）
  19.     常用选项说明
  20.     -d, --detach=false， 指定容器运行于前台还是后台，默认为false
  21.     -i, --interactive=false， 打开STDIN，用于控制台交互
  22.     -t, --tty=false， 分配tty设备，该可以支持终端登录，默认为false
  23.     -u, --user=""， 指定容器的用户
  24.     -a, --attach=[]， 登录容器（必须是以docker run -d启动的容器）
  25.     -w, --workdir=""， 指定容器的工作目录
  26.     -c, --cpu-shares=0， 设置容器CPU权重，在CPU共享场景使用
  27.     -e, --env=[]， 指定环境变量，容器中可以使用该环境变量
  28.     -m, --memory=""， 指定容器的内存上限
  29.     -P, --publish-all=false， 指定容器暴露的端口
  30.     -p, --publish=[]， 指定容器暴露的端口
  31.     -h, --hostname=""， 指定容器的主机名
  32.     -v, --volume=[]， 给容器挂载存储卷，挂载到容器的某个目录
  33.     --volumes-from=[]， 给容器挂载其他容器上的卷，挂载到容器的某个目录
  34.     --cap-add=[]， 添加权限，权限清单详见：http://linux.die.net/man/7/capabilities
  35.     --cap-drop=[]， 删除权限，权限清单详见：http://linux.die.net/man/7/capabilities
  36.     --cidfile=""， 运行容器后，在指定文件中写入容器PID值，一种典型的监控系统用法
  37.     --cpuset=""， 设置容器可以使用哪些CPU，此参数可以用来容器独占CPU
  38.     --device=[]， 添加主机设备给容器，相当于设备直通
  39.     --dns=[]， 指定容器的dns服务器
  40.     --dns-search=[]， 指定容器的dns搜索域名，写入到容器的/etc/resolv.conf文件
  41.     --entrypoint=""， 覆盖image的入口点
  42.     --env-file=[]， 指定环境变量文件，文件格式为每行一个环境变量
  43.     --expose=[]， 指定容器暴露的端口，即修改镜像的暴露端口
  44.     --link=[]， 指定容器间的关联，使用其他容器的IP、env等信息
  45.     --lxc-conf=[]， 指定容器的配置文件，只有在指定--exec-driver=lxc时使用
  46.     --name=""， 指定容器名字，后续可以通过名字进行容器管理，links特性需要使用名字
  47.     --net="bridge"， 容器网络设置:
  48.     bridge 使用docker daemon指定的网桥
  49.     host //容器使用主机的网络
  50.     container:NAME_or_ID >//使用其他容器的网路，共享IP和PORT等网络资源
  51.     none 容器使用自己的网络（类似--net=bridge），但是不进行配置
  52.     --privileged=false， 指定容器是否为特权容器，特权容器拥有所有的capabilities
  53.     --restart="no"， 指定容器停止后的重启策略:
  54.     no：容器退出时不重启
  55.     on-failure：容器故障退出（返回值非零）时重启
  56.     always：容器退出时总是重启
  57.     --rm=false， 指定容器停止后自动删除容器(不支持以docker run -d启动的容器)
  58.     --sig-proxy=true， 设置由代理接受并处理信号，但是SIGCHLD、SIGSTOP和SIGKILL不能被代理
  59.     示例
  60.     运行一个在后台执行的容器，同时，还能用控制台管理：docker run -i -t -d ubuntu:latest
  61.     运行一个带命令在后台不断执行的容器，不直接展示容器内部信息：docker run -d ubuntu:latest ping www.docker.com
  62.     运行一个在后台不断执行的容器，同时带有命令，程序被终止后还能重启继续跑，还能用控制台管理，docker run -d --restart=always ubuntu:latest ping www.docker.com
  63.     为容器指定一个名字，docker run -d --name=ubuntu_server ubuntu:latest
  64.     容器暴露80端口，并指定宿主机80端口与其通信(: 之前是宿主机端口，之后是容器需暴露的端口)，docker run -d --name=ubuntu_server -p 80:80 ubuntu:latest
  65.     指定容器内目录与宿主机目录共享(: 之前是宿主机文件夹，之后是容器需共享的文件夹)，docker run -d --name=ubuntu_server -v /etc/www:/var/www ubuntu:latest

Heroku

因为 Strapi + postgresql 在 Heroku 上还有一些坑，需要官方解决，这个方案暂时pending