Installation
This is a step-by-step tutorial on how to install Forest Admin
Start your installation on forestadmin.com, by clicking "Install Forest Admin":
You'll be taken to a sign-up form to create your account:
... and project:
You may then choose between several types of datasources:
  • Rails, Express/Sequelize and Express/Mongoose will install Forest Admin directly into your app
  • PostgreSQL, MySQL, MicrosoftSQL and MongoDB will generate an independent admin backend

Install using a database as your datasource

TLDR: Check out our video to see how to install Forest Admin using a database as a datasource in under 2 minutes. Otherwise, read on below the video!
Next step asks you for your database credentials to help us generate the installation command you'll run on last step:
You can use a local or remote database, but note that this database will be used with your Development environment.
Next, choose an installation method (NPM or Docker) and paste the commands in your terminal:

Available installation options for the above step

Docker
NPM
Option
Description
APPLICATION_HOST
Hostname of your admin backend application.
APPLICATION_PORT
Port of your admin backend application.
DATABASE_SSL
Use SSL for database connection (true | false).
DATABASE_SCHEMA
Your database schema.
DATABASE_URL
The database credentials with a connection URL.
FOREST_EMAIL
Your Forest Admin account email.
FOREST_TOKEN
Your Forest Admin account token.
FOREST_PASSWORD
Your Forest Admin account password. Although not recommended, you can use this instead of FOREST_TOKEN. Wrap it in double quotes if it contains special characters.
Option
Description
-c, --connection-url
The database credentials with a connection URL.
-S, --ssl
Use SSL for database connection (true | false).
-s, --schema
Your database schema.
-H, --application-host
Hostname of your admin backend application.
-p, --application-port
Port of your admin backend application.
-h, --help
Output usage information.

Install using a Rails app as your datasource

To install Forest Admin within your existing Rails app, we'll need your local app URL to detect when your app is successfully running with Forest Admin in it:
Then run the following commands:
When you're done, we should automatically detect it (thanks to the URL you provided) and redirect you to your admin panel!

Install using a Express/Sequelize app as your datasource

To install Forest Admin within your existing Express/Sequelize app, we'll need your local app URL to detect when your app is successfully running with Forest Admin in it:
Then run the following commands:
When you're done, we should automatically detect it (thanks to the URL you provided) and redirect you to your admin panel!

Install using a Express/Mongoose app as your datasource

To install Forest Admin within your existing Express/Mongoose app, we'll need your local app URL to detect when your app is successfully running with Forest Admin in it:
Then run the following commands:
When you're done, we should automatically detect it (thanks to the URL you provided) and redirect you to your admin panel!

Install using Django as your datasource

To install Forest Admin within your existing Django project, we'll need your local app URL to detect when your project is successfully running with Forest Admin in it:
Then install the django-forestadmin app (preferably in a python virtual environment) and add the following given settings.
When you're done, we should automatically detect it (thanks to the URL you provided) and redirect you to your admin panel!

Help us get better!

Finally, when your local server is started, you should be automatically redirected:
Rate us so we can improve, then go to your newly created admin panel 🎉
If you installed using a local database, your generated admin backend will havehttp://localhost:3310 as an endpoint (Notice the HTTP protocol). This explains why, if you try to visit https://app.forestadmin.com, you will be redirected to http://app.forestadmin.com as this is the only way it can communicate with your local admin backend.
Next up, we suggest you go through our Setup guide.
Last modified 1mo ago