Beginner’s Guide to Installing Node.js on a Raspberry Pi

Learning through Making (LTM) logo

This article has been updated to cover the installation of the latest version of Node at the time of this writing which is Node 6.x.

In this second installment of our LTM (Learning through Making) series of Node.js tutorials, we’re going to get Node up and running on a Raspberry Pi 2 or Pi 3. With the Raspberry Pi 3, you won’t need to buy a separate USB Wi-Fi adapter. I’m focusing on the Raspberry Pi 2/Pi 3 rather than older versions such as the Raspberry Pi B+ since these are the latest models at the time of this writing.  The Raspberry Pi 2, for example, sports a 900MHz quad-core ARMv7 chip with 1 GB of RAM versus the Model B+’s 700 MHz single-core ARMv6 chip with 512 MB RAM. While Node can run on the model B+, we will be happier campers with this extra computing power available to us! Let’s get started.

This tutorial is useful for anyone wishing to successfully install a Raspberry Pi 2/Pi 3 system, even if they are not interested in Node.js since the Node.js installation happens in the final steps of the tutorial.  But, why would you not want to install Node.js? 🙂

Raspberry PiHardware Needed

If you don’t currently own a Raspberry Pi, the easiest way to get started is to buy a starter kit such as this one on Amazon:

We’ll need the following items to get rolling:

  • Raspberry Pi 2 or Pi 3 – Model B  (these are the official names for the Raspberry Pi 2 and Pi 3.  Don’t let the “B” confuse you since there is also an older Raspberry Pi – Model B which is now effectively the “Raspberry Pi 1 – Model B”.)
  • MicroSD card (I recommend a class 10 card that is 16 GB or higher.  I like this Samsung 32GB Class 10 microSD card.)
  • MicroSD to SD memory card adapter (so you can use the SD card reader on your laptop/desktop to write to the microSD card.  Many microSD card vendors include this SD adapter with the purchase as shown here.)
    SD card adapter
  • Micro USB power supply (2.5A or greater recommended) to power the RasPi.
  • (RasPi 2 only) USB WiFi adapter (or Ethernet cable if preferred.  I have tested this Edimax USB WiFi adapter on Raspbian and it works great out of the box.  There’s a reason this is a best seller on Amazon.)  This is not needed for the RasPi 3 since it includes built-in Wi-Fi.
  • Windows laptop/desktop (Linux or Mac works great too, but this tutorial is geared more toward Windows machines so some readers will need to adapt)
  • HDMI monitor/USB keyboard/mouse (You can borrow these from another system temporarily and then run your RasPi in a headless mode as I will explain later.)

Once you have gathered the needed hardware, we are ready to bring our RasPi machine to life!

Write Raspbian Image to SD Card

We will be running Raspbian which is a free operating system based on Debian Linux and optimized for the RasPi.  Here we go:

  • Download the latest Raspbian image from https://www.raspberrypi.org/downloads/raspbian/.  Be sure to download the full version rather than the “lite version.  The download is about 1.5 GB so it may take some time to download depending on the speed of your Internet connection.
  • The download will arrive as a .zip file and will need to be unzipped into an .img file so it is ready to be written to the microSD card.
  • Insert the microSD card into the SD adapter as shown in the Samsung sample picture above.
  • Insert the SD adapter in the SD card reader on your laptop/desktop.  Make sure it is seated well in the connection.
  • Launch Windows Explorer and verify that the SD card registers as a drive on your system.  Make a note of the drive letter as you will need it soon.
  • Download and install Win32 Disk Imager.
  • Launch Win32 Disk Imager. The interface will look like this:
    Win32DiskImager
  • Navigate to the Raspbian image (.img file) that you downloaded.
  • Specify the target device location of the SD card.  The target device is the “F” drive in the screenshot above, but yours may be different.
    WARNING: Be sure you choose the right target device or you will write the image to another drive on your system and this will not be good.
  • Click the Write button to write the image to the SD card.
  • Side note: the Win32 Disk Imager is a great tool for backing up SD cards too.  When you have completed this tutorial, you could create an image (.img file) of your pristine RasPi for writing back to the microSD card for use later if you mess something up and want to roll back to the pristine image.
  • After the image is written to the SD card, click on the Safely Remove Hardware icon in the notification area at the far right of the Windows taskbar.
  • Remove the SD adapter from your laptop/desktop, and remove the microSD card from the SD adapter.

Prep the hardware

