Installing extensions

Grow has a powerful and simple extension system that enables you to extend the functionality of Grow with extensions.

Installing extensions

Grow supports an extensions.txt file as part of the pod. When the file is present the grow install command will handle the installation of the extensions.

# extensions.txt

The extensions.txt follows the same format as a normal pip requirements.txt style. This means you can install pip packages or directly from version control.

See the documentation for each extension for instructions on how to properly configure the extension and what settings to add to the podspec.yaml file.

Finding extensions

Extensions can be found by searching for grow-ext- in pypi or github.

Custom extensions

When possible, extensions should be created as separate repositories and use the extensions.txt file to reference the extension. This helps the extensions be reusable across projects.

Repositories for grow extensions should be named using the grow-ext-<extension name> format. For example: grow-ext-budou, grow-ext-google-forms, grow-ext-contentful.

In some cases it makes more sense to write the extension inside the same repository as it is very specific to the site. The same principles apply just put the extension files into a subdirectory inside the extensions/ directory.

Extensions are standard Python modules, so your site's extensions folder must be set up appropriately, with files:

├──  /extensions                   # All your extensions
|    ├──  /             # Empty file, required by Python
|    └──  /extension_name          # Subfolder for custom extension
|         ├──  /        # Empty file, required by Python
|         ├──  /  # Extension code