Get started

Updating

Moving to a new release without losing your changes

Automated

When a new release is available, the admin panel shows a Framework update! notice with Update and Changelog buttons. Click Update, read the changelog in the confirmation window, then confirm. Read it first if your site uses a custom theme, custom plugins or external services.

Since v2.0.79 the updater downloads every release between your version and the latest one, checks each file, and only then applies them in order, so a failed download leaves your site untouched. If you're on v2.0.78 or older, update to v2.0.79 first (the updater offers it), then run the updater again to reach v2.1.x. You'll be signed out of the admin panel once after the v2.0.79 update.

Updates keep coming after your support period ends. The confirmation window then shows a short reminder to renew support before it continues.

If you use the Hybrid mobile app plugin, the confirmation window also starts with a line about your app: either "this update can be delivered to your app over the air" (update, then press Rebuild bundle on the Mobile App page), or "this update needs a new app build" (build and publish the new app in the stores first, give users time to update, and update your site only then) (added in Cordova V1.1.00).

Extensions

Plugins, tools and themes update the same way: each shows its own update notice, and an Update button on its manager page (Setting → Plugins, Tools or Themes). Extensions can't be installed or updated while RKHM itself is behind; the panel tells you which version to update to first.

Apps: after updating RKHM, a plugin or your phone theme, press Rebuild bundle on the Mobile App page so your installed apps receive the update too. The dashboard reminds you under Needs attention if you forget (added in Cordova V1.1.00).

Before you update

Back up your database and the full installation, including uploaded files, your configuration, themes and plugins. Confirm that you can restore the backup or take a server snapshot. Test updates on a staging copy if your site has custom changes.

An update replaces RKHM's own files, and a theme or plugin update replaces that extension's files. Keep your own changes in a custom plugin so they survive updates — see Customize 101.

Manual

Not supported
We don't offer support for manual updating. You are welcome to try it if you are an expert but we can't help you with any problems you might face or cause. Automatic updater is awesome! Try it!
Manual updates need release-specific instructions
A manual file replacement can miss database migrations and overwrite custom work. Use the built-in updater when possible. If an update fails, restore your backup and contact us with the error and current version before deleting installation directories.