An easy-to-use, efficient, powerful tool to remote update your cordova app.
- Update any assets (js/css/images/etc.), synchronize your app with its latest version on the server with ease. (Don't have to resubmit it to Apple Store!)
- Efficient: Only takes less than 150B to check whether an update is available
- Intelligent: Able to calculate the size of the update, show the download progress, notify when the update is done successfully.
- Safe: downloads to temp directory first, then merges temp and www. Will not break the app.
- User-friendly: uses
splashscreen
to hide page reload from users.
-
Set up
CordovaAppUpdater
and all its dependencies -
Write some code to use
CordovaAppUpdater
window.CordovaAppUpdater = new CordovaAppUpdater({ server_url: 'http://114.215.159.185/update/', indexHtmlName: 'index.html' }); document.addEventListener('deviceready', function () { CordovaAppUpdater.switchToUpdatedVersion(); CordovaAppUpdater.init().then(function(){ CordovaAppUpdater.check().then(function (data) { if (data !== false) { CordovaAppUpdater.download().then(function () { CordovaAppUpdater.apply(); }) }); });
(Abbreviated version, for a full demo, see index.js)
-
Use
grunt genManifest
to generatemanifest.json
andmanifest.digest.json
-
Upload the whole
/www
folder to server -
When you've made modifications to the app, repeat step 3. and 4.
-
The app will check for update and update itself every time it is run.
-
In order for
CordovaAppUpdater
to work properly, you should add<meta http-equiv="Content-Security-Policy" content="default-src 'self' 'unsafe-inline' 'unsafe-eval' http: https: data: blob: filesystem: cdvfile: file: gap:;">
to
index.html
. -
You should also add
<access origin="*" /> <allow-navigation href="*://*/*"/>
to
config.xml
-
CordovaAppUpdater
useswindow.navigator.splashscreen.show();
andwindow.navigator.splashscreen.hide();
to hide page reload from user, in order for this feature to work properly, add<preference name="AutoHideSplashScreen" value="false" />
to
config.xml
-
Put a
.htaccess
in your www folder and configure Apache, so thatAccess-Control-Allow-Origin "*"
will be set.
- cordova-plugin-file
- cordova-plugin-file-transfer
- cordova-plugin-splashscreen
- cordova-plugin-whitelist
- grunt crypto path
- jQuery
- bluebird
git clone https://github.com/KevinWang15/cordova-app-updater.git
cd cordova-app-updater
cordova platform add android
cordova plugin add cordova-plugin-file
cordova plugin add cordova-plugin-file-transfer
cordova plugin add cordova-plugin-splashscreen
cordova plugin add cordova-plugin-whitelist
cordova run android
###CordovaAppUpdater.switchToUpdatedVersion();
Loads the newest, cached version of the app.
this function should be called right after 'deviceready'
Disable it in dev environment, or you will not be able to the modifications in real-time (You will have to upload changes to the server and update the app to see modifications, you wouldn't want the extra trouble, would you).
###CordovaAppUpdater.init();
this function should be called after 'deviceready'
Loads local manifest, prepares the file system, on first run, it also copies the bundled files to the cached directory.
###CordovaAppUpdater.check();
this function should be called after 'CordovaAppUpdater.init()'
Checks the server-side version for update, calculates list of changed files and the size of the update.
###CordovaAppUpdater.download();
this function should be called after 'CordovaAppUpdater.check()'
Downloads the update to the cached folder, and informs of the progress with CordovaAppUpdater.onProgress
callback.
###CordovaAppUpdater.apply();
this function should be called after 'CordovaAppUpdater.download()'
Apply the update (reloads the page).
###CordovaAppUpdater.updateSuccessful()
No parameters, you can use this callback to display a notification to the user.
###CordovaAppUpdater.onProgress(totalDownloaded, totalSize)
After invoking CordovaAppUpdater.download()
, this callback will inform you of the download progress.
delete localStorage['manifest'];
delete localStorage['manifest.digest'];
Then restart your app (don't refresh, RESTART!). (Corrupt update prevention/automatic rollback to be added soon, pull requests appreciated)
Copy plugins/cordova-plugin-file/src/android/build-extras.gradle
to platforms/android
https://github.com/apache/cordova-plugin-file#slow-recursive-operations-for-android_asset
run CordovaAppUpdater.switchToUpdatedVersion()
the moment 'deviceReady'
is received