Pengaturan

Untuk kontrol yang lebih terperinci atas sistem update, Anda bisa mengonfigurasinya dengan pengaturan berikut:

Tips

Setiap perubahan pada pengaturan ini di file capacitor.config memerlukan sinkronisasi platform dan rilis ke store agar aplikasi produksi dapat menerimanya.

Catatan

Butuh data residency EU untuk Capgo Cloud? Atur updateUrl ke https://plugin.eu.capgo.app/updates, statsUrl ke https://plugin.eu.capgo.app/stats, dan channelUrl ke https://plugin.eu.capgo.app/channel_self. Lihat Lokasi Data.

Untuk menggunakan hostname sendiri pada updateUrl, statsUrl, dan channelUrl, lihat Pengaturan Custom Domain.

allowModifyUrl

Izinkan plugin untuk memodifikasi updateUrl, statsUrl, dan channelUrl secara dinamis dari sisi JavaScript.

Tersedia di Android, iOS, dan Electron.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Konfigurasi app id untuk aplikasi di dalam config.

Tersedia di Android, iOS, dan Electron.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Konfigurasi jumlah milidetik yang harus ditunggu plugin native sebelum menganggap sebuah update 'gagal'.

Tersedia di Android, iOS, dan Electron.

Default: 10000 (10 detik)

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Konfigurasi apakah plugin harus menghapus bundle yang gagal secara otomatis.

Tersedia di Android, iOS, dan Electron.

Default: true

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Konfigurasi apakah plugin harus menghapus bundle sebelumnya secara otomatis setelah update berhasil.

Tersedia di Android, iOS, dan Electron.

Default: true

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Wajib digunakan saat memakai mode instant apply ("atInstall", "onLaunch", atau "always"), termasuk nilai yang sudah directUpdate deprecated. Install @capacitor/splash-screen dan atur launchAutoHide: false. Jika diaktifkan, plugin akan menyembunyikan splashscreen setelah update diterapkan atau saat tidak ada update yang diperlukan. Ini menghilangkan kebutuhan untuk mendengarkan event appReady secara manual dan memanggil SplashScreen.hide().

Tersedia di Android dan iOS.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

Konfigurasi cara plugin mengecek, mengunduh, dan menerapkan Live Update. Plugin mengecek update saat aplikasi masuk ke foreground dan melalui timer berulang selama aplikasi tetap terbuka. periodCheckDelay mengontrol interval timer tersebut. Nilai Boolean masih didukung untuk kompatibilitas ke belakang: true sama dengan "atBackground" dan false sama dengan "off". Nilai String akan menggabungkan konfigurasi Auto Update dan Direct Update sebelumnya.

Opsi:

• "off" atau false: Nonaktifkan pengecekan update otomatis
• "atBackground" atau true: Cek dan unduh otomatis pada setiap pengecekan foreground, lalu terapkan update saat aplikasi masuk ke background berikutnya
• "atInstall": Hanya terapkan segera setelah instalasi baru atau update native app store; jika tidak, gunakan "atBackground" perilaku
• "onLaunch": Hanya terapkan segera saat aplikasi dibuka dari kondisi mati (cold start). Setelah pengecekan pertama, gunakan "atBackground" perilaku
• "always": Cek setiap kali transisi ke foreground dan terapkan segera saat update tersedia
• "onlyDownload": Cek dan download otomatis, kirim updateAvailable, dan jangan pernah set bundle berikutnya atau terapkan update secara otomatis

Mode apply instan (""atInstall", "onLaunch", "always"") diterapkan saat user sedang menunggu. Upload dengan npx @capgo/cli@latest bundle upload --delta sehingga hanya file yang berubah yang didownload. Upload zip penuh memperlambat user experience. Di Android dan iOS, mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Tersedia di Android, iOS, dan Electron.

Default: "atBackground" (true masih diterima)

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

Konfigurasi URL / endpoint untuk operasi channel.

Tersedia di Android, iOS, dan Electron.

Default: https://plugin.capgo.app/channel_self

file capacitor.config.json,

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

defaultChannel

Atur channel default aplikasi di config. Case sensitive. Pengaturan ini akan menimpa channel default di cloud, namun tetap menghormati override yang dibuat di cloud.

