Getting Started

설치

플러그인을 설치하기 위해 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/capacitor-updater` plugin in my project.

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

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

빠른 시작

대부분의 사용자에게는 __CAPGO_KEEP_0__ main Quickstart guide which covers both the plugin installation and Capgo cloud integration.

이 시작 가이드는 __CAPGO_KEEP_0__

main Quickstart 가이드

The Capacitor Updater plugin enables over-the-air (OTA) updates for your Capacitor applications. This allows you to push updates to your app without going through app store reviews.

개요

1. __CAPGO_KEEP_0__ 업데이터 플러그인은 __CAPGO_KEEP_1__ 애플리케이션에 대한 __CAPGO_KEEP_2__ 업데이트를 지원합니다. 이 기능은 앱 스토어 리뷰를 거치지 않고 앱에 업데이트를 푸시할 수 있게 해줍니다. : 업데이트 패키지를 다운로드합니다 (ZIP 파일에 웹 자산이 포함되어 있습니다)
2. 추출: 패키지는 장치의 저장소에 추출됩니다
3. Hot Reload: 앱은 재시작 없이 새로운 패키지로 Switch합니다
4. Fallback: 업데이트가 실패하면 이전에 작동하던 버전으로 돌아갑니다

사용 모드

1. 자동 업데이트 모드 (권장)

자동 업데이트를 위한 가장 간단한 방법입니다

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Plugin handles everything automatically
// Configure in capacitor.config.ts

__CAPGO_KEEP_0__의 추가 capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. 수동 모드

업데이트 프로세스에 대한 고급 제어를 위해:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

플랫폼 구성

iOS

추가 구성이 필요하지 않습니다. 플러그인은 BOX에서 작동합니다.

안드로이드

추가 설정이 필요하지 않습니다. 플러그인은 box에서 작동합니다.

API 기본 사용

업데이트 다운로드

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

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

활성 배포본 설정

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

새로운 배포본으로 다시 로드

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

패키지 목록

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

패키지 삭제

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

현재 패키지 가져오기

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

이벤트 리스너

업데이트 이벤트를 듣기:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

설정 옵션

플러그인을 자신의 capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: 'atBackground',
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

통합 패턴

With Capgo Cloud

__CAPGO_KEEP_0__

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

See the 기본적인 Quickstart 가이드 자세한 내용은 여기서

Self-Hosted Updates

자체 호스팅 업데이트 서버를 호스팅하세요:

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Your server should return:

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

See Self-Hosted Mode 전체 세부 정보를 참조하세요.

수동 업데이트 흐름

업데이트에 대한 완전한 제어:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

최선의 관행

• 프로덕션으로 푸시하기 전에 업데이트 테스트를 철저히 하세요. notifyAppReady() 네트워크 실패 시 적절한 오류 처리를 구현하세요.
• 버전 번호를 일관되게 사용하세요.
• __CAPGO_KEEP_0__
• __CAPGO_KEEP_0__
• 다운로드 속도 향상을 위해 패키지 크기를 작게 유지하세요.
• 업데이트 성공률을 모니터링하세요.

다음 단계

• Plugin API Reference API 문서
• __CAPGO_KEEP_0__ 설정 이벤트
• 자체 호스팅 모드 자체 호스팅 모드
• 자체 호스팅 모드 자체 호스팅 모드
• 개발 환경 - 로컬 업데이트 테스트
• 디버깅 - 문제 해결 가이드

지원

• 지원 알려진 문제
• GitHub Discussions __CAPGO_KEEP_0__ 토론
• - 커뮤니티 지원 디스코드 (Discord) - 실시간 채팅

다음 단계로

Capgo를 사용하여 Getting Started Capgo를 사용하여 Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, 플러그인 추가 또는 업데이트 구현 세부 정보에 대한 추가 또는 업데이트 플러그인에 대해 참조하십시오. 아이온틱 엔터프라이즈 플러그인 대체 아이온틱 엔터프라이즈 플러그인 워크플로에 대한 참조하십시오.