From abf589f98243c648c8086fe1ebcb9067874889ce Mon Sep 17 00:00:00 2001 From: dathbe Date: Wed, 2 Apr 2025 10:20:39 -0700 Subject: [PATCH 1/6] Add instructions for upgrading node --- getting-started/upgrade-guide.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index ef51c7bb..d9ecf677 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -27,5 +27,11 @@ 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. +Your upgrade may fail if you do not have the version of `node` required by the +latest release of MagicMirror². If you need to upgrade `node`, you can run the +following command: + +`sudo n stable` + If you want to try the community maintained automated update then, please see [alternative installation methods](installation.md#alternative-installation-methods) From 310629e0880f81087dbe289615b95a4e07a34f3a Mon Sep 17 00:00:00 2001 From: dathbe Date: Wed, 2 Apr 2025 17:15:48 -0700 Subject: [PATCH 2/6] Clarify upgrade script instructions --- getting-started/upgrade-guide.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index d9ecf677..a318a746 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,11 +29,11 @@ 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. -Your upgrade may fail if you do not have the version of `node` required by the -latest release of MagicMirror². If you need to upgrade `node`, you can run the -following command: - `sudo n stable` -If you want to try the community maintained automated update then, please see -[alternative installation methods](installation.md#alternative-installation-methods) +## Alternative Upgrade Methods + +### 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) From eb895444c412caa2d8b72526b1c31ec61a793ac4 Mon Sep 17 00:00:00 2001 From: dathbe Date: Wed, 2 Apr 2025 20:53:41 -0700 Subject: [PATCH 3/6] Add Node install info --- getting-started/upgrade-guide.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index a318a746..73635319 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -29,7 +29,10 @@ 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. -`sudo n stable` +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). ## Alternative Upgrade Methods From b4bae105d8d04a96024dbfb9381b583c6961e8bb Mon Sep 17 00:00:00 2001 From: dathbe Date: Wed, 2 Apr 2025 20:57:03 -0700 Subject: [PATCH 4/6] Add info on where to find required Node version --- getting-started/upgrade-guide.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index 73635319..803b8d23 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -32,11 +32,16 @@ Type `git status` to see your changes, if there are any, you can reset them with 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). +`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 ### 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) +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) From 5aa8805a03c57f066474e4b1fd1fa781553f5bf6 Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Thu, 5 Jun 2025 08:34:45 +0200 Subject: [PATCH 5/6] Add NOTE to 'Alternative Upgrade Methods' --- getting-started/upgrade-guide.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index 803b8d23..559f8798 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -40,6 +40,12 @@ 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 obove 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 From ccafb0831d65d1c309aef32bd23b11fa9d8ddb7a Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Thu, 5 Jun 2025 10:41:35 +0200 Subject: [PATCH 6/6] Fix typo Co-authored-by: Veeck --- getting-started/upgrade-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/upgrade-guide.md b/getting-started/upgrade-guide.md index 559f8798..b7a5c908 100644 --- a/getting-started/upgrade-guide.md +++ b/getting-started/upgrade-guide.md @@ -42,7 +42,7 @@ upgrade script above and reading any error messages. ::: tip NOTE -Users who prefer a straightforward, automated solution may find alternative methods more practical. Although convenient, not using the manual method obove may mean that you gain less insight into the system, which could make it harder to troubleshoot issues independently. +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. :::