Upgrading MODX in MODX Cloud Instances

Upgrading Revo Has Never Been Faster

There are two methods for upgrading MODX websites in MODX Cloud. The first is a 1-click method for simple sites and the other is a Safe Upgrade method. The Safe Upgrade method has more steps but offers the ability to test your upgrade safely hidden away from your site visitors.

1-Click Upgrade

If your MODX site is relatively simple and you're not using custom developed Extras this method is probably right for you.

1. On the Clouds page, locate the Cloud you wish to upgrade from the grid.

2. Back up this Cloud (see Backup instructions).

3. Return to the Clouds page, again locate the Cloud you wish to upgrade from the grid.

4. Click the cog icon (far right) and then select Upgrade Product which will open a new dialog box.

5. From this dialog, select the latest version of MODX to upgrade to and then click the Upgrade Product button.

6. You will receive a notification once this is complete.

7. You may wish to review the site for full function but that's all it takes.

You can also watch a short video on performing 1-click upgrades.

Safe Upgrades

This method of upgrading your MODX site allows you to test the upgrade away from the public and testing prior to upgrading the live site. For most sites, the 1-click Upgrade method should work just fine.

Safe Upgrade: Short Version

For those very familiar with MODX Cloud and here's an abbreviated version of the steps required to perform the Safe Upgrade:

1. Take a Snapshot of your live website.

2. Create a new Cloud from that Snapshot.

3. Upgrade that Cloud.

4. Test the new Cloud.

5. Backup the live site Cloud.

6. Upgrade or take a Snapshot of upgraded Cloud and Inject it into the live website.

Safe Upgrade: Detailed Version

Here are the unabridged instructions to perform a Safe Upgrade on your MODX site in MODX Cloud.

1. Go to the Clouds page in the Dashboard.

2. Locate the Cloud you wish to upgrade.

3. Click on the name of the Cloud from the grid to go to the Cloud Edit View.

4. From the right sidebar of the Cloud Edit view, click on Create Snapshot.

5. From the Create Snapshot dialog, select the Complete Snapshot template, name it and select a category or use Default.

6. Wait for notification that the snapshot has been completed.

7. Once the Snapshot has completed, click Vault in the main navigation and locate the Snapshot in the grid of Snapshots.

8. Below the Snapshot you should see a link to Create New Cloud from Snapshot; click it.

9. Enter a name and select a location, it should automatically create the new cloud using the source Cloud's version of MODX. Don't change this as you may have unexpected results.

10. Once the new Cloud is created by from the Snapshot, find the new Cloud in the grid of Clouds on the Clouds page.

11. At the right side of the Cloud in the list you'll see a cog icon. Click this and then select Upgrade Product which will open a new dialog box.

12. From the dialog, select the latest version of MODX and then click the Upgrade Product button.

13. You will receive a notification once this is complete.

14. Review the website public pages of the test Cloud.

15. Test the Manager for any blank screens, perform actions such as creating a new resource and updating an existing one.

16. Proceed below to upgrade the live site depending on whether you found no issues or found issues you need to fix.

No Issues to Fix After Upgrading Test Site?

If the upgrade went off with no problems on the test site, you're probably safe to go ahead and upgrade the live site as follows:

1. From the Clouds page find the Cloud of the live MODX site.

2. Create a Backup of the live site.

3. From the Clouds page, find the live site Cloud in the grid of Clouds.

4. At the right side of the Cloud in the list you'll see a cog icon. Click this and then select Upgrade Product which will open a new dialog box.

5. From the dialog, select the latest version of MODX and then click the Upgrade Product button.

6. You will receive a notification once this is complete.

7. Review the website public pages of the newly upgraded live Cloud.

8. You're done. Take a bow.

Issues to Fix After Upgrading Test Site?

If you encountered issues once you upgraded the new Cloud you created, you should fix those and then Inject a Snapshot of the upgraded and fixed Cloud into your live site. Once you've fixed the issues here's how to do just that:.

1. Go to the Clouds page

2. In the grid, locate the Cloud of the live site you plan on injecting the fixed cloud into.

3. At the right side of the Cloud in the list you'll see a cog icon. Click this and then select Backup Cloud which will open a new dialog box.

4. Click Backup Cloud to confirm and complete the process.

5. Correct all issues on the newly created Cloud.

6. Go to the Clouds page.

7. Locate the Cloud in which you fixed all the issues in and wish to take a Snapshot of.

8. Click on the name of the Cloud from the grid to go to the Cloud Edit View.

9. From the right sidebar of the Cloud Edit view, click on Create Snapshot.

10. From the Create Snapshot dialog, select the Complete Snapshot template, name it and select a category or use Default.

11. Wait for notification that the snapshot has been completed.

12. Once the Snapshot has completed, click Vault in the main navigation and locate the Snapshot in the grid of Snapshots.

13. Below the Snapshot you should see a link to Inject into Cloud click it.

14. From the dialog that opens, select the name of the live site you're going to inject the newly upgraded and fixed site into and click Inject into Cloud.

15. You will receive a notification once this is complete.

16. Review the website public pages of the newly upgraded live Cloud.

17. You're done. Take a bow.