본문 바로가기

설정

GitHub

업데이트 시스템을 더 세밀하게 제어하려면 다음 설정을 구성할 수 있습니다:

자체 호스트네임을 사용하려면 updateUrl, statsUrl, 그리고 channelUrl, 다음을 참고하세요 Custom Domain 설정.

JavaScript 측에서 updateUrl, statsUrl, channelUrl을 동적으로 수정할 수 있도록 허용합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"allowModifyUrl": true
}
}
}

설정 파일에서 앱의 ID를 구성합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appId": "com.example.app"
}
}
}

업데이트를 '실패'로 간주하기 전, 네이티브 플러그인이 대기할 밀리초(ms)를 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: 10000 (10초)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appReadyTimeout": 1000
}
}
}

플러그인이 실패한 번들을 자동으로 삭제할지 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeleteFailed": false
}
}
}

플러그인이 업데이트 성공 후 이전 번들을 자동으로 삭제할지 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeletePrevious": false
}
}
}

즉시 적용 모드 사용 시 필수 ("atInstall", "onLaunch", 또는 "always"), 지원 중단된 directUpdate 값도 포함됩니다. 설치하세요 @capacitor/splash-screen 그리고 설정하세요. launchAutoHide: false. 활성화하면 업데이트가 적용되거나 업데이트가 필요 없는 경우 플러그인이 자동으로 스플래시 화면을 숨깁니다. 이를 통해 appReady 이벤트를 직접 리스닝하고 SplashScreen.hide()를 호출할 필요가 없습니다.

Android 및 iOS에서 사용 가능합니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall",
"autoSplashscreen": true
},
"SplashScreen": {
"launchAutoHide": false
}
}
}

플러그인이 Live Update를 확인, 다운로드 및 적용하는 방식을 설정합니다. 플러그인은 앱이 포그라운드로 전환될 때와 앱이 열려 있는 동안 설정된 타이머 간격에 따라 업데이트를 확인합니다. periodCheckDelay 타이머 간격을 제어합니다. 하위 호환성을 위해 Boolean 값도 지원합니다: true 와(과) 동일합니다 "atBackground" 및 false 와(과) 동일합니다 "off". String 값을 사용하면 이전의 Auto Update 및 Direct Update 설정이 병합됩니다.

옵션:

  • "off" 또는 false: 자동 업데이트 확인 비활성화
  • "atBackground" 또는 true: 포그라운드 확인 시마다 자동으로 확인 및 다운로드한 후, 앱이 백그라운드로 전환될 때 업데이트를 적용
  • "atInstall": 앱을 새로 설치하거나 앱 스토어에서 Native Build 업데이트를 한 직후에만 즉시 적용합니다. 그 외에는 "atBackground" 동작을 사용합니다
  • "onLaunch": 앱이 종료된 상태에서 포그라운드로 전환될 때(Cold Start)만 즉시 적용합니다. 첫 확인 이후에는 "atBackground" 동작을 사용합니다
  • "always": 포그라운드 전환 시마다 확인하며, 업데이트가 있으면 즉시 적용합니다
  • "onlyDownload": 자동으로 확인 및 다운로드하고, updateAvailable 이벤트를 발생시키지만, 다음 번들을 설정하거나 업데이트를 자동으로 적용하지는 않습니다

즉시 적용 모드 (""atInstall", "onLaunch", "always"")는 사용자가 대기하는 동안 적용됩니다. npx @capgo/cli@latest bundle upload --delta 를 사용하여 업로드하면 변경된 파일만 다운로드하므로 속도가 빠릅니다. 전체 zip 파일을 업로드하면 사용자 경험이 저하됩니다. Android 및 iOS에서 이 모드를 사용하려면 autoSplashscreen: true 및 @capacitor/splash-screen 포함 launchAutoHide: false.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: "atBackground" (true 여전히 허용됩니다)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "onlyDownload"
}
}
}

채널 작업을 위한 URL 또는 엔드포인트를 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: https://plugin.capgo.app/channel_self

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"channelUrl": "https://example.com/api/channel"
}
}
}

설정 파일에서 앱의 기본 채널을 지정합니다. 대소문자를 구분합니다. 이 설정은 클라우드에 설정된 기본 채널보다 우선하지만, 클라우드에서 개별적으로 설정한 오버라이드는 그대로 적용됩니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"defaultChannel": "production"
}
}
}

