Create a free account to get access to additional free training videos. Enjoy this free video from CraftQuest! Create a free account to get access to additional free training videos. Join the Community
Installing Craft Nitro on macOS requires Docker, so that means you need to first have Docker Desktop for Mac installed and working.
Installing Craft Nitro on macOS requires Docker, so that means we need first to have Docker Desktop for Mac installed and working. This a free macOS application via the Docker project.
To install Docker Desktop, go to the Docker Desktop page on Docker.com and grab the download for Mac.
Note that the requirements for installing Docker Desktop are that we are running macOS 10.14 or newer. That covers three versions of macOS going back to Mojave.
We also want to be sure we have at least 4 GB of RAM (but ideally more). Docker is RAM-hungry, so if we have an older Mac with 16 GB or less memory, we might see some slowdowns as we use Docker. Every computer is different, and it depends on the demands other applications put on the RAM.
Once the package download is complete, we drag the Docker application to the Applications directory and then launch it.
At this point, Nitro will do everything else for us. One tweak we may want to make is increasing the amount of RAM Docker Desktop is allowed to consume. The default setting might not be enough RAM, so we could have containers exiting if we have several containers running.
With Docker Desktop installed, we can now move to install Nitro. There are two ways to install Nitro: via Brew and directly via a command-line command.
Installing Nitro via Brew is my preferred way to install Nitro because I handle all of my local software via Homebrew. Homebrew is a package manager that installs the software you need on macOS or Linux.
If you already have Homebrew installed, then you can easily install Nitro using:
➜ brew install craftcms/nitro/nitro
We need to make sure we do not run this until we have Docker Desktop installed in the previous step.
Now we can run
nitro init to set up everything and build your Docker environment.
➜ nitro init
nitro init command will take some time as Nitro downloads the images and makes them available via Docker Desktop.
Homebrew isn’t the only way to install Nitro. We can also install Nitro from the command line. We will use the bash shell environment and download and run the installer.
➜ bash <(curl -sLS http://installer.getnitro.sh)
After the download is complete, the installer runs and builds the environment. Using this method, we do not have to run
nitro init as you did with the Homebrew installation option.
The next step in the process is to set up a project with Nitro.
If you have problems installing Nitro, check out the manual installation instructions from the Nitro documentation.
Nitro stores project configurations in a YAML file in a hidden directory in the user directory (on macOS). To see the file, list the files in the directory:
➜ ls ~/.nitro nitro.crt nitro.yaml
nitro.yaml file is where Nitro stores the site configurations. Let’s look inside it:
➜ cat ~/.nitro/nitro.yaml
The file has YAML sections for the database, services, and sites. Editing this file, for example, to remove a site, could be done manually and then just run
nitro apply to apply the updated settings to the Nitro Docker setup.
Here are all of the videos in Local Development with Craft Nitro:
|1||What is Craft Nitro?||Craft Nitro is a Docker-based local hosting solution by Pixel & Tonic, the developers of Craft. It is designed as an officially-supported way to handle local development of Craft CMS website builds, as well as when working on plugin development.||04:08|
|2||Is Craft Nitro Right for Me?||Five checks to see if Craft Nitro is the local development environment for you.||02:33|
|3||How to Install Craft Nitro||Installing Craft Nitro on macOS requires Docker, so that means you need to first have Docker Desktop for Mac installed and working.||09:20|
|4||Creating Your First Site with Nitro||Now that we have Nitro installed, we are ready to create our first Craft hosted with Nitro.||09:49|
|5||Setting Up A Boilerplate Project with Craft Nitro||If you have a boilerplate project that you work with when starting new projects, it’s simple to use that to create a new Nitro project via the `nitro create` command.||04:35|
|6||Migrating an Existing Project to Craft Nitro||Migrating an existing project to Nitro is probably going to be the most common scenario you run into, assuming you move all of your projects over instead of just using Nitro for new projects.||05:04|
|7||Running Craft Commands Against a Craft Nitro Site||It's best to run all `craft` commands through the `nitro` command.||02:15|
|8||Craft CMS Multi-Site with Craft Nitro||Supporting a Craft multi-site installation with Craft Nitro requires using the `nitro alias` command.||04:33|
|9||How to Recall Which Nitro Sites Are Running||I like to be able to get a quick peak and reminds myself of what’s what and if I’ve even set up a project in Nitro yet.||02:58|
|10||Removing a Site from Craft Nitro||Here is how to remove a site from Craft Nitro.||03:05|
|11||Testing Email Sending in Craft Nitro||In addition to the core functionality of local hosting, Craft Nitro also has ancillary services that fill out the total experience of running a Craft site.||05:28|
|12||Updating Craft Nitro||Nitro is an actively maintained project by Pixel & Tonic. You’ll get the best experience with Nitro if you regularly update to get the latest features and improvements.||01:37|
|13||Uninstalling Craft Nitro||If you decide that Nitro isn’t for you or you need to troubleshoot an issue by uninstalling Nitro, then this is how to do it.||02:47|
|Course In-Progress||This course is still being updated with new content. Check back for more!|