Tersedia di Android, iOS, dan Electron.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Deprecated. Gunakan autoUpdate mode string sebagai gantinya: "atInstall", "onLaunch", atau "always". Opsi ini tetap didukung untuk aplikasi yang sudah ada. Instant apply harus di-upload dengan --delta agar update tidak memperlambat user experience. Mode ini memerlukan autoSplashscreen: true dan @capacitor/splash-screen dengan launchAutoHide: false.

Opsi:

• false: Jangan pernah update langsung
• 'atInstall': Sama dengan autoUpdate: "atInstall"
• 'onLaunch': Sama dengan autoUpdate: "onLaunch"
• 'always': Sama dengan autoUpdate: "always"
• true: (deprecated) Sama dengan "always" untuk kompatibilitas ke belakang

Tersedia di Android, iOS, dan Electron.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

Nonaktifkan logging JavaScript pada plugin. Jika true, plugin tidak akan mencatat log ke JavaScript console. Hanya native log yang akan berjalan.

Tersedia di Android, iOS, dan Electron.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Konfigurasi plugin agar tetap mempertahankan URL path setelah reload.

Peringatan

Saat reload dipicu, ‘window.history’ akan dihapus.

Tersedia di Android, iOS, dan Electron.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Konfigurasi jeda waktu untuk pengecekan update berkala. Satuannya dalam detik. Tidak boleh kurang dari 600 detik (10 menit).

Tersedia di Android, iOS, dan Electron.

Default: 600 (10 menit)

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Konfigurasi public key untuk enkripsi end-to-end live update Versi 2.

Tersedia di Android, iOS, dan Electron.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

Peringatan

publicKey mengonfigurasi Encryption V2 dan harus sesuai dengan private key yang digunakan saat upload. Untuk Delta updates, gunakan enkripsi V2 dengan partial encryption aktif, dan aktifkan encrypted-bundle enforcement jika organisasi Anda mewajibkan setiap upload terenkripsi. Jangan hanya mengandalkan publicKey sebagai kebijakan sisi server untuk mencegah Delta yang tidak terenkripsi dipublikasikan.

resetWhenUpdate

Hapus otomatis bundle yang sudah di-download sebelumnya saat native app bundle yang lebih baru diinstal ke perangkat.

Tersedia di Android, iOS, dan Electron.

Default: true

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Konfigurasi jumlah milidetik plugin native harus menunggu sebelum menganggap API timeout.

Tersedia di Android, iOS, dan Electron.

Default: 20 (20 detik)

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Aktifkan gesture shake untuk menampilkan menu update untuk keperluan debugging/testing.

Tersedia di Android, iOS, dan Electron.

Default: false

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Konfigurasi URL / endpoint untuk mengirim statistik update.

Tersedia di Android, iOS, dan Electron. Set ke "" untuk menonaktifkan pelaporan stats eksplisit melalui /stats.

Menonaktifkan statsUrl tidak menonaktifkan seluruh penyimpanan perangkat Capgo. Jika updateUrl tetap aktif, /updates masih menyimpan baris billing MAU, inventaris perangkat, dan data event update-decision yang diperlukan untuk menyajikan update dan menghitung MAU. Lihat Kepatuhan untuk rincian per field.

Default: https://plugin.capgo.app/stats

file capacitor.config.json,

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

updateUrl

Konfigurasi URL / endpoint untuk pengiriman pengecekan update.

Tersedia di Android, iOS, dan Electron.

Default: https://plugin.capgo.app/updates

file capacitor.config.json,

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

version

Konfigurasi versi aplikasi saat ini. Ini akan digunakan untuk request update pertama. Jika tidak diatur, plugin akan mengambil versi dari native code.

Tersedia di Android, iOS, dan Electron.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Pengaturan Development

localApi

Konfigurasi CLI untuk menggunakan api lokal saat testing.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Konfigurasi CLI untuk menggunakan file api lokal saat testing.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Konfigurasi CLI untuk menggunakan server lokal saat testing atau server update self-hosted.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Konfigurasi CLI untuk menggunakan server lokal saat testing atau server update self-hosted.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Konfigurasi CLI untuk menggunakan server lokal saat testing.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfigurasi CLI untuk menggunakan server lokal saat testing atau self-hosted update server.

Default: undefined

file capacitor.config.json,

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Tips

Tersedia pengaturan tambahan di dalam web app Capgo yang dapat dikonfigurasi per channel tanpa perlu rilis native app.

Lanjutkan dari Settings

Jika Anda menggunakan Pengaturan untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-updater untuk kemampuan native pada Menggunakan @capgo/capacitor-updater, Ikhtisar API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.