Skip to content

Install required tools on MacOS

The following instructions were followed to install the required tools on macOS 10.14.3 (Mojave)

Dependencies:

  • Docker for Mac installs the Docker application and other Docker tools. The latest version is not a requirement for this development stack, however it is always advised to keep up to date as improvements and security fixes are released frequently.
  • Yarn is package manager for installing new software packages on your system and is used to run the Portainer development environment.
  • Node.JS is a JavaScript package used when building applications leveraging networking, such as Portainer. Version 12 or greater is required.
  • Golang is an open-source language, from which we build a majority of the Portainer software. Version 1.15 is required.
  • Wget is a package for retrieving files using common internet protocols such as HTTP and FTP.

Docker for Mac

Note: Docker for Mac requires OSX Mountain Lion or later, otherwise it WILL NOT work. Make sure you check your version before you begin following this guide!

Installation Instructions

  • To begin installation Download Docker.
  • Navigate to where the Docker.dmg file downloaded and double click to open.
  • Drag-and-drop Docker into your Applications folder.
  • Next you must authorize the installation with your system password.
  • Wait for Docker to finish installing, and thats it!

Optional Steps:

  • It's a good idea to check your Docker installed successfully. Double-click Docker inside your Applications folder to start Docker.
  • The whale icon should appear in your status bar, indicating Docker is running and accessible.

Checking the installed Docker version

Click on the Docker icon in the status bar and select "About Docker Desktop" from the menu. Depending on your Docker version this option may be worded a little different. A Docker window should now pop up displaying the current version of Docker and its supporting software.

Tip: It is always a good idea to install software based on up-to-date instructions from the offical vendor. This guide was written based on the official Docker help doc for installation on macOS which can be found here.

That’s it for Docker!

Yarn

Note: This tutorial will makes use of the Homebrew package manager. If you don't have this installed, you can follow the tutorial on the offical website.

If you don't want to use Homebrew, you can find alternative tutorials on the offical Yarn website.

Installation Instructions:

  • Running brew install yarn in the macOS terminal will install Yarn.
  • Confirm Yarn has successfully installed by running yarn --version command in the macOS terminal.

The current version of yarn should now print out in your terminal. This indicates that yarn is successfully installed and running on your system.

Troubleshooting:

If you are receiving errors when trying to install or use yarn, you can refer to their official documentation here.

Node.JS

Tip: If you followed the above steps of this tutorial and used Homebrew to install Yarn, Node.JS should have been installed alongside it. Alternatively you can install it following the offical documentation here.

To check if Node is installed on your system run node --version in your terminal. The current version of Node.JS should now print out.

If you have a version of Node.JS greater than version 6 updating Node.JS is optional, however it is always recommended to check everything is up to date.

Updating Node.JS

If you are running a version of Node.JS older than version 6, then you will not be able to run the Portainer development environment and will need to upgrade.

You can follow the below instructions to upgrade Node.JS if it was installed using Homebrew.

  • Run brew upgrade node in the macOS terminal to upgrade.
  • Check the version of node to make sure that it has successfully installed by running node --version in your terminal. You should see a version newer than v6.

Troubleshooting:

If you are having errors trying to install or upgrade Node.JS using Homebrew, it might be helpful to refer to the official documentation here.

Golang

Note: Go version 1.15 is required. If you are upgrading from an older version of Go you must first remove the existing version.

There are two ways to install Go on a macOS system, using a tar and a package file. This tutorial makes use of the package installer. You can refer to offical go documentation here for up-to-date instructions.

Installing GO using the macOS package installer:

  • Download the package file, open it, and follow the prompts to install the Go tools. This package installs the Go distribution to /usr/local/go.
  • The next step is to create a Go Workspace directory: navigate to /Home and create a directory (folder) called go. If you'd like to use a different directory, you will need to set the GOPATH environment variable.
  • Verify GO is installed correctly by following the official documentation here.

Wget

Installing Wget on macOS is simple when you use Homebrew. Just run the brew install wget command in the terminal.

Troubleshooting:

If you are having errors trying to install or use Wget, you can refer to the official guide here.

Notes

Contribute to these docs.