Skip to content
landoPublic

Repository files navigation

Upsun Lando Plugin

This is the official Lando plugin for Upsun (formerly Platform.sh). When installed it...

  • Runs Upsun Flex (.upsun/config.yaml) and Upsun Fixed (.platform.app.yaml + .platform/) projects, including Adobe Commerce Cloud
  • Builds the applications and services in your Upsun config (unsupported types produce a warning), with the same PLATFORM_* variables and relationships your app gets on Upsun
  • Runs your mounts, hooks and workers, and your crons when config.crons is enabled
  • Serves your routes and redirects on local *.lndo.site URLs and catches outgoing mail with Mailpit
  • Pulls and pushes databases and files with lando pull and lando push (not available for Adobe Commerce Cloud projects)
  • Adds the Upsun CLI (upsun, or platform for Fixed projects), lando db-import / lando db-export, and Xdebug toggles

Of course, once you're running your Upsun project with Lando you can take advantage of all the other awesome development features Lando provides.

Basic Usage

Add a Landofile next to your .upsun/ or .platform/ directory:

name: my-project
recipe: upsun

Then start the app and grab your data:

lando start
lando pull

Starting from a project that only exists on Upsun? lando init --source upsun (Flex) or lando init --source platformsh (Fixed) clones it and writes the Landofile for you.

For more info you should check out the docs:

Installation

lando plugin-add @lando/upsun

Issues, Questions and Support

If you have a question or would like some community support we recommend you join us on Slack.

If you'd like to report a bug or submit a feature request then please use the issue queue in this repo.

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Development

git clone https://github.com/lando/upsun.git && cd upsun
npm install

See Development and Architecture for how the plugin is put together.

Testing

# Lint the code
npm run lint

# Lint, typecheck and run the unit tests
npm test

# Run the Leia tests in examples/ (needs Docker)
npm run test:leia

Releasing

Publish a GitHub release. The release workflow publishes it to npm, and prereleases go out under the edge tag.

Releases

Sponsor this project

Used by

Contributors

Languages