Laravel specific settings

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.

Laravel specific settings

Publish the configuration

If you would like to publish the configuration of the package, you can run the following command:

php artisan vendor:publish --provider="ForestAdmin\LaravelForestAdmin\ForestServiceProvider" --tag=config

Send apimap on deploy

When you want to deploy your forest admin to production (or other branch different of your local environment), you must run the following command:

php artisan forest:send-apimap

This command must be run each time you deploy your application on production.

But you can avoid it and activate the mode "apimap send auto" with the environment variable FOREST_SEND_APIMAP_AUTOMATIC.

You have 2 solutions:

• add FOREST_SEND_APIMAP_AUTOMATIC to your .env file and set to true

• publish your configuration and set to true the send_apimap_automatic into config/forest.php

However, beware that if you activate this configuration, you must refresh your forest dashboard after you deploy on production.

Depending on your configuration, refreshing the whole application may take a few seconds after your deployment. Using the environment variable is recommended for small projects, whereas the php artisan command is better suited when dealing with bigger projects.

Onboard with Laravel Valet

When using Laravel Valet, you must configure to SSL.

valet secure YOUR_PROJECT_NAME

Then declare the corresponding url in your .env file into the APP_URL variable.

Don't forget the S of https

APP_URL=https://YOUR_PROJECT_NAME.test

With Laravel Valet the apimap is not updated automatically. We recommend that you set your environment variable FOREST_SEND_APIMAP_AUTOMATIC to true. More information in the previous chapter Send apimap on deploy

Customize models directory structure

The agent fetches the models into the directory specified by the models_directory configuration.

All class files that doesn't extends the Illuminate\Database\Eloquent\Model are ignored.

By default, the value is the main models directory of Laravel 'app/Models', but you can change this configuration and add one or more models directories.

Example

'models_directory'    => ['app/StripeModels', 'app/CustomerModels'],

You don't have to specify all the subdirectories, the agent will retrieve them for you. For example, imagine with the directory structure : app/StripeModels/Billing & app/StripeModels/Orders, you have just to specify the main directory app/StripeModels.

You can also include/exclude models. More information here