Skip to main content
Version: v1

Pygmy

pygmy is the single tool needed to get the local amazee.io Docker Drupal Development Environment running on your Linux based system. It is built to work with Docker for Mac! (quite a lot for such a small whale 🐳)

Pygmy provides the shared services the Vortex container stack relies on:

  • An HTTP reverse proxy for readable URLs and HTTPS offloading.
  • A DNS system, so services are addressed by name instead of IP address.
  • SSH agents, so SSH keys are available within containers.
  • A local mail catcher that receives and displays outgoing mail at http://mailhog.docker.amazee.io/.

The docker-compose.yml shipped with Vortex attaches its services to the external amazeeio-network that Pygmy creates, so Pygmy must be running before ahoy up can start the stack - ahoy doctor checks for it.

Installation​

Follow the official installation instructions.

Usage​

pygmy up       # Start the services. Required to run only once per system boot.
pygmy down     # Stop the services.
pygmy restart  # Restart the services.
pygmy status   # Show the status of the services.
pygmy clean    # Stop and remove all services. Useful if you have issues with pygmy.

SSH key in the CLI container​

The CLI container uses the SSH agent from Pygmy's amazeeio-ssh-agent container. It mounts the agent's volume through volumes_from and links to the agent's socket only when the CLI container starts.

pygmy restart removes the agent container and creates a new one. If the stack is running at the time, the CLI container stays attached to the previous agent, so the SSH key is no longer available inside it. The same happens when the stack starts before Pygmy.

Recreate the CLI container to attach it to the current agent:

ahoy up --no-deps --force-recreate cli

Running ahoy up on its own isn't enough: Docker Compose leaves a running container alone when its configuration hasn't changed. ahoy doctor checks that the SSH key is available in the CLI container and prints this command when it isn't.