diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index ef51c7bb..b7a5c908 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -7,6 +7,8 @@ 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: @@ -27,5 +29,25 @@ 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. -If you want to try the community maintained automated update then, please see -[alternative installation methods](installation.md#alternative-installation-methods) +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](https://github.com/nodesource/distributions) and +[here](https://nodejs.org/en/download). And you can find information on the minimum +version of `Node.js` that is required by MagicMirror² +[here](https://github.com/MagicMirrorOrg/MagicMirror/releases) or by running the +upgrade script above and reading any error messages. + +## Alternative Upgrade Methods + +::: tip 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](https://github.com/sdetweil/MagicMirror_scripts/?tab=readme-ov-file#upgrade-to-next-magicmirror-version-from-an-existing-installation)