Lagoon Integration¶

DDEV provides integration with Lagoon, allowing users to quickly sync the files and database from a Lagoon environment to the local DDEV project.

Lagoon Per-Project Configuration¶

Check out the Lagoon project and configure it by running ddev config. You’ll want to run ddev start and make sure the basic functionality is working.

Add LAGOON_PROJECT and LAGOON_ENVIRONMENT variables to your project using 'web_environment' in its YAML configuration or a .ddev/.env file. For example:

web_environment:
    - LAGOON_PROJECT=your-project
    - LAGOON_ENVIRONMENT=main

You can also do this with:

ddev config --web-environment-add="LAGOON_PROJECT=your-project,LAGOON_ENVIRONMENT=main"

Syncing is done via lagoon-sync which must be configured in your .lagoon.yml or .lagoon-sync.yml, see the DDEV example .lagoon.yml.
Configure an SSH key for your Lagoon user.
Run ddev auth ssh to make your SSH key available in the project’s web container.
Run ddev restart.
Run ddev pull lagoon. After you agree to the prompt, the current upstream databases and files will be downloaded.
Optionally use ddev push lagoon to push local files and database to Lagoon. The ddev push command must be done with great care if you’re pushing to a production environment, but is great for pushing to branch environments.

Usage¶

ddev pull lagoon will connect to the Lagoon environment to download database and files. To skip downloading and importing either file or database assets, use the --skip-files and --skip-db flags.
To pull from a specific environment without permanently changing your project config, pass environment variables using --environment:
```
ddev pull lagoon --environment="LAGOON_ENVIRONMENT=main"
```
You can combine multiple variables:
```
ddev pull lagoon --environment="LAGOON_PROJECT=your-project,LAGOON_ENVIRONMENT=main"
```
If you need to change the lagoon.yaml recipe, you can change it to suit your needs, but remember to remove the #ddev-generated line from the top of the file.