Local Development Environments

Even though Lagoon has only a hard dependency on Docker and Docker Compose (which is mostly shipped with Docker) there are some things which are nice for local development that are not included in Docker:

  • A HTTP reverse proxy for nice URLs and HTTPS offloading.
  • A DNS system so we don't have to remember IP addresses.
  • SSH agents to use SSH keys within containers.
  • A system that receives and displays mail locally.

Important

You do not need to install Lagoon locally in order to use it locally! That sounds confusing, but follow the documentation. Lagoon is the system that deploys your local development environment to your production environment, it's not the environment itself.

Lagoon currently works best with pygmy , which is the amazee.io flavored system of the above tools and works out of the box with Lagoon.

pygmy is a Ruby gem, so to install it, run: gem install pygmy.

For detailed usage info on pygmy, see the documentation of pygmy

We are evaluating adding support for other systems like Lando, Docksal, DDEV, and Docker4Drupal, and will possibly add full support for these in the future. If you do have Lagoon running with a system like these, we would love for you to submit a PR on GitHub!