Include/exclude models

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Include/exclude models

By default, all models declared in your app are analyzed by the Forest Admin agent in order to display them as collections in your admin panel.

You can exclude some of them from the analysis to never send their metadata to Forest Admin. By doing this, these models will therefore never be available in your admin panel.

To do so, add the following code to either define which models are included or excluded.

SQL

Include models

middlewares/forestadmin.js

...

app.use(require('forest-express-sequelize').init({
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  objectMapping,
  connections,
  includedModels: ['customers']
}));

...

Exclude models

middlewares/forestadmin.js

...

app.use(require('forest-express-sequelize').init({
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  objectMapping,
  connections,
  excludedModels: ['documents', 'transactions']
}));

...

Mongodb

Include models

middlewares/forestadmin.js

...

app.use(require('forest-express-mongoose').init({
  modelsDir: __dirname + '/models',
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  sequelize: require('./models').sequelize,
  includedModels: ['customers']
}));

...

Exclude models

middlewares/forestadmin.js

...

app.use(require('forest-express-mongoose').init({
  modelsDir: __dirname + '/models',
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  sequelize: require('./models').sequelize,
  excludedModels: ['documents', 'transactions']
}));

...

Rails

/config/initializers/forest_liana.rb

ForestLiana.env_secret = Rails.application.secrets.forest_env_secret
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret

# ...

# in the [] you may add the precise list of all models you want to see in Forest
ForestLiana.included_models = ['Customer'];

# or second possibility below :

# in the [] you may add the precise list of all models you do not want to see in Forest
ForestLiana.excluded_models = ['Document', 'Transaction'];

Django

/project/settings.py

# ...
FOREST = {
    'FOREST_ENV_SECRET': os.environ.get('FOREST_ENV_SECRET'),
    'FOREST_AUTH_SECRET': os.environ.get('FOREST_AUTH_SECRET'),
    # in the [] you may add the precise list of all models you want to see in Forest
    'INCLUDED_MODELS': ['Customer']
    # in the [] you may add the precise list of all models you do not want to see in Forest
    'EXCLUDED_MODELS': ['Customer', 'Transaction'],
}

Laravel

config/forest.php

<?php

use App\Models\Customer;
use App\Models\Document;
use App\Models\Transaction;

return [
    ...
    // in the [] you may add the precise list of all models you want to see in Forest
    'included_models' => [Customer::class],
    // in the [] you may add the precise list of all models you do not want to see in Forest
    'excluded_models' => [Document::class, Transaction::class],
];