Settings

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

appReadyTimeout

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

Only available for Android and iOS.

Default: 10000 (10 seconds)

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

responseTimeout

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

Only available for Android and iOS.

Default: 20 (20 second)

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 1000
    }
  }
}

autoDeleteFailed

Configure whether the plugin should automatically delete failed bundles.

Only available for Android and iOS.

Default: true

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

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

Only available for Android and iOS.

Default: true

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoUpdate

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

Only available for Android and iOS.

Default: true

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

updateUrl

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

Only available for Android and iOS.

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

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/updates"
    }
  }
}

statsUrl

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

Only available for Android and iOS. Set to "" to disable stats reporting.

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

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

privateKey

Configure the private key for end-to-end live update encryption.

Only available for Android and iOS.

Create the private key with the command npx @capgo/cli key create

Default: undefined

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "privateKey": "YOUR_KEY"
    }
  }
}

directUpdate

Make the plugin directly install the update when the app what just updated/installed. Only applicable for autoUpdate mode.

Only available for Android and iOS.

Default: undefined

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": true
    }
  }
}

resetWhenUpdate

Note

When an store update happens, disable force reset to the native version

There are many more settings avaialble only on the web app

To configure the plugin, use these settings:

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "resetWhenUpdate": false
    }
  }
}

version

Send this version to the server to identify your version at the first download.

Caution

This setting disables the plugin to read the version in your native code. This is useful when you want to have a different version in your native code and in your JS code.

capacitor.config.json

{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.2.3"
    }
  }
}