Lompat ke Konten

Auto Update

GitHub

Dokumentasi ini akan menjelaskan cara menjalankan server auto-update Anda.

Pastikan bundel Anda disajikan melalui HTTPS, dan server memiliki header CORS yang tepat untuk memungkinkan aplikasi mengunduh update. e.g. https://myserver.com/app/updates/updates.json

Jika Anda tidak familiar dengan penyajian bundel, kami merekomendasikan Anda mencoba Capgo Cloud atau melihat contoh di sini:

Tambahkan updateUrl ke aplikasi capacitor.config.json.

{
"plugins": {
"CapacitorUpdater": {
"updateUrl": "https://myserver.com/app/updates/updates.json",
}
}
}

Plugin akan melakukan panggilan POST ke API Anda setiap kali aplikasi dibuka, dengan tubuh ini:

interface AppInfos {
"platform": "ios" | "android" | "electron",
"device_id": "UUID_of_device_unique_by_install",
"app_id": "APPID_FROM_CAPACITOR_CONFIG",
"custom_id": "your_custom_id_set_on_runtime",
"plugin_version": "PLUGIN_VERSION",
"version_build": "VERSION_NUMBER_FROM_NATIVE_CODE",
"version_code": "VERSION_CODE_FROM_NATIVE_CODE",
"version_name": "LAST_DOWNLOADER_VERSION" | "builtin"
"version_os": "VERSION_OF_SYSTEM_OS",
"is_emulator": boolean,
"is_prod": boolean,
}

Server API harus memberikan respons dalam format JSON terhadap plugin pembarui capacitor.

{
"version": "1.2.3",
"url": "https://myserver.com/app/updates/my-new-app-2.0.0.zip",
"checksum": "sha256_checksum_of_bundle"
}

Pada mode pembarui otomatis, server harus membandingkan versi dan mengembalikan versi yang tepat, jika kunci URL ada, plugin akan memulai proses download.

Jika Anda menambahkan kunci ‘message’ dan ‘error’, versi tidak akan ditetapkan, dan pesan akan ditampilkan di log bukan versi.

version Kunci harus berada di semver format.

Arsip zip harus memiliki index.html sebagai file di root, atau hanya satu folder di root dengan index.html di dalamnya.

Anda dapat menggunakan perintah dari CLI untuk mengarsipkan bundle Anda:

Buatlah arsip dengan file-file yang akan Anda gunakan untuk disajikan dari server Anda
npx @capgo/cli bundle zip --path [/path/to/my/bundle]

Penting: Wajib menggunakan Capgo CLI untuk membuat file zip arsip Anda. Plugin Capgo memerlukan format dan struktur zip tertentu yang hanya dapat dipastikan ketika menggunakan alat resmi CLI. Utilitas zip standar mungkin menciptakan arsip yang tidak kompatibel.

Membuat ceksum untuk arsip Anda, gunakan Capgo CLI zip command dengan --json Pilihan:

Membuat arsip dengan informasi ceksum
npx @capgo/cli bundle zip [appId] --json

Perintah ini akan:

  • Membuat file zip yang sesuai dengan plugin Capgo
  • Membuat ceksum SHA256 untuk verifikasi integritas
  • Mengeluarkan informasi arsip dalam format JSON

Contoh output:

{
"version": "1.2.3",
"checksum": "a1b2c3d4e5f6789...",
"size": 1234567
}

Gunakan nilai dari output ini dalam respons __CAPGO_KEEP_0__ Anda untuk memastikan integritas bundel sebelum instalasi. checksum value from this output in your API response to ensure the plugin can verify the bundle integrity before installation.

Judul bagian “Lanjutkan dari Auto Update”

Jika Anda menggunakan

Auto Update untuk merencanakan migrasi dan operasi bisnis, hubungkannya dengan Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater untuk kemampuan asli dalam Menggunakan @capgo/capacitor-updater, for the native capability in Using @capgo/capacitor-updater, Capgo Enterprise untuk alur kerja produk di Capgo Enterprise, Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic, Alternatif Capgo untuk alur kerja produk di Alternatif Capgo, dan Konsultasi Capgo untuk alur kerja produk di Konsultasi Capgo.