Skip to content

Server Plugins

trigg edited this page May 23, 2021 · 1 revision

Some server features will be better to separate and have as opt-in. Partly due to security considerations and partly to not pollute the core server unnecessarily.

The Plugin API is not stable and will not be considered stable for a while yet. I would highly appreciate input from anyone wishing to use it.

Current State

Enabling a Plugin

See Configuration

Writing a Plugin

Add a JS file to plugin/, it should consist of one object which is exported back.

Functions

start(app) Is called shortly after the express app is created. Use this chance to hook and POST, GET, PUT etc on the webserver. No conflict resolution is done by Rebuttal currently.

Future

An issue tag is used for any requests, suggestions, and issues.

Issues

Longer term an event-based system will probably be necessary to catch, cancel or alter any event happening on server.

Clone this wiki locally