Reference

Installation

To get started, install Docker, then install Taxiway. Add Lima when you want VM-backed labs.

Prerequisites

  • Docker, running on your machine, with Docker Compose, for either driver.
  • Lima, when using the Lima driver; Docker-only labs do not require it.

Already have the prerequisites for your driver? Go straight to Install Taxiway.

macOS

Install and open Docker Desktop. For Lima-backed labs, also follow the Lima installation guide.

Linux

Follow the Docker Engine installation guide for your distribution, including the Compose plugin. For Lima-backed labs, also follow the Lima installation guide, including QEMU.

Windows with WSL2

Set up WSL2 with your preferred Linux distribution. Inside that distribution, follow the Linux instructions above to install Docker and Lima.

Run all the commands below in your WSL2 terminal.

Install Taxiway

Copy this command into your terminal:

curl -fsSL https://taxiway.run | sh

Then initialize Taxiway:

taxiway init

The first run downloads and starts the shared services. This can take a few minutes.

If your terminal cannot find taxiway, add it to your shell configuration (~/.zshrc for Zsh or ~/.bashrc for Bash), then reopen the terminal:

export PATH="$HOME/.local/bin:$PATH"

Check your installation

taxiway status

Check that Docker is available and the shared services are running. You can then choose an orchestrator and create your first lab.

For a specific release or a different installation directory, see Installer options.