开源地址：https://github.com/yi-ge/electron-distribution

使用时需要注意，一个git仓库需对应一个Electron应用程序，一个Electron应用程序对应需要部署一套应用分发系统。

Electron 应用分发系统服务器端工作在64位Linux操作系统（必须）和MacOS（可选），默认编译x64应用程序, 其它平台及架构需要修改相应代码（不过这很容易实现）。

快速开始

Linux Server (x64) 服务器部署指南

命令运行例子

docker run -itd --name electron-distribution --restart always \
 -e NAME=your-app-name \
 -e SCHEME=https \
 -e DOMAIN=www.example.com \
 -e TOKEN=123456 \
 -e REPOPATH=git@github.com:abc/def.git \
 -e BUILD_TYPE=win,linux,mac \
 -e WORKPATH=/data \
 -e OBJECT_STORAGE_TYPE=cos
 -v /data:/data \
 -p 80:80 \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v /root/.ssh:/root/.ssh \
 -v /data/icon.ico:/project/public/icon.ico \
 wy373226722/electron-distribution

国内用户: docker pull registry.cn-shenzhen.aliyuncs.com/yi-ge/electron-distribution:latest or docker pull ccr.ccs.tencentyun.com/yi-ge/electron-distribution:latest

你需要自行安装Nginx并配置使其支持SSL，这是必须的，否则应用程序自动更新可能会失效。SCHEME只是一个标识。

注意： 目前只支持Docker，暂不支持podman等容器工具。

环境变量

七牛对象存储: https://developer.qiniu.com/kodo/sdk/1289/nodejs 阿里云对象存储: https://github.com/ali-sdk/ali-oss 腾讯云对象存储: https://github.com/tencentyun/cos-nodejs-sdk-v5

API 文档

Swagger: https://yourdomain/documentation

API中的token需要进行SHA-512加密。

Github webhooks: https://yourdomain/build/webhooks

Content type: application/json Secret: your Token

Electron 应用程序配置指南

yarn add electron-builder electron-simple-updater -D

关于： electron-builder electron-simple-updater

在你的package.json文件中加入build配置信息(https://www.electron.build):

"scripts": {
  "build": "electron-builder",
  "build:dir": "electron-builder --dir",
  ...
},
"build": {
  "productName": "Your App Name",
  "appId": "com.appid.abc",
  "directories": {
    "output": "build"
  },
  "dmg": {
    "contents": [
      {
        "x": 410,
        "y": 150,
        "type": "link",
        "path": "/Applications"
      },
      {
        "x": 130,
        "y": 150,
        "type": "file"
      }
    ]
  },
  "mac": {
    "icon": "build/icons/icon.icns"
  },
  "win": {
    "icon": "build/icons/icon.ico",
    "target": "squirrel"
  },
  "linux": {
    "artifactName": "${productName}-${version}-${arch}.${ext}",
    "icon": "build/icons"
  },
  "squirrelWindows": {
    "iconUrl": "https://yourServer/app/icon.ico"
  }
},

在main.js文件中，等到渲染进程里面的基础逻辑完全加载完毕后，参考electron-simple-updater编写自动更新逻辑。参考代码：

if (process.env.NODE_ENV !== 'development') {
    // 初始化更新检测模块
    updater.init({
      autoDownload: false,
      checkUpdateOnStart: false,
      disabled: false,
      logger: logger,
      url: 'https://yourDomain/app/updates.json'
    })

    updater.on('update-available', meta => {
      logger.info('[updater] update avaiable', meta.version)
      mainWindow.webContents.send('updater', 'update-available', meta.version)
      updater.downloadUpdate()
    })
    updater.on('update-downloading', () => {
      logger.info('下载更新中')
    })
    updater.on('update-downloaded', () => {
      logger.info('更新下载完成')
      mainWindow.webContents.send('updater', 'update-downloaded')
      updater.quitAndInstall() // 直接重启安装
    })
    updater.on('error', err => {
      logger.warn('下载更新发生错误')
      logger.warn(err.toString())
    })

    logger.info('更新检测模块初始化完成')

    updater.checkForUpdates()

    ipcMain.on('quitAndInstall', e => {
      updater.quitAndInstall()
    })

    setInterval(() => {
      updater.checkForUpdates()
    }, 5 * 60 * 1000)
  }

Mac APP 编译及代码签名

在macOS Majave (10.14.4)中安装 Xcode 10.2 \ brew (yarn 1.15.2) \ nvm (node 11.13.0), 至少运行一次Xcode。

操作系统默认安装了 Git 和 rsync。

开启 sshd:

sudo launchctl load -w /System/Library/LaunchDaemons/ssh.plist

添加你的服务器公钥到Mac ~/.ssh/authorized_keys。 添加你的Mac公钥到服务器 ~/.ssh/authorized_keys。

在你的Linux服务器中安装rsync，并开启SSH服务。

其它

在CentOS8中默认安装了podman，安装Docker会出现报错，请参考《CentOS8卸载podman安装docker》。