Install Chef Workstation

Start your infrastructure automation 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

For general information about downloading Chef products, see the Chef download documentation.

For supported Chef Workstation versions, see the Chef Workstation release notes or use the Chef download APIs.

Supported Platforms

The following table lists the commercially supported platforms and versions for Chef Workstation:

Derived Platforms

The following table lists supported derived platforms and versions for Chef Workstation.

See our policy on support for derived platforms for more information.

System Requirements

Minimum system requirements:

• RAM: 4GB
• Disk: 8GB
• Additional memory and storage space may be necessary to take advantage of Chef Workstation tools such as Test Kitchen which creates and manages virtualized test environments.

Additional Chef Workstation App Requirements:

• On Linux, you must have a graphical window manager running with support for system tray icons. For some distributions you may also 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.

Installation

The Chef Workstation installer must run as a privileged user.

Chef Workstation installs to /opt/chef-workstation/ on macOS and Linux, and C:\opscode\chef-workstation\ on Windows. These file locations help avoid interference between these components and other applications that may be running on the target machine.

macOS Install

1. Visit Chef Downloads to download a Chef Workstation package.
2. Follow the steps to accept the license and install Chef Workstation.

Alternatively, install Chef Workstation using the Homebrew package manager:

brew install --cask chef-workstation

Windows Install

1. Visit Chef Downloads to download a Chef Workstation package.
2. 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 C:\opscode\chef-workstation\ directory.
3. Optional: Set the default shell. On Windows it is strongly recommended to use Windows PowerShell instead of cmd.exe.

Alternatively, 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 cmd.exe, replacing MsiPath with the path of the downloaded Chef Workstation installer.

msiexec /q /i MsiPath ADDLOCAL=ALL REMOVE=ChefWSApp

Spaces and Directories

Top-level Directory Names

Linux

You can use Chef’s download APIs or a package manager to install Chef Workstation on Linux.

Download API

• To use the Chef download APIs to download Chef Workstation:

  wget https://chefdownload-commercial.chef.io/stable/chef-workstation/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<WORKSTATION_VERSION>&license_id=<LICENSE_ID>
  

  Replace:

  • <PLATFORM> with the platform you want to run Chef Workstation on. For example, ubuntu or el.
  • <PLATFORM_VERSION> with the version of the platform you want to run Chef Workstation on.
  • <ARCHITECTURE> with the architecture that Chef Workstation on. For example, x86_64.
  • <WORKSTATION_VERSION> with the version of Chef Workstation you want to download.
  • <LICENSE_ID> with your Chef license ID.

  For example, run the following to download Chef Workstation 24.8.1068 on Red Hat Enterprise Linux 9 running on x86-64 architecture:

  wget https://chefdownload-commercial.chef.io/stable/chef-workstation/download?p=el&pv=9&m=x86_64&v=24.4.1068&license_id=<LICENSE_ID>
  

See the Chef download API documentation and Chef licensing documentation for more information.

Package manager

You can use Yum or Dpkg package managers to install Chef Workstation.

• To download Chef Workstation using Yum on Red Hat Enterprise Linux:

  yum localinstall chef-workstation-<WORKSTATION_VERSION>-1.el<RHEL_VERSION>.x86_64.rpm
  

  For example:

  yum localinstall chef-workstation-24.4.1064-1.el8.x86_64.rpm
  

• To download Chef Workstation using Dpkg on Ubuntu or Debian:

  dpkg -i chef-workstation_<WORKSTATION_VERSION>-1_amd64.deb
  

  For example:

  dpkg -i chef-workstation_24.4.1064-1_amd64.deb
  

Verify the Installation

To verify the installation, run:

chef -v

Which returns the versions of all installed Chef tools:

Chef Workstation version: 24.6.1066
Chef Infra Client version: 18.5.0
Chef InSpec version: 5.22.55
Chef CLI version: 5.6.14
Chef Habitat version: 1.6.1041
Test Kitchen version: 3.6.0
Cookstyle version: 7.32.8

Upgrading

To upgrade from ChefDK or an earlier release of Chef Workstation, follow the instructions provided under Installing.

Uninstalling

Mac Uninstall

Run uninstall_chef_workstation in your terminal.

Windows Uninstall

Use Add / Remove Programs to remove Chef Workstation.

Linux Uninstall

Ubuntu, Debian, and related:

sudo dpkg -P chef-workstation

Red Hat, CentOS, and related:

sudo yum remove chef-workstation

Next Steps

Now that you’ve installed Chef Workstation, proceed to the Setup guide to configure your Chef Workstation installation.