Skip to main content

Doctor

Doctor is a standalone, self-contained script that inspects the current state of your project: it checks the project requirements and displays system information. It ships as vendor/bin/vortex-doctor via the drevops/vortex-tooling Composer package.

Checking project status​

ahoy doctor

Doctor performs a series of checks, each reported on its own line.

Expand to see the video of ahoy doctor

The checks, in order:

  1. Tools - Docker, Docker Compose, Pygmy and Ahoy are installed.
  2. Port - port 80 on the host is either free or held by Docker (skipped on Linux).
  3. Pygmy - the Pygmy services are running.
  4. Containers - all project containers are running.
  5. SSH - an SSH key is available within the CLI container.
  6. Webserver - the web server responds at the local development URL.
  7. Bootstrap - the Drupal site bootstraps successfully.

A failing check prints what to do about it (for example, Pygmy service is not running. Run 'pygmy up' or 'pygmy restart' to fix.).

Configuration​

Each check can be toggled with a VORTEX_DOCTOR_CHECK_<NAME> variable (TOOLS, PORT, PYGMY, CONTAINERS, SSH, WEBSERVER, BOOTSTRAP) set to 0 or 1.

2 presets combine them:

  • VORTEX_DOCTOR_CHECK_MINIMAL=1 - only the tools and containers checks; for environments without Pygmy or a routable web server.
  • VORTEX_DOCTOR_CHECK_PREFLIGHT=1 - only the tools, port and Pygmy checks; for validating a machine before the stack is up.

Getting system information​

ahoy doctor info

Prints a system information report to attach to a support request: the operating system version, the Docker, Docker Compose, Pygmy and Ahoy binaries with their versions, and the Docker daemon details. Usernames, IDs, hashes and IP addresses are redacted, so the output is safe to share.

Expand to see the video of ahoy doctor info

➡️ See Support for how to report an issue.