1. Plugin overview

Plugins are a catch-all term for YAML objects that can be "plugged into" Ferrite at runtime. These objects come from a list. All plugins use the YAML format for Ferrite v0.7 and up.

If you want to create legacy JSON sources, please see the appropriate Legacy section of this Wiki.

The plugin format can change at any time, so please make sure your plugins are tested and adjust to new changes on each app version. Nightly testing is highly recommended!

1a. Plugin lists

Source lists must adhere to the following template. All of these fields are required to properly add a source to Ferrite.

Example

name: # Plugin list title
author: # Plugin list author
sources: # Add your source blocks
actions: # Add your action blocks

Fields

name

Required String: The name of the source list

author

Required String: Who made the source list

sources

Optional Array of sources: The array of source objects

actions

Optional Array of actions: The array of action objects