Getting Started

Requirements

Before you get started with this recipe we assume that you have:

1. Installed Lando and gotten familiar with its basics
2. Initialized a Landofile for your codebase for use with this recipe
3. Read about the various services, tooling, events and routing Lando offers.
4. Temporarily stopped (pygmy stop) the Pygmy tool to avoid any port conflicts

Quick Start

You can also run the following commands to try out this recipe on one of your Lagoon sites.

# Clone a site from a lagoon instance
lando init --source lagoon

# Start it up
lando start

# Pull down files and database
lando pull --database main --files main

# List information about this apps services.
lando info

Custom Installation

This plugin is included with Lando by default. That means if you have Lando version 3.0.8 or higher then this plugin is already installed!

However if you would like to manually install the plugin, update it to the bleeding edge or install a particular version then use the below. Note that this installation method requires Lando 3.5.0+.

# Ensure you have a global plugins directory
mkdir -p ~/.lando/plugins

# Install plugin
# NOTE: Modify the "yarn add @lando/lagoon" line to install a particular version eg
# yarn add @lando/lagoon@0.5.2
docker run --rm -it -v ${HOME}/.lando/plugins:/plugins -w /tmp node:14-alpine sh -c \
  "yarn init -y \
  && yarn add @lando/lagoon --production --flat --no-default-rc --no-lockfile --link-duplicates \
  && yarn install --production --cwd /tmp/node_modules/@lando/lagoon \
  && mkdir -p /plugins/@lando \
  && mv --force /tmp/node_modules/@lando/lagoon /plugins/@lando/lagoon"

# Rebuild the plugin cache
lando --clear

# @TODO
# @NOTE: This doesn't actaully work yet
hyperdrive install @lando/lagoon

You should be able to verify the plugin is installed by running lando config --path plugins and checking for @lando/lagoon. This command will also show you where the plugin is being loaded from.