Important notes

1. This setup expects Lando to be installed and ready to go on your machine
2. This setup expects Magento's stock nginx.conf.sample to exist in Magento's project root.
   • NOTE: If you follow the Quick Setup instructions this file will be automatically downloaded
3. You may experience performance gains by:
   • Adding Redis, Elasticsearch, etc.. These services can easily be added following Lando's documentation.
   • For Windows & MacOS, Lando has an experimental feature that disables file synchronization between the host and container that can be implemented as shown below. However, you will need to copy these files manually to your host if using an IDE that depends on the directories you exclude.

     # Add to .lando.yml as a root property
     # Must be implemented prior to `lando start`. Otherwise, modification requires `lando rebuild`
     excludes: # **Warning:** Experimental Lando Feature
        - vendor # Optionally disable syncing of this directory
        - '!vendor/my-company/my-dev-module' # Restore syncing to a subdirectory of an excluded directory
        - node_modules
        - '!node_modules/my-company/my-dev-module'
        # Improve performance of Magento-writable directories
        - pub/media
        - pub/static

Quick Setup

1. Clone this template:git clone [email protected]:improper/lando-magento2-template.git && cd lando-magento2-template
2. Download Magento: lando magento:download
   • Your auth.json will be automatically generated.
   • Alternatively, you can pass parameters:

     lando magento:download \
        --mage-edition "Open Source" \
        --mage-version 2.3 \
        --mage-access-key-public "3***" \
        --mage-access-key-private "2***" \
        --github-token "1***"

3. Launch your new store and deploy the database automatically:

   lando start or lando rebuild (rebuild only to force install missing php extension.  Usually happens when you havnt renamed the app and youve got existing containers hangin around. lando list to check)
   lando composer install
   lando magento:setup:quick # Optional: ----use-sample-data 

You should now be able to access your local installation of Magento: https://magento2.lndo.site/ (or whatever proxy value you have set in your lando.base.yaml file)

If you have followed the quicksetup without providing any other parameters be aware your Magento database will have no base_url or base_url_secure values yet. This can and in most cases will cause a redirect loop when acessing the Magento admin page.

All lndo.site sub-domains https://magento2.lndo.site/ are real URL's, therefor wont be available offline. Alternativly localhost.xxxx URL's are available offline but change with every lando rebuild. If your running localhost URL's you will need to update your Magento URL's after each rebuild and provide the new localhost values.

lando magento setup:store-config:set --base-url="" --base-url-secure=""

Customizing Lando

This repository ships with with a .lando.base.yaml. To modify your Lando setup, you have a few options:

• Remove and replace .lando.base.yaml
• Extend .lando.base.yaml with your own .lando.yml or .lando.local.yml
  • This will allow you to override any of the properties found within .lando.base.yaml. You can rename the project, add new tooling, disable existing tooling and add/remove/modify services as needed.

For best practices, please refer to Lando's landofile documentaion

Bonus Info

Run lando to see available shortcuts such as lando magento and lando composer!

lando magento:setup:quick is an alias for lando magento setup:install and is pre-configured to setup the Lando DB connection.

• Defaults to developer mode.
• See lando magento:setup:quick --help for additional configuration options.
• For the sake of shortcuts, lando magento:setup:destroy is also available.

Where is my admin?

If you did not pass specify arguments for lando magento:setup:quick, you will probably want to know your admin URI and to create an admin user.

• Fetch Admin URI: lando magento info:adminuri
• Create admin user: lando magento admin:user:create