Settings

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

Tip

Any changes to these settings in capacitor.config file, require syncing the platform and releasing to the store for production apps to receive them.

allowModifyUrl

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

Available on Android, iOS, and Electron.

Default: false

capacitor.config.json

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

appId

Configure the app id for the app in the config.

Available on Android, iOS, and Electron.

Default: undefined

capacitor.config.json

{
  "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)

capacitor.config.json

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

autoDeleteFailed

Configure whether the plugin should automatically delete failed bundles.

Available on Android, iOS, and Electron.

Default: true

capacitor.config.json

{
  "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

capacitor.config.json

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

autoSplashscreen

Automatically handle splashscreen hiding when using instant apply modes. 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 autoUpdate is set to "atInstall", "onLaunch", or "always". Legacy directUpdate values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

Available on Android, iOS, and Electron.

Default: false

capacitor.config.json

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

autoUpdate

Configure how the plugin should use Auto Update via an update server. Boolean values are still supported for backward compatibility: true is the same as "atBackground" and false is the same as "off".

Options:

• "off" or false: Disable Auto Update
• "atBackground" or true: Check and download automatically, then apply when the app moves to the background
• "atInstall": Apply immediately only after a fresh install or native app update, otherwise use "atBackground"
• "onLaunch": Apply immediately on launch, otherwise use "atBackground" after the launch check
• "always": Apply immediately whenever Auto Update runs
• "onlyDownload": Check and download automatically, emit updateAvailable, and never set the next bundle automatically

Available on Android, iOS, and Electron.

Default: "atBackground" (true is still accepted)

capacitor.config.json

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

channelUrl

Configure the URL / endpoint for channel operations.

Available on Android, iOS, and Electron.

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

capacitor.config.json

{
  "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

capacitor.config.json

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

directUpdate

Deprecated. Use autoUpdate string modes instead: "atInstall", "onLaunch", or "always". This option remains supported for existing apps.

Options:

• false: Never do direct updates
• 'atInstall': Same as autoUpdate: "atInstall"
• 'onLaunch': Same as autoUpdate: "onLaunch"
• 'always': Same as autoUpdate: "always"
• true: (deprecated) Same as “always” for backward compatibility

Available on Android, iOS, and Electron.

Default: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "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

capacitor.config.json

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

keepUrlPathAfterReload

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

Caution

When a reload is triggered, ‘window.history’ will be cleared.

Available on Android, iOS, and Electron.

Default: false

capacitor.config.json

{
  "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)

capacitor.config.json

{
  "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

capacitor.config.json

{
  "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

capacitor.config.json

{
  "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)

capacitor.config.json

{
  "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

capacitor.config.json

{
  "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

capacitor.config.json

{
  "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

capacitor.config.json

{
  "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

capacitor.config.json

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

Development Settings

localApi

Configure the CLI to use a local api for testing.

Default: undefined

capacitor.config.json

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

localApiFiles

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

Default: undefined

capacitor.config.json

{
  "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

capacitor.config.json

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

localSupa

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

Default: undefined

capacitor.config.json

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

localSupaAnon

Configure the CLI to use a local server for testing.

Default: undefined

capacitor.config.json

{
  "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

capacitor.config.json

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

Tip

There are additional settings available in the Capgo web app that can be configured per channel without requiring a native app release.