External Plugins #

You can extend Kuzzle's features via plugins.

Plugins are intended to be reused between several applications by proposing generic features.

Plugins allow you to achieve two main goals:

• extension and modification of the API
• integration of an authentication strategy

These feature categories are not exclusive and although it is not recommended, a plugin can embed features belonging to the 2 categories.

Inside a plugin #

Plugins are classes that must implement the Plugin abstract class.

They can create new controllers or register pipes and hooks like applications.

In addition to the standard features available in an application, plugins can also integrate authentication strategies.

Use a plugin #

Generally, plugins are distributed as NPM packages.

It is possible to use the Backend.plugin.use method to use a plugin in your application.

This method takes an instance of the plugin as a parameter:

import PluginS3 from 'kuzzle-plugin-s3';

// [...]

app.plugin.use(new PluginS3());

It's possible to override the original plugin name by passing a new one in the option object:

import PluginS3 from 'kuzzle-plugin-s3';

// [...]

app.plugin.use(new PluginS3(), { name: 'minio' });