Getting Started with Electron Updater

이 가이드는 @capgo/electron-updater Electron 애플리케이션에서

팁

Capgo과 Capacitor을 이미 사용하고 계신가요? Electron Updater는 Capgo Cloud 백엔드와 동일한 것을 사용하기 때문에 모바일과 데스크톱 앱을 동일한 대시보드에서 관리할 수 있습니다.

사전 요구 사항

• Electron 20.0.0 이상
• Node.js 18 이상
• Capgo 계정 ( capgo.app)

설치

Capgo AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

그런 다음 다음 명령어를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/electron-updater` plugin in my project.

만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

1. 패키지를 설치하세요:

   bun add @capgo/electron-updater

2. Capgo 대시보드에서 앱 ID를 가져오세요. 아직 앱을 만들지 않았다면 다음 명령어를 실행하세요:

   npx @capgo/cli@latest init

설정

Electron Updater는 세 가지 장소에서 설정이 필요합니다: 메인 프로세스, 로드 전 처리 스크립트, 렌더러 프로세스.

메인 프로세스

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();
  }
});

로드 전 처리 스크립트

preload.ts

import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';

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

렌더러 프로세스

// 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());

주의

앱이 시작된 후 10초 이내 (설정 가능) 업데이터가 업데이트 실패로 간주하고 이전 버전으로 롤백합니다. 업데이트 확인 notifyAppReady() Checking for Updates appReadyTimeout업데이터가 자동으로 업데이트 확인을 합니다. 또한 수동 확인을 트리거할 수 있습니다.

Copy to clipboard

must autoUpdate: truecall

// 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 });
}

이벤트를 듣기

이벤트를 통해 업데이트 진행 상황과 상태를 추적하세요.

// 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);
});

업데이트 배포

Capgo CLI를 사용하여 업데이트를 업로드하세요.

# Build your app
npm run build

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

다음 체크 시 Electron 앱은 자동으로 새로운 번들을 다운로드하고 감지할 것입니다.

디버그 메뉴

개발 중에 디버그 메뉴를 활성화하십시오:

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

Press Ctrl+Shift+D (또는 Cmd+Shift+D Mac에서 사용하는 경우) 디버그 메뉴를 열고:

• 현재 번들 정보를 확인하십시오
• 사용 가능한 번들을-switch
• builtin 버전으로 리셋
• 디바이스 및 채널 정보를 확인하십시오

설정 옵션

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)
});

다음 단계

• API 참조 - 모든 사용 가능한 메서드를 탐색하십시오
• 채널 - 배포 채널에 대한 정보를 학습하십시오
• 롤백 - 롤백 보호를 이해하십시오

Getting Started with Electron Updater에서 계속

__CAPGO_KEEP_0__ 참조 Getting Started with Electron Updater를 사용 중이라면 자연 플러그인 작업을 계획하기 위해 연결하세요. Using @capgo/electron-updater Using @capgo/electron-updater Capgo 플러그인 디렉토리 Capgo 플러그인 디렉토리 Capacitor 플러그인들에 의해 Capgo Capacitor 플러그인들에 의해 Capgo 플러그인 추가 또는 업데이트 플러그인 추가 또는 업데이트 아이오닉 엔터프라이즈 플러그인 대안 아이오닉 엔터프라이즈 플러그인 대안