사용 중단 예정. 다음을 사용하세요: autoUpdate 문자열 모드: "atInstall", "onLaunch", 또는 "always". 이 옵션은 기존 앱에 대해 계속 지원됩니다. Instant apply는 다음을 통해 upload해야 합니다: --delta 업데이트가 사용자 경험을 저해하지 않도록 하기 위함입니다. 이 모드에는 다음이 필요합니다: autoSplashscreen: true 및 @capacitor/splash-screen 포함 launchAutoHide: false.

옵션:

  • false: 직접 업데이트를 수행하지 마세요
  • 'atInstall': 동일함 autoUpdate: "atInstall"
  • 'onLaunch': 동일함 autoUpdate: "onLaunch"
  • 'always': 동일함 autoUpdate: "always"
  • true: (deprecated) 동일함 "always" 하위 호환성을 위해

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall"
}
}
}

플러그인의 JavaScript 로깅을 비활성화합니다. true로 설정하면 플러그인이 JavaScript 콘솔에 로그를 남기지 않으며, 네이티브 로그만 기록됩니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"disableJSLogging": true
}
}
}

새로고침 후에도 URL 경로를 유지하도록 플러그인을 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"keepUrlPathAfterReload": true
}
}
}

주기적인 업데이트 확인 지연 시간을 설정합니다. 단위는 초(seconds)입니다. 600초(10분) 미만으로 설정할 수 없습니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: 600 (10분)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"periodCheckDelay": 600 // (10 minutes)
}
}
}

Version 2 live update 종단간 암호화를 위한 공개 키를 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"publicKey": "YOUR_PUBLIC_KEY"
}
}
}

기기에 더 새로운 Native Build 번들이 설치되면 이전에 다운로드한 번들을 자동으로 삭제합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"resetWhenUpdate": false
}
}
}

네이티브 플러그인이 API 타임아웃으로 판단하기 전까지 대기할 밀리초(ms)를 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: 20 (20초)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"responseTimeout": 10 // (10 seconds)
}
}
}

디버깅 및 테스트를 위해 흔들기 제스처로 업데이트 메뉴를 표시하도록 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"shakeMenu": true
}
}
}

업데이트 통계가 전송될 URL 또는 엔드포인트를 설정합니다.

Available on Android, iOS, and Electron. Set to "" to disable explicit stats reporting through /stats.

비활성화 statsUrl 하더라도 모든 Capgo 디바이스 스토리지가 삭제되지는 않습니다. 만약 updateUrl 활성화된 상태로 /updates 유지된다면, 업데이트 제공 및 MAU 집계에 필요한 결제 MAU 행, 디바이스 인벤토리, 업데이트 결정 이벤트 데이터는 여전히 저장됩니다. 자세한 내용은 컴플라이언스 에서 필드별 상세 내역을 확인하세요.

기본값: https://plugin.capgo.app/stats

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"statsUrl": "https://example.com/api/stats"
}
}
}

업데이트 확인 요청을 보낼 URL 또는 엔드포인트를 설정합니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: https://plugin.capgo.app/updates

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"updateUrl": "https://example.com/api/auto_update"
}
}
}

앱의 현재 버전을 설정합니다. 이 버전은 첫 번째 업데이트 요청 시 사용됩니다. 설정하지 않으면 플러그인이 네이티브 code에서 버전을 가져옵니다.

Android, iOS, Electron에서 사용할 수 있습니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"version": "1.0.0"
}
}
}

테스트를 위해 CLI가 로컬 api를 사용하도록 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApi": "http://localhost:54321/functions/v1"
}
}
}

테스트를 위해 CLI가 로컬 파일 api를 사용하도록 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApiFiles": "http://localhost:54321/functions/v1/files"
}
}
}

테스트용 로컬 서버 또는 자체 호스팅 업데이트 서버를 사용하도록 CLI를 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localHost": "http://localhost:5173"
}
}
}

테스트용 로컬 서버 또는 자체 호스팅 업데이트 서버를 사용하도록 CLI를 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupa": "http://localhost:54321"
}
}
}

테스트를 위해 로컬 서버를 사용하도록 CLI를 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupaAnon": "YOUR_LOCAL_ANON_KEY"
}
}
}

테스트용 로컬 서버 또는 자체 호스팅 업데이트 서버를 사용하도록 CLI를 설정합니다.

기본값: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localWebHost": "http://localhost:5173"
}
}
}

사용 중이라면 설정 대시보드 및 API 운영을 계획하려면, 이를 다음과 연결하세요 @capgo/capacitor-updater 사용하기 네이티브 기능의 경우 @capgo/capacitor-updater 사용하기에서, API 개요 구현 세부 사항은 API 개요에서 소개 구현 세부 사항은 소개에서 API 키 API Keys의 구현 세부 사항은, 기기 Devices의 구현 세부 사항은.