On Koa

This is the official documentation of the @forestadmin/agent Node.js agent.

If you already have an application running using Koa ↗, the easiest way to attach the Forest Admin agent would use the mountOnKoa function, just like in the following example:


const { createAgent } = require('@forestadmin/agent');
const { createSqlDataSource } = require('@forestadmin/datasource-sql');
const Koa = require('koa');

const agent = createAgent({
  authSecret: process.env.FOREST_AUTH_SECRET,
  envSecret: process.env.FOREST_ENV_SECRET,
  isProduction: process.env.NODE_ENV === 'production',

const app = new Koa();

// This function must be called before other middlewares.


Last updated