Trial Deployment Quick Start
A rapid deployment process to try out the Form.io Platform.
This guide will walk new users through the process of getting a trial environment of Form.io Enterprise deployed locally. It will guide users through the process of
acquiring a license
obtaining the tools required
configuring the local environment
deploying Form.io Enterprise
Get A License
First, get the license required to use Enterprise Platform. If a license has already been issued, jump to the next section.
Users can get a trial license by scheduling a quick 30 minute call or contacting [email protected] to request a license.
Once a license key has been provided, save it somewhere it will be easy to paste into the configuration files that will be downloaded later.
Get Docker
Next, the local machine must have Docker installed. If Docker is already installed and you're familiar with using it, skip to the next section.
Form.io uses Docker Compose to define and run containers that deploy the Enterprise platform on a local machine. Users unfamiliar with Docker should refer to the Get Docker section of the Docker Help.
Ensure Docker is installed and running before proceeding.
Get Docker Compose Files
Docker Compose files are .yaml files that define a collection of Docker containers. A Compose file will describe each container, the resources allocated to it, and the network that connects them.
Open the Form.io Deployment Examples repo on GitHub and download the contents of the Quickstart directory to the local machine. It should contain the following:
/volumes/caddy
docker-compose.yml
.env.example
Prepare the .env file
Open the .env file in a text editor.
Enter the Enterprise license key provided by Form.io in spot marked
LICENSE_KEY.Make note of the default credentials. it is not necessary to change them for this local trial deployment.
Rename the file as
.env
Spin up the containers with Docker Compose
Open a terminal at the directory that contains the docker-compose.yml and .env files.
Run the following command:
This starts the Form.io platform containers and the MongoDB database containers locally. The Docker Compose command automatically pulls the necessary values from the .env file.
Authenticate into the Portal
From a browser, navigate to http://localhost:3000
Log in with the admin account. The default credentials are [email protected] / CHANGEME. These are set in the .env file.
Form.io Enterprise is Deployed
The Developer Portal should load. The Portal Base project, used for configuring and administering the Portal should be available by default.
Where To Go Next
To learn more about a typical Form.io deployment, begin with the Deployment Overview
To learn more about using the Form.io Platform, check out the Getting Started guide or the Form Building.
Last updated
Was this helpful?