Settings

Ce contenu n'est pas encore disponible dans votre langue.

To have more fine-grained control over the update system, you can configure it with these settings:

`allowModifyUrl`

Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.

Available on Android, iOS, and Electron.

Default: false

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

`appId`

Configure the app id for the app in the config.

Available on Android, iOS, and Electron.

Default: undefined

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

`appReadyTimeout`

Configure the number of milliseconds the native plugin should wait before considering an update ‘failed’.

Available on Android, iOS, and Electron.

Default: 10000 (10 seconds)

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

`autoDeleteFailed`

Configure whether the plugin should automatically delete failed bundles.

Available on Android, iOS, and Electron.

Default: true

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

`autoDeletePrevious`

Configure whether the plugin should automatically delete previous bundles after a successful update.

Available on Android, iOS, and Electron.

Default: true

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

`autoSplashscreen`

Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed. This removes the need to manually listen for appReady events and call SplashScreen.hide(). Only works when directUpdate is set to “atInstall”, “always”, or true. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires autoUpdate and directUpdate to be enabled.

Available on Android, iOS, and Electron.

Default: false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

`autoUpdate`

Configure whether the plugin should use Auto Update via an update server.

Available on Android, iOS, and Electron.

Default: true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

`channelUrl`

Configure the URL / endpoint for channel operations.

Available on Android, iOS, and Electron.

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

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

`defaultChannel`

Set the default channel for the app in the config. Case sensitive. This setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.

Available on Android, iOS, and Electron.

Default: undefined

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

`directUpdate`

Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using the —delta flag. Zip or apps more than 10MB will be relatively slow for users to update.

Options:

false: Never do direct updates (use default behavior: download at start, set when backgrounded)
'atInstall': Direct update only when app is installed, updated from store, otherwise act as directUpdate = false
'onLaunch': Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false
'always': Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false
true: (deprecated) Same as “always” for backward compatibility

Available on Android, iOS, and Electron.

Default: false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall"
    }
  }
}

`disableJSLogging`

Disable the JavaScript logging of the plugin. If true, the plugin will not log to the JavaScript console. Only the native log will be done.

Available on Android, iOS, and Electron.

Default: false

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

`keepUrlPathAfterReload`

Configure the plugin to keep the URL path after a reload.

Available on Android, iOS, and Electron.

Default: false

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

`periodCheckDelay`

Configure the delay period for period update check. The unit is in seconds. Cannot be less than 600 seconds (10 minutes).

Available on Android, iOS, and Electron.

Default: 600 (10 minutes)

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

`publicKey`

Configure the public key for end to end live update encryption Version 2.

Available on Android, iOS, and Electron.

Default: undefined

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

`resetWhenUpdate`

Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.

Available on Android, iOS, and Electron.

Default: true

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

`responseTimeout`

Configure the number of milliseconds the native plugin should wait before considering API timeout.

Available on Android, iOS, and Electron.

Default: 20 (20 seconds)

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

`shakeMenu`

Enable shake gesture to show update menu for debugging/testing purposes.

Available on Android, iOS, and Electron.

Default: false

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

`statsUrl`

Configure the URL / endpoint to which update statistics are sent.

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

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

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

`updateUrl`

Configure the URL / endpoint to which update checks are sent.

Available on Android, iOS, and Electron.

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

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

`version`

Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code.

Available on Android, iOS, and Electron.

Default: undefined

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

Development Settings

`localApi`

Configure the CLI to use a local api for testing.

Default: undefined

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

`localApiFiles`

Configure the CLI to use a local file api for testing.

Default: undefined

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

`localHost`

Configure the CLI to use a local server for testing or self-hosted update server.

Default: undefined

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

`localSupa`

Configure the CLI to use a local server for testing or self-hosted update server.

Default: undefined

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

`localSupaAnon`

Configure the CLI to use a local server for testing.

Default: undefined

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

`localWebHost`

Configure the CLI to use a local server for testing or self-hosted update server.

Default: undefined

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