Create your agent

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

const { createAgent } = require('@forestadmin/agent');

const agent = createAgent({
  // Mandatory options (those will be provided during onboarding)
  authSecret: process.env.FOREST_AUTH_SECRET,
  envSecret: process.env.FOREST_ENV_SECRET,
  isProduction: process.env.NODE_ENV === 'production',

  // Optional variables
  customizeErrorMessage: ...,
  forestServerUrl: ...,
  logger: ...,
  loggerLevel: ...,
  permissionsCacheDurationInSeconds: ...,
  prefix: ...,
  schemaPath: ...,
  typingsMaxDepth: ...,
  typingsPath: ...,
  maxBodySize: ...,

Mandatory variables

All mandatory variables are provided as environment variables during onboarding.

Your agent cannot be started without them, and no default values are provided.

authSecret (string, no default)

This variable contains a random secret token which is used to sign authentication tokens used in request between your users and your agent.

It is generated during onboarding, but never leaves your browser, and is not saved on our side.

Never share it to anybody, as that would allow attackers to impersonate your users on your agent!

envSecret (string, no default)

This variable contains a random secret token which is used to authenticate requests between your agent and our servers.

Unlike the authSecret, it is stored in our database, so it can be privately shared with Forest Admin employees.

Never share it publicly, as it would allow attackers to impersonate your agent with our servers. That would not cause any data leak, but opens the possibility for attackers to cause denial of service.

isProduction (boolean, no default)

In development mode the agent has a few extra behaviors (when using isProduction: false)

  • At startup, the agent will print the URL of all mounted charts

  • At startup, the agent will update the .forestadmin-schema.json and typings files.

  • When exceptions are thrown, a report will be printed to stdout.

Optional variables

customizeErrorMessage (function, defaults to null)

When unexpected errors are raised in the agent code during a request, the error will be logged (using options.logger), but in the admin-panel, the final user will get a default message 'Unexpected error'.

This is done as to:

  • Prevent error message from leaking internal information about the agent (credentials, ...).

  • Prevent technical/cryptic error messages to show in the frontend.

This behavior can be customized.

  // ...
  customizeErrorMessage: error => {
    if (error instanceof SequelizeConectionRefusedError) {
      return (
        'Failed to connect to the database, ' +
        'contact John at 06 12 34 56 78 and tell him to reboot the server'

    return (
      'Unexpected error, ' +
      'contact Jane at 06 87 65 43 21 and tell her to get it fixed.'

forestServerUrl (string, defaults to '')

This variable should be used only for customers using the self-hosted version of Forest Admin ↗.

It allows to specify the URL at which Forest Admin servers can be reached.

  // ...
  forestServerUrl: '',

logger (function) and loggerLevel (string, defaults to 'Info')

Forest Admin encourages customers to use In-app installations.

You may want to have control of the logger which is used by Forest Admin.

This configuration key allows to format and route logs to a logging service, instead of printing them in stdout.

  // ...
  loggerLevel: 'Info', // Valid values are 'Debug', 'Info', 'Warn' and 'Error'
  logger: (logLevel, message) => {
    console.error(logLevel, message);

permissionsCacheDurationInSeconds (number, defaults to 15 minutes)

Forest Admin administrators can restrict operations which final users can perform ↗.

Those permissions are enforced both in the frontend, and in your agent.

This configuration variable allows to customize how often the agent should ask the server to provide the permissions table.

  // ...
  permissionsCacheDurationInSeconds: 15 * 60,

prefix (string, default to empty string)

This variable adds a prefix to the url at which routes are locally mounted on your application. It is mostly used for customers which wish to mount multiple agent instances on the same Node.js process (for setups using multiple Forest Admin projects).

Note that this variable has no influence on the base URL that will be used by your users to reach the agent: it is determined only by the application URL provided during onboarding and deployment.

This is done so that customers using reverse proxies can implement their routing table as they see fit.

Desired Local URLsDesired Public URLsHow to configure your agent


prefix = '' agentUrl = ''


prefix = '' agentUrl = ''


prefix = 'prefix' agentUrl = ''


prefix = 'local-prefix' agentUrl = ''

  // ...
  prefix: 'api',

schemaPath (string, defaults to '.forestadmin-schema.json')

This variable allows to choose where the .forestadmin-schema.json file should be written in development, and read from in production.

This allows to:

  • Improve git repository organisation

  • Work around read only folders (for instance, if developing using a read only docker volume).

  • Have flexibility when using custom builds in production (code minification, ...)

  // ...
  schemaPath: '/volumes/fa-agent-configuration/schema.json',

typingsPath (string, defaults to null), typingsMaxDepth (number, defaults to 3)

This variable allows to choose where the typing file should be written in development.

import { createAgent } from '@forestadmin/agent';
import { Schema } from './typings';

  // ...
  typingsPath: './typings.ts',
  typingsMaxDepth: 5,

maxBodySize (string default to '50mb')

This variable allows to increase the request body limit size.

To be used when you want to handle big files on smart action and so on.

Last updated