跳转到内容
Capgo - Live Updates for Capacitor Apps Capgo

Electron 更新器入门

本指南将引导您在 Electron 应用程序中设置 @capgo/electron-updater 以启用实时 JavaScript/HTML/CSS 更新。

先决条件

Section titled “先决条件”
  • Electron 20.0.0 或更高版本
  • Node.js 18 或更高
  • Capgo 帐户（在 capgo.app 上注册）

安装

Section titled “安装”

  1. 安装包：

    Terminal window
    npm install @capgo/electron-updater

  2. 从 Capgo 仪表板获取您的应用程序 ID。如果您尚未创建应用程序，请运行：

    Terminal window
    npx @capgo/cli@latest init

设置

Section titled “设置”

Electron Updater 需要在三个地方进行设置：主进程、预加载脚本和渲染器进程。

主要流程

Section titled “主要流程”
main.ts
import { app, BrowserWindow } from 'electron';
import * as path from 'path';
import {
  ElectronUpdater,
  setupIPCHandlers,
  setupEventForwarding,
} from '@capgo/electron-updater';


// Create updater instance with your Capgo App ID
const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID', // e.g., 'com.example.myapp'
  autoUpdate: true,
});


app.whenReady().then(async () => {
  const mainWindow = new BrowserWindow({
    width: 1200,
    height: 800,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
    },
  });


  // Initialize updater with window and builtin path
  const builtinPath = path.join(__dirname, 'www/index.html');
  await updater.initialize(mainWindow, builtinPath);


  // Setup IPC communication between main and renderer
  setupIPCHandlers(updater);
  setupEventForwarding(updater, mainWindow);


  // Load the current bundle (either builtin or downloaded update)
  await mainWindow.loadFile(updater.getCurrentBundlePath());
});


app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

预加载脚本

Section titled “预加载脚本”
preload.ts
import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';


// Expose the updater API to the renderer process
exposeUpdaterAPI();

渲染器进程

Section titled “渲染器进程”
// renderer.ts (or in your app's entry point)
import { requireUpdater } from '@capgo/electron-updater/renderer';


const updater = requireUpdater();


// CRITICAL: Call this on every app launch!
// This confirms the bundle loaded successfully and prevents rollback
await updater.notifyAppReady();


console.log('App ready, current bundle:', await updater.current());

检查更新

Section titled “检查更新”

使用 autoUpdate: true，更新程序会自动检查更新。您还可以触发手动检查：

// Check for updates manually
const latest = await updater.getLatest();


if (latest.url && !latest.error) {
  console.log('Update available:', latest.version);


  // Download the update
  const bundle = await updater.download({
    url: latest.url,
    version: latest.version,
    checksum: latest.checksum,
  });


  console.log('Downloaded bundle:', bundle.id);


  // Option 1: Queue for next restart
  await updater.next({ id: bundle.id });


  // Option 2: Apply immediately and reload
  // await updater.set({ id: bundle.id });
}

监听事件

Section titled “监听事件”

通过事件跟踪更新进度和状态：

// Download progress
updater.addListener('download', (event) => {
  console.log(`Download progress: ${event.percent}%`);
});


// Update available
updater.addListener('updateAvailable', (event) => {
  console.log('New version available:', event.bundle.version);
});


// Download completed
updater.addListener('downloadComplete', (event) => {
  console.log('Download finished:', event.bundle.id);
});


// Update failed
updater.addListener('updateFailed', (event) => {
  console.error('Update failed:', event.bundle.version);
});

部署更新

Section titled “部署更新”

使用 Capgo CLI 上传更新：

Terminal window
# Build your app
npm run build


# Upload to Capgo
npx @capgo/cli@latest bundle upload --channel=production

您的 Electron 应用程序将在下次检查时自动检测并下载新包。

调试菜单

Section titled “调试菜单”

在开发过程中启用调试菜单：

const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID',
  debugMenu: true, // Enable debug menu
});

按“Ctrl+Shift+D”（或 Mac 上的“Cmd+Shift+D”）打开调试菜单，然后：

  • 查看当前捆绑包信息
  • 在可用捆绑包之间切换
  • 重置为内置版本
  • 查看设备和频道信息

配置选项

Section titled “配置选项”
const updater = new ElectronUpdater({
  // Required
  appId: 'com.example.app',


  // Server URLs (defaults to Capgo Cloud)
  updateUrl: 'https://plugin.capgo.app/updates',
  channelUrl: 'https://plugin.capgo.app/channel_self',
  statsUrl: 'https://plugin.capgo.app/stats',


  // Behavior
  autoUpdate: true,           // Enable auto-updates
  appReadyTimeout: 10000,     // MS before rollback (default: 10s)
  autoDeleteFailed: true,     // Delete failed bundles
  autoDeletePrevious: true,   // Delete old bundles after successful update


  // Channels
  defaultChannel: 'production',


  // Security
  publicKey: '...',           // For end-to-end encryption


  // Debug
  debugMenu: false,           // Enable debug menu
  disableJSLogging: false,    // Disable console logs


  // Periodic Updates
  periodCheckDelay: 0,        // Seconds between checks (0 = disabled, min 600)
});

后续步骤

Section titled “后续步骤”