Skip to content

Add instructions for upgrading node when upgrade of MM fails #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add instructions for upgrading node when upgrade of MM fails #301

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
abf589f
Add instructions for upgrading node
dathbe Apr 2, 2025
310629e
Clarify upgrade script instructions
dathbe Apr 3, 2025
eb89544
Add Node install info
dathbe Apr 3, 2025
b4bae10
Add info on where to find required Node version
dathbe Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions getting-started/upgrade-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -27,5 +29,19 @@ 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

### 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)