The Tech Brick Café has a nice overview picture of the various parts of the RasPi 2 here (RasPi 3 looks very similar) that may help you in this section.  Let’s get this little SBC (single board computer) ready to boot! Here are the steps:

  • Insert the microSD card into the RasPi.  (Turn the RasPi upside down.  The microSD card slot is located on the side opposite of the USB ports.  This short video explains the process well.)
  • Connect the USB keyboard and mouse
  • Connect the HDMI cable
  • Connect the USB Wi-Fi adapter (or Ethernet connection if you are not using Wi-Fi)  This step is not necessary if you are using a Raspberry Pi 3 which has on-board Wi-Fi.
  • Connect the power supply (You will see the RasPi lights come on and power up.)
  • You should now see Raspbian booting on the screen.  Hooray!

Configure the RasPi

We first need to make a few changes to the RasPi to for the purpose of optimization and personalizing it for our use.  To get started, launch Raspberry Pi Configuration which is located in the Menu under Preferences.
RasPi configuration GUI
This will launch the Raspberry Pi Configuration utility, a handy graphical version of the console-based raspi-config program that was used for many years to configure the RasPi (and is actually still used behind the scenes by this graphical version).  This will launch the following window:
rcg1
Let’s start configuring!

  • Expand Filesystem – click this button to expand the filesystem.  This ensures that all of the SD card storage is available to Raspbian.
  • (Optional) Change Password – from a security perspective, it’s a good idea to change the default password for the “pi” user.  Just make sure you don’t forget it. 😉
  • Hostname – if you prefer less typing when connecting remotely (explained later), you can change the host name from “raspberrypi” to something shorter such as “raspi”.

Localization

The Raspberry Pi is the brilliant brainchild from our friends in the UK.  If you are not from the UK, you will need to change some of the localization settings.  For example, some of the keys on your keyboard may not work as expected.  Here are the changes I made to make my RasPi feel at home in San Diego:

First, click on the Localisation tab:
localization
Click the Set Locale button to change your locale as appropriate and then click OK.  Mine looks like this after making the changes:
localization details
Click the Set Timezone button to set your timezone and then click OK.
set timezone
Click the Set Keyboard button to set your keyboard as appropriate and then click OK.  Here’s mine:
set keyboard
Finally, click the Set WiFi Country button and change as needed.  This dialog box presents a large list of countries. Use the arrow keys on your keyboard to scroll through the list to find your country and then click OK.
wifi country
After completing these configuration steps, click OK to exit the Raspberry Pi Configuration program.  The RasPi will then let you know that it needs to reboot to activate the changes you just made.  Reboot it now.

Configure Wi-Fi

After the RasPi reboots, we are ready to get Wi-Fi up and running to get on the network.

  • Click on the network icon in the top right of the screen as shown in the screenshot.
    wifi setup
  • From here, select your network SSID (Wi-Fi network).
  • You will be prompted for your pre shared key (Wi-Fi) network password.  Enter it and select OK.
  • Wait for the icon to transform from a network icon to the Wi-Fi icon shown in the screenshot above.  From this point, you should be connected to your Wi-Fi network.
  • Test your Wi-Fi network connection by launching the Terminal.
    launch terminal
  • From the terminal, issue a ping command to verify your network connection is working:
    $ ping google.com

We’re now ready to move on and ensure our system is up to date with security patches

Apply Raspbian Updates

We will first run the apt “update” command.  This command will not actually update any software on the system, but will download the latest package lists from the software repositories so that Raspbian will be aware of all new software available along with dependencies.  Issue the following command at the “$” prompt:

$ sudo apt update

Next, run the following command to upgrade any packages installed on your system that need upgrades:

$ sudo apt full-upgrade

This is important to keep your RasPi system synchronized with security updates, etc. These two commands should be issued together and run periodically.

Prepare Remote Desktop

We want to run the RasPi remotely through Windows rather than having to tie up a dedicated HDMI monitor and USB keyboard/mouse.  Let’s do that now:

  • Issue the following command to install the xrdp software so that we can connect to our RasPi remotely from our laptop/desktop without requiring a second monitor/keyboard/mouse:
    $ sudo apt install -y xrdp

    The “-y” option will automatically answer yes to the default questions which is what we want in this context.

  • Next, we need to install the samba package so we will be able to access the RasPi by its host name from Windows machines on the network rather than by it’s IP address which can change since the RasPi receives its IP address via DHCP:
    $ sudo apt install -y samba
  • After this installation completes, you should be able to ping the RasPi Hostname (configured in Raspberry Pi Configuration program above) from a Windows machine:
    C:\> ping raspi
  • You are now ready to launch a remote desktop connection!
  • From your Windows machine, hit the Windows key, and type “Remote Desktop Connection” to bring up the Remote Desktop program.  Click it in to invoke it.
  • Type the host name of your RasPi (“raspi” in my case) in the Computer textbox and click the Connect button.
    Windows Remote Desktop
  • You will then be prompted with the xrdp login screen:
    xrdpLogin
  • Enter your credentials and log into the RasPi.
    • username: pi
    • password: raspberry (unless you changed it in the Raspberry Pi Configuration program earlier in the tutorial.)

Amazing!  We are connected remotely to the RasPi and we no longer need the dedicated HDMI monitor and USB keyboard/mouse. Let’s go ahead and shut down the RasPi for a minute so we can free up our monitor and keyboard/mouse:

  • Click the Menu button in the top left corner of the screen and select Shutdown.
  • Click OK to shut down the machine.
  • Wait a minute for the RasPi to fully power down.
  • Unplug the power cable, HDMI cable, and the USB keyboard and mouse.
  • Plug the power cable back in and the RasPi should be on its way back up without all of those extra cables!
  • After giving the RasPi a minute or so to boot, connect to it once again using the Windows Remote Desktop program.

Create Windows File Share on the RasPi (Optional)

We can create a Windows file share on the RasPi so that we can copy files from our Windows machine directly onto the RasPi.  This can come in handy in many contexts.  Here’s how we do it:

  • Launch a terminal session.
  • Create a directory called “share” in your home directory as follows:
    $ mkdir ~/share
  • Issue the following command to launch the Leafpad editor.
    $ sudo leafpad /etc/samba/smb.conf &
  • We could have also used the console-based “nano” editor, but Leafpad provides a GUI which is more suitable for beginners.  The ampersand on the end of the command launches Leafpad as a background process so we are returned to a shell prompt in the terminal.  Also, the smb.conf is part of the Samba package we installed early and this is why it exists on our system.
  •  Scroll down to the very bottom of the smb.conf configuration file and add the following:
    [PiShare]
     comment=Raspi Share
     path=/home/pi/share
     browseable=Yes
     writeable=Yes
     only guest=No
     create mask=0777
     directory mask=0777
     public=no
  •  Save the changes to the smb.conf configuration file and exit the Leafpad editor.  (Raspbian will automagically restart the SMB (Samba) services based on the changes you made to the configuration file.)
  • Back in a terminal session, we need to create an SMB (Samba) user so we can connect securely from Windows.  We will create a user named “pi”, but this will be an SMB (Windows user) rather than the Raspbian “pi” user. Here’s how we do it:
    $ sudo smbpasswd -a pi

    You will be prompted to enter and re-enter a password.  Document this password somewhere for future reference.

We are ready to connect to our newly created RasPi file share from Windows!

  • Back on your Windows machine, type the Windows key and “R” (Win-R) to launch a run box for typing in commands.
  • Enter two backslashes followed by the name of your RasPi machine (i.e. your Hostname) and hit enter.  For example:
    \\raspi
  • When prompted for credentials, enter the following:
    • Username: The format to enter here in Windows parlance is the domain\username.  For us, our domain will be our RasPi hostname and our user name will be “pi”.  Therefore, we will enter: raspi\pi
      If your Hostname is not raspi, you will obviously enter that instead.
    • Password: (enter the password you created with the smbpasswd command above)
  • Voilà!  We should now be connected.  You can test the file share by creating a text file on the Windows side and verifying that it shows up in the /home/pi/share directory on the RasPi side.

Install Node.js

You now have an amazing general purpose Raspberry Pi system that can be used for a variety of tasks and inter-operates well in the Windows world (it even looks like a Windows machine to the other Windows machines!) – and can play nicely in the Mac and Linux world too.  Let’s go ahead and install Node.js so we will be ready to do some fun projects in the future.  Here are the steps:

Our friends at NodeSource host and maintain some excellent Node.js binary distributions.  We will leverage a command they have written to add another package repository to our RasPi so that we will be able to “apt install” a modern version of Node.js from their repository.  This is beneficial since the Debian/Raspbian versions may not always be up to date.  By adding the NodeSource repository, we will also be able to receive updates rather than just installing a standalone (.deb) file version of Node that cannot be updated easily.  Here we go in the final stretch:

Let’s go for an installation of the latest version of Node at the time of this writing which is Node 6.x.

$ curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -

The previous command updates our Debian apt package repository to include the NodeSource packages.

Note: It’s generally a good idea from a security perspective to know what commands you are invoking on your system, especially since the command above invokes the script as the root user.  If you want the technical details behind this script, you can launch the URL (https://deb.nodesource.com/setup_6.x) in your browser and review the code.  The script carries out some ceremony to determine the Linux distribution you are running and instructs the Debian apt package system to add the NodeSource package repository as a trusted source for obtaining Debian packages.  This enables us to install Node.js now and upgrade to more recent versions of Node.js when they become available.

Now that we have added the NodeSource package repository, we can move on and install Node.js!

$ sudo apt install -y nodejs

We can then test and see what version of Node we are running and launch the Node REPL as we discussed in the previous article as a quick test to confirm the installation was successful.

$ node -v
v6.2.1
$ node
> 1 + 3
4
> # We can hit Ctrl-C twice to exit the REPL and get back to the bash (shell) prompt.

Next time

In a future post, we will leverage the goodness of the npm (Node Package Manager) community and build a simple, but highly functional Web server without any code.  This can be accomplished using the Raspberry Pi system you just created here or on a Windows/Linux/Mac machine as I outlined in a previous article.  Hope to see you then!

Follow @thisDaveJ (Dave Johnson) on Twitter to stay up to date on the latest tutorials and tech articles.

Related Articles

Learning through Making – Getting Started with Node.js
Upgrading to more recent versions of Node.js on the Raspberry Pi
Create a Web Server in Node without any Code
Make Your Raspberry Pi Web Server Available on the Internet with Node.js

ShareTweet about this on TwitterShare on FacebookShare on Google+Share on LinkedInShare on RedditEmail this to someone

16 thoughts on “Beginner’s Guide to Installing Node.js on a Raspberry Pi

  1. Please clarify what the large script from NodeSource exactly does or remove the reference. Until then I advice against this method as it involves executing a script from an unknown source that until proven otherwise must be assumed to be damaging.

    1. Hi Philip, thanks for taking the time to provide feedback regarding security! I agree with your assessment and added a paragraph to address your concerns.

  2. Great article and well written.
    Just wanted to add after I followed your instructions and installed node, the version returned is : 0.10.29!!
    I had to do another “apt-get update” and “apt-get dist-upgrade” to fix the issue.

    1. Hi John, thanks for your positive feedback and for letting me know about the issue you experienced. I ran through my entire tutorial from square one with the current version of Raspbian and could not reproduce your issue. The Node version returned was 6.x. I’m not sure what happened in your case since running the NodeSource “setup_6.x” script via curl will run “apt-get update” near the end of the script. This would ensure that when you subsequently ran “sudo apt-get install -y nodejs”, it should have installed Node 6.x instead of 0.10.29. Perhaps the “apt-get update” command in the script failed for some reason in your case due to Internet connectivity or some other reason. In any case, I’m glad you ultimately were able to get Node 6.x up and running on your RPi!

      1. Dave,
        You are probably right. It was also odd to me. but anyway it was fixed by re-updating!
        Just one simple question, accept my apology if it seems silly. what is the different between apt-get install node and wget https://nodejs.org/dist/… ?
        I am trying to make node as a service by following this website “http://yannickloriot.com/2016/04/install-mongodb-and-node-js-on-a-raspberry-pi/”, and of course without installing nodejs again and it fails!

        1. Hi John, not a silly question. The Node installation method I recommend in my article above (using the NodeSource script and apt-get install) sets you up for longer term success since you can easily update Node as new versions are released. See my article on Upgrading to more recent versions of Node.js on the Raspberry Pi for how this works. In the article you referenced, the “wget” method installs Node, but you must carry out extra steps to symlink the binary and, most importantly, Node cannot be as easily upgraded.

          I recommend this article for installing Node as a service since it uses the newer systemd init system and the task can be accomplished with a much simpler script. It also automatically restarts if there is a failure with your Node script. You will need to change one line of code in the nodeserver.service file to make it work with the steps you have completed with my tutorial since the path to the Node binary is different:

          ExecStart=/usr/bin/node /home/pi/share/node/app.js

          The path to your “app.js” file may be different too. If so, adjust this path accordingly. Finally, in that tutorial, there are places you will need to prefix the commands with “sudo” such as “sudo systemctl enable nodeserver.service”

  3. I have recently starting playing with the Razz and am loving it. I have 2 and may buy another. A coworker stumbled onto your site and shared the link with me, and it is my good fortune. Thank you for this article, and for the others I haven’t read yet.

    1. Thanks for your positive feedback, Jahan. I’m glad my article has been useful to you and that you are having fun with the Raspberry Pi!

Leave a Reply

Your email address will not be published. Required fields are marked *