Upgrade Guide

WARNING

Always backup your config.js, custom.css and modules folder before you start the upgrade process!

Manual Upgrade

If you want to update your MagicMirror² to the latest version, use your terminal to go to your MagicMirror folder and type the following command:

git pull && npm run install-mm

If you changed nothing more than the config or the modules, this should work without any problems.

WARNING

Using git reset --hard as described below will delete all your changes made in the source code, so only execute this if you know what you are doing!

Type git status to see your changes, if there are any, you can reset them with git reset --hard. After that, git pull should be possible.

MagicMirror² updates may change the minimum version of Node.js that is required, and the installation script above may fail if your system does not meet that minimum requirement. You can find information on installing newer versions of Nodes.js here and here. And you can find information on the minimum version of Node.js that is required by MagicMirror² here or by running the upgrade script above and reading any error messages.

Alternative Upgrade Methods

NOTE

Users who prefer a straightforward, automated solution may find alternative methods more practical. Although convenient, not using the manual method above may mean that you gain less insight into the system, which could make it harder to troubleshoot issues independently.

Community-Maintained Automatic Upgrade Script

Sam (@sdetweil, long time contributor of the MagicMirror² framework) maintains an easy-to-use update script: https://github.com/sdetweil/MagicMirror_scripts