Documentation

Install a Plugin

Many hosting environments allow you to install plugins using the Craft Control Panel directly within your staging or production environments.

However, this is generally considered bad practice as it makes it very difficult to keep your local, staging and production environments in sync.

As well as being bad practice, installing plugins within staging and production is incompatible with load balanced environments like Servd. Your installation request will only run on one of potentially many running instances of your application, leaving each of them in an incompatible state.

For these reasons Servd requires users to follow a uni-direction development flow, starting with local development where installing plugins is fine.

Install a Plugin Locally

  1. Get your project up and running in a local development environment. This might be Nitro, Docker or MAMP. Any of these are fine as long as your Craft project is running on your local machine.

  2. Using the Craft Control Panel's Plugin Store, or `composer` on the command line, install the plugin you need. If you are using Project Config to sync changes between environments, make sure you've also installed and enabled the plugin in Craft's settings.

  3. Using `git` on the command line, or a visual git client, check to make sure your composer.json and composer.lock files (and optionally your project config files) have been updated and are ready to be committed.

  4. Create a new commit and push your git repo.

  5. Build a new bundle in Servd from your new commit and deploy it to one of your environments.

  6. Your plugin is now available to use in your Servd project!