Comment on page
Many developers prefer to deploy new software within their local environment to explore the new technology and kick the software tires around. Any License can be used for your Local deployment, while the Developer License is restricted to Local Deployments only. The License Keys enable developers to spin up and down instances of the Form.io platform locally on the developer's machine allowing for local development and testing without affecting the remotely deployed platform configuration.
Form.io utilizes Docker Compose to define and run the containers necessary to locally install the Form.io Enterprise platform. It's recommended you review the Prepare Your Environment section of the Self-Hosted Deployment guide to learn more about Docker Desktop before continuing with the Local Deployment walkthrough.
Open the zipped folder within your preferred IDE, click the
.envfile, and locate the following line.
Change YOURLICENSE to the Enterprise License key distributed to you by Form.io.
After saving the .env file, change your terminal directory to your deployment folder and run the following command.
docker-compose up --detach
This will start the Form.io platform containers and Mongo Database within your local machine.
After the installation process has been completed, navigate to the following URL to access the Local Deployment.
To authenticate into the platform, use the following credentials:
Edit the .env file to modify the authentication credentials for the local deployment.
All MongoDB data as well as PDF files are stored within the local
datadirectory which is part of the deployment folder.
The next section will detail additional software you can install to facilitate things like File Storage and Container Management within your local environment.