« Web Server MENU ActivityPub Web Handler »

Web Handlers

Web handlers provide a way to easily add additional routes to your Web Server.

Built in Web Handler Modules

• WebFinger: Provides basic WebFinger (RFC7033) support.
• System General: Serves user avatars.
• NodeInfo2: Handles NodeInfo2 requests.
• ActivityPub:

Building Your Own

Custom web handlers are an advanced, internal extension point. By default the system loads handlers from core/servers/content/web_handlers/ — the same directory as the built-in handlers. You can override the search path via paths.webHandlers in config.hjson if you want to keep custom code out of the ENiGMA source tree.

Skeleton

Inherit from WebHandlerModule, export moduleInfo and getModule, then register your route(s) inside init():

// mods/web_handlers/my_handler.js
const WebHandlerModule = require('../../core/web_handler_module');

exports.moduleInfo = {
    name: 'My Handler',
    desc: 'Does something custom',
    author: 'You',
    packageName: 'com.example.my-handler',
};

exports.getModule = class MyWebHandler extends WebHandlerModule {
    constructor() {
        super();
    }

    init(webServer, cb) {
        super.init(webServer, err => {
            if (err) { return cb(err); }

            this.webServer.addRoute({
                method: 'GET',
                path:   /^\/my-path\/?$/,
                handler: this._handleRequest.bind(this),
            });

            return cb(null);
        });
    }

    _handleRequest(req, resp) {
        const body = JSON.stringify({ hello: 'world' });
        resp.writeHead(200, {
            'Content-Type':   'application/json',
            'Content-Length': Buffer.byteLength(body),
        });
        resp.end(body);
    }
};

Enabling Your Handler

Add an entry under contentServers.web.handlers in config.hjson. The key is the camelCase form of your moduleInfo.name:

contentServers: {
    web: {
        handlers: {
            myHandler: {
                enabled: true
            }
        }
    }
}

Restart ENiGMA and your route will be registered alongside the built-in handlers.

« Web Server ActivityPub Web Handler »