wunderio/lando-drupal

Wunder's extendable template for Lando Drupal projects.

0.7.0 2024-01-17 08:33 UTC

Requires

• composer-plugin-api: ^2.0
• drupal/core: ^10

Requires (Dev)

• composer/composer: ^2.0

GPL-2.0-or-later

• Hannes Kirsman

README

This is a template for Lando Drupal projects for defining the base Lando setup for Drupal. It creates .lando.base.yml file and .lando/core/ folder. You still need .lando.yml to define minimally the name and recipe parameter.

Installation

1. Move your current .lando/* files to .lando/custom/ and change the references in .lando.yml. Next step will add new .lando/core/ folder.

2. Install the composer package:

   composer require wunderio/lando-drupal --dev
   

3. Add changes to GIT:

   git add .lando/core/ &&
   git add .lando/custom/ &&
   git add drush/sites/ &&
   git add .lando.base.yml &&
   git add -p composer.json composer.lock
   

4. Depending on your project either create or update your .lando.yml.

   If you are creating new project, then you need to create .lando.yml file with the following:

   name: your-project-name
   recipe: drupal10
   

   In case you already had .lando.yml then remove anything that already exists in .lando.base.yml.

5. Optionally enable custom extensions eg node and then rebuild Lando:

   lando load-wunderio-lando-drupal-extensions node
   lando rebuild
   

   All available extensions are listed at https://github.com/wunderio/lando-drupal/tree/main/extensions

6. We need to migrate build steps due to the inability to overwrite them from .lando.yml. For instance, in the current setup in .lando.base.yml file we have this:

   services:
     appserver:
       build:
         - "/app/.lando/core/_run-scripts.sh services-appserver-build.sh"
   

   The above executes services-appserver-build.sh script from .lando/core/ folder, and it runs composer install.

   If now in your .lando.yml you have also composer install in the same build step, then this is also executed. Basically Lando stacks the commands in build steps.

   services:
     appserver:
      build:
        - "composer install"
   

   To resolve this issue, the recommended approach is to remove the build step from .lando.yml. Instead, copy the .lando/core/services-appserver-build.sh file to your .lando/custom/ folder. Then, customize it to suit your preferences. The line in .lando.base.yml - '/app/.lando/core/_run-scripts.sh services-appserver-build.sh' - will first check for the presence of services-appserver-build.sh in the .lando/custom/ folder. If it's not found, it will execute it from .lando/core/."

Overview

Configuration Overview:

• Name: drupal-project
• Recipe: drupal10

PHP and Web Server:

• PHP Version: 8.1
• Web Server: Nginx
• Webroot: web

Database:

• Database Version: MariaDB 10.3

Composer:

• Composer Version: 2

Xdebug:

• Xdebug Mode: Off (enabled by lando xdebug command)

Custom Configuration Files:

• Custom PHP configuration file: .lando/core/php.ini
• Custom database configuration file: .lando/core/my.cnf

Tooling Commands:

• composer: Runs Composer commands.
• grumphp: Runs GrumPHP commands.
• phpunit: Runs PHPUnit commands with custom options.
• regenerate-phpunit-config: Regenerates fresh PHPUnit configuration.
• varnishadm: Runs varnishadm commands.
• xdebug: Loads Xdebug in the selected mode.

Tooling commands that are defined as scripts (.lando/core/tooling-*.sh files) can be overwritten by adding them in .lando/custom/ folder with the same name. Currently, there are 3 scripts:

• .lando/core/tooling-phpunit.sh
• .lando/core/tooling-regenerate-phpunit-config.sh
• .lando/core/tooling-xdebug.sh

Services:

• appserver: Configuration for the primary application server.
• • Sets the timezone to "Europe/Helsinki."
• • Defines environment variables including HASH_SALT, ENVIRONMENT_NAME, DB_NAME_DRUPAL, DB_USER_DRUPAL, DB_PASS_DRUPAL, DB_HOST_DRUPAL, DRUSH_OPTIONS_URI, VARNISH_ADMIN_HOST, XDEBUG_MODE, and PHP_IDE_CONFIG.
• • Provides PHPUnit settings for headless Chrome.
• adminer: Adminer database management tool.
• chrome: Configuration for running Chrome WebDriver.
• mailhog: Configuration for MailHog, a mail testing tool.
• proxy: Configuration for proxy settings.

Service commands that are defined as scripts (.lando/core/services-*.sh files) can be overwritten by adding them in .lando/custom/ folder with the same name. Currently, there are 2 script:

• .lando/core/services-adminer-run-as-root.sh
• .lando/core/services-appserver-build.sh

Custom Events:

• post-db-import: Custom event to rebuild Drupal cache and log in the local user after a database import.

Environment File:

• Uses an environment file located at .lando/contrib/.env.

Lando Version:

• Tested with Lando version v3.18.0.

Notes:

• This Lando configuration is designed for a Drupal 10 project.
• It includes custom PHP and database configuration files.
• Tooling commands are provided for Composer, GrumPHP, PHPUnit, Varnishadm, and Xdebug.
• Services are configured for the primary application server, Chrome WebDriver and MailHog.
• Custom events are defined to perform actions after a database import.
• The configuration is tested with Lando version 3.18.0.
• Please make sure to adjust any paths or configurations as needed for your specific project and environment.

Experimental

Snapshot tool

Based on DDEV snapshot tool, we've added experimental tool also here. It's by far not so complete tooling as in DDEV. Hopefully this will get to Lando officially one day - we've created issue at lando/mariadb#37

Create named snapshot:

lando snapshot --name foobar

Or create snapshot with timestamp:

lando snapshot

Restore the snapshot named foobar

lando snapshot restore foobar
lando restart