Install Chef Workstation
Start your infrastructure automation quickly and easily with Chef Workstation. Chef Workstation gives you everything you need to get started with Chef - ad hoc remote execution, remote scanning, configuration tasks, cookbook creation tools as well as robust dependency and testing software - all in one easy-to-install package.
Chef Workstation includes:
- Chef Infra Client
- Chef InSpec
- Chef Habitat
- chef and knife command line tools
- Testing tools such as Test Kitchen and Cookstyle
- Everything else needed to author cookbooks and upload them to the Chef Infra Server
Supported Host Operating Systems:
|Apple macOS||10.14, 10.15, 11.0|
|Microsoft Windows||10, Server 2012, Server 2012 R2, Server 2016, Server 2019|
|Red Hat Enterprise Linux / CentOS||7.x, 8.x|
Minimum system requirements:
- RAM: 2GB
- Disk: 4GB
- Running minimum settings may limit your ability to take advantage of Chef Workstation tools such as Test Kitchen which creates and manages virtualized test environments.
Recommended system requirements:
- RAM: 4GB
- Disk 8GB
Chef Workstation App Requirements
- Windows: No additional requirements
- Mac: No additional requirements
- Linux: You must have a graphical window manager running with support for system tray icons.
- On some distributions you may need to install additional libraries. After you install the Chef Workstation package from the terminal, the post-install message will tell you which, if any, additional libraries are required to run the Chef Workstation App.
The Chef Workstation installer must run as a privileged user.
Chef Workstation installs to
/opt/chef-workstation/ on macOS / Linux
C:\opscode\chef-workstation\ on Windows. These file locations
should help avoid interference between these components and other
applications that may be running on the target machine.
- Visit the Chef Workstation downloads page and select the appropriate package for your macOS version. Select on the Download button.
- Follow the steps to accept the license and install Chef Workstation.
Alternately, install Chef Workstation using the Homebrew package manager:
brew install --cask chef-workstation
- Visit the Chef Workstation downloads page and select the appropriate package for your Windows version. Click on the Download button.
- Follow the steps to accept the license and install Chef Workstation. You will have the option to change your install location; by default the installer uses the
- Optional: Set the default shell. On Microsoft Windows it is strongly recommended to use Windows PowerShell instead of
Alternately, install Chef Workstation using the Chocolatey package manager:
choco install chef-workstation
Headless Unattended Install
“Headless” systems are configured to operate without a monitor (the “head”) keyboard, and mouse. They are usually administered remotely using protocols such as SSH or WinRM.
Chef Workstation can be installed on a headless system using the
msiexec command and flags to skip the installation of the Chef Workstation Application, which requires a GUI. Run the following command in Windows PowerShell or
MsiPath with the path of the downloaded Chef Workstation installer.
msiexec /q /i MsiPath ADDLOCAL=ALL REMOVE=ChefWSApp
Spaces and Directories
Directories that are used by Chef products on Windows cannot have
spaces. For example,
C:\Users\User Name will not work, but
C:\Users\UserName will. Chef commands may fail if used against a
directory with a space in its name.
Top-level Directory Names
Windows will throw errors when path name lengths are too long. For this
reason, it’s often helpful to use a very short top-level directory, much
like what is done in UNIX and Linux. For example, Chef uses
install Chef Workstation on macOS. A similar approach can be done on
Microsoft Windows, by creating a top-level directory with a short name.
Visit the Chef Workstation downloads page and download the appropriate package for your distribution:
Red Hat Enterprise Linux
Use your distribution’s package manager to install Chef Workstation:
Red Hat Enterprise Linux:
yum localinstall chef-workstation-21.2.278-1.el8.x86_64.rpm
dpkg -i chef-workstation_21.2.278-1_amd64.deb
Verify the Installation
To verify the installation, run:
Which returns the versions of all installed Chef tools:
Chef Workstation version: 21.2.303 Chef Infra Client version: 16.10.17 Chef InSpec version: 4.26.13 Chef CLI version: 3.1.1 Chef Habitat version: 1.6.181 Test Kitchen version: 2.10.0 Cookstyle version: 7.8.3
To upgrade from ChefDK or an earlier release of Chef Workstation, follow the instructions provided under Installing.
uninstall_chef_workstation in your terminal.
Use Add / Remove Programs to remove Chef Workstation.
Ubuntu, Debian, and related:
sudo dpkg -P chef-workstation
Red Hat, CentOS, and related:
sudo yum remove chef-workstation
Now that you’ve installed Chef Workstation, proceed to the Setup guide to configure your Chef Workstation installation.
Was this page helpful?