How to set up self-hosted updates with Capacitor Updater?

Configure the plugin with autoUpdate: false in capacitor.config.json, then use the API to manually download and set bundles from custom URLs. The README provides code examples for handling downloads and updates with app state changes, ensuring you control the entire process.

Capacitor Updater vs Ionic Appflow: which is better for my app?

Capacitor Updater is open-source and allows self-hosting for full control and cost savings, while Ionic Appflow is a paid, managed service with more integrated features. Choose Updater if you prefer customization and own infrastructure; opt for Appflow if you want a hassle-free, supported solution.

Does Capacitor Updater work with iOS App Store guidelines?

Yes, the README explicitly cites Apple's guidelines allowing interpreted code updates as long as they don't change the app's primary purpose. It's designed for compliance, but avoid forced updates to stay within store rules, as noted in the documentation.

How to test updates locally before deploying to production?

Use the local testing configuration options like localHost and localApi in the plugin config to simulate update servers. This lets you verify updates in a controlled environment without affecting live users, as detailed in the config settings.

What security features does Capacitor Updater have?

It includes encryption and signing for updates using public keys, ensuring secure downloads. The README mentions security standards and compliance, but self-hosting requires you to manage your own security infrastructure for end-to-end protection.

Can I use Capacitor Updater with an existing Cordova app?

No, it's specifically built for Capacitor apps. If you're on Cordova, you'd need to migrate to Capacitor first or use alternatives like Microsoft CodePush, which is designed for Cordova and React Native.

How to handle failed updates that don't rollback automatically?

The plugin's autoDeleteFailed and rollback mechanisms should handle this, but you can manually check bundle status and use setBundleError if enabled. Monitor logs and use the shake menu debug feature in development to troubleshoot issues.

Open-Awesome

Updater

MPL-2.0Java8.50.1

A Capacitor plugin for instant over-the-air updates of web assets, bypassing app store reviews.

Visit Website GitHub

791 stars153 forks0 contributors

What is Updater?

Capacitor Updater is a plugin for Capacitor apps that enables instant over-the-air updates of web assets like JavaScript, HTML, and CSS. It allows developers to deploy bug fixes, new features, and changes directly to users without going through app store review processes, which can take days or weeks. The plugin ensures updates are fast, reliable, and can be rolled back automatically if issues arise.

Target Audience

Mobile developers using Capacitor for building cross-platform iOS and Android apps who need to update their app's web content quickly and frequently. It's ideal for teams that want to avoid app store delays for critical fixes or perform A/B testing.

Value Proposition

Developers choose Capacitor Updater because it's the most starred Capacitor plugin on GitHub, offers both cloud and self-hosted options, and provides delta updates for speed. It's fully open-source, battle-tested in thousands of apps, and compliant with store guidelines, giving teams control and flexibility.

Overview

Capacitor plugin for Instant updates: Ship updates, fixes, changes, and features within minutes

Use Cases

Best For

Deploying critical bug fixes to users without waiting for app store approval
Performing A/B testing of new features or UI changes in a live app
Managing different release channels (e.g., staging, production, beta) for targeted updates
Self-hosting your own update infrastructure for full control and data privacy
Reducing update size and time with delta updates that only transfer changed files
Ensuring app stability with automatic rollback to a working version if an update fails

Not Ideal For

Apps requiring frequent updates to native iOS or Android code, as the plugin only handles web asset updates.
Teams using alternative hybrid frameworks like Cordova or React Native without Capacitor integration.
Projects where app store review delays are acceptable and OTA update infrastructure overhead isn't justified, such as those with long release cycles.
Organizations with strict internal security policies that prohibit any third-party update services, even with self-hosting options, due to compliance concerns.

Pros & Cons

Pros

Bypass App Store Delays

Allows instant deployment of JavaScript, HTML, and CSS updates without waiting for store reviews, directly addressing the core pain point of delayed bug fixes as stated in the README.

Efficient Delta Updates

Downloads only changed files, reducing bandwidth and update time significantly, which is a highlighted feature for speed and efficiency.

Automatic Rollback Safety

Automatically reverts to the last working version if an update fails, ensuring app stability and preventing crashes, as emphasized in the rollback protection feature.

Flexible Channel Management

Supports multiple environments like staging and production, enabling targeted updates and A/B testing, with options to assign specific devices or user groups.

Self-Hosting Option

Can be fully self-hosted on your own servers, providing complete control over data and infrastructure, as noted in the open-source backend support.

Cons

No Native Code Updates

Limited to web assets only; any changes to native Capacitor plugins or core app functionality still require app store submissions, reducing its usefulness for full app overhauls.

Complex Configuration

Numerous plugin options like appReadyTimeout, directUpdate modes, and various URLs require careful setup and can be error-prone, as seen in the lengthy config documentation.

Migration Overhead

Frequent major version updates that follow Capacitor releases (e.g., v7 to v8) come with migration guides and potential breaking changes, adding maintenance burden.

Ecosystem Dependency

Tied directly to the Capacitor ecosystem; if Capacitor falls out of favor or has compatibility issues, the plugin's utility is immediately impacted, creating vendor lock-in.

Open Source Alternative To

Updater is an open-source alternative to the following products:

Codepush

CodePush is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to users' devices.

Appflow

Appflow is a mobile DevOps platform by Ionic for building, deploying, and updating cross-platform mobile apps with live updates and CI/CD automation.

Frequently Asked Questions

Related Projects

Social Login

Capacitor plugin to make login with Google,Apple,Facebook and so on, simple and fast to implement

Stars213

Forks49

Last commit9 days ago

In App Browser

Capacitor plugin in app browser with urlChangeEvent

Stars127

Forks101

Last commit2 days ago

Data Storage SQLite

Capacitor Plugin for Data Storage SQLite for IOS and Android

Stars103

Forks19

Last commit3 days ago

Native Biometric

Secure biometric authentication for Capacitor with Face ID, Touch ID, and Android biometrics.

Stars77

Forks24

Last commit12 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub