Skip to content

Recipes

FedMS ships several Drupal recipes — bundles of configuration that add optional features to a tenant instance. Each recipe is a separate Composer package under fedms-recipe/*.

The shipped recipes are:

Recipe Purpose Composer package
Send Email Easy-Email-based notifications fedms-recipe/send_email
Zoom Video Zoom virtual-platform integration fedms-recipe/zoom_video
Attachment Recording Per-attachment video recording fedms-recipe/attachment_recording

How recipes work

A Drupal recipe is a manifest (recipe.yml) plus a set of config files. Applying a recipe:

  1. Installs the modules it depends on.
  2. Imports the config it provides.
  3. Optionally collects input (e.g. an API key) and writes it to config.

Recipes are applied once. Re-applying does nothing if the config is already present. If you want to update a recipe's content, the update typically lands in a code release rather than a re-apply.

Applying a recipe

On a managed-SaaS instance, recipes are applied by the operations team on request.

For self-hosted instances:

1
2
l3d composer require fedms-recipe/send_email
l3d drush recipe ../recipes/fedms-recipe-send_email

Replace send_email with the recipe you want. The exact path depends on your Composer installer configuration; the l3d ahoy fedms install script handles this for fresh installs.

Send Email

Adds the Easy Email module and a set of starter email templates.

After install, manage templates at /admin/structure/easy_email_type. See Email templates.

Zoom Video

Adds the zoom_video Drupal module and configures it to use your Zoom app's Client ID and Client Secret.

Inputs collected on apply:

  • zoom_client_id
  • zoom_client_secret

Get these from your Zoom Marketplace app — see https://marketplace.zoom.us/develop/createLegacy.

After install, sessions of types you configure can launch directly into Zoom from the Launch button. See fedms/components/federation#32.

Attachment Recording

Adds per-attachment video recording capability. The default attachment type gets a field_video ready to receive recordings.

Use this for:

  • Session recordings.
  • Per-delegate video submissions (e.g. role-play exercises).
  • Speaker testimonials.

Site-level recipes (separate from FedMS)

The Amplius site ships two site-level recipes beyond the FedMS framework, which administrators of the LakeDrops platform may recognize:

Recipe Purpose
alerts LakeDrops alerting infrastructure (pf_alerta, push framework).
monitoring LakeDrops monitoring infrastructure (CrowdSec, security review, login security).

These are part of the operational stack, not part of FedMS itself, and live under recipes/ in the site repository.

Future recipes

The roadmap includes:

If your organization has a workflow that would make a good recipe, please raise an issue at fedms/support.

Next steps