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:

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
Docker

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.

NPM

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.

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.