Skip to content
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.

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

Update raspberry_pi_installation.md #1820

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/src/installation/raspberry_pi_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ Once the OS installation has been completed, you are ready to commence.

Follow [instructions for Ubuntu and Debian based distributions like Raspberry Pi OS at NodeSource Distributions](https://github.com/nodesource/distributions#installation-instructions).

NOTE: IMPORTANT - installing a higher version of nodejs (eg V20) is known to cause issues with a number of plugins and CAN adaptors.
Note: Some applications that are installed after signalk-server are known to "auto" install updated/most recent version of nodejs...
which as above breaks things .... take care to avoid this!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I think there are multiple issues in this addition:

  • The previous step calls for installing NodeJS (note the capitalization) 18 and this about "higher version" and refers to V20. To me this is needlessly confusing
  • Why is there one NOTE and and another note?
  • I am not aware of other applications updating nodejs version - can you be more specific? And how would an end user take care to avoid thid?

This document is about installing signalk-server on a system that has no NodeJS or a previous installation, but the notes are about updating Node. Maybe we could find some other place where these notes would have a more appropriate home, like https://github.com/SignalK/signalk-server/wiki/Installing-and-Updating-Node.js ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i did follow the instructions as presented, all good.
however when installing either influx or grafana - i believe it was the latter,
the install script - went ahead and update nodejs… (to V20) … this created two days of fault finding and unnecessary debugging with help from other signalk users.

FAQs would at best be looked at after a user encounters an issue … i was thinking “how” to make sure that as part of the install process .. that a user be alerted to beware of this …

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i did add the following into the FAQ
this ok?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uploading IMG_0161.jpeg…

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither Influx nor Grafana are NodeJS based, I sincerely doubt they caused a NodeJS update.¨

Also the problem is not really NodeJS v20, instead any update of a major NodeJS version may break things and in practise requires a reinstall of the server and the plugins.

1. Ensure that we're using the latest version of npm.
```
sudo npm install -g npm@latest
Expand Down