LogoLogo
Getting StartedDevelopersDeployment GuideGet Help
  • Quick Links
  • Welcome to Form.io
    • Getting Started With Form.io
    • Launch a Form
    • Overview of Form.io
  • Developer Tool Ecosystem
    • PDF Solution
    • Enterprise Form Builder
    • Form View Pro
    • The Security Module
    • Accessibility Compliance Module
    • Developer License
    • SQL Connector - Deprecated
    • Integration Libraries
    • Form.io CLI Tool
  • User Guide
    • Introduction
    • Form.io Developer Portal
    • Teams
    • Projects
      • Project UI
      • Project Settings
      • Stages
      • Multi-Tenancy
    • Resources
      • ResourceJS
    • Forms
      • Form Creation
      • Form Types
      • PDF Forms
      • Embedding a Form
      • Form Revisions
      • Form Settings
    • Form Building
      • Form Builder UI
      • Form Components
        • Component Settings
        • Basic Components
          • Resource as Select Component Data Source
        • Advanced Components
        • Layout Components
        • Data Components
        • Premium Components
          • Nested Forms
        • Custom Components
      • Logic & Conditions
      • Existing Resource Fields
      • Actions
    • Submissions
      • Accessing Submissions
      • Importing Submissions
    • Form.io eSignature - Coming Soon
    • Form.io Reporting Module
    • PDF Template Designer
    • Form View Pro
    • Form Manager
    • Enterprise Form Builder Module
  • Developer Guide
    • Introduction
      • Application Development
      • API Documentation
    • Form Development
      • Form Renderer
      • Form Builder
      • Form Embedding
      • Form Evaluations
      • Form Templates
      • Custom Components
      • Translations
    • JavaScript Development
      • JavaScript SDK
      • JavaScript Frameworks
      • JavaScript Utilities
    • Authentication and Authorization
      • SAML
      • OAuth
      • LDAP
      • Resource Based Authentication
      • Email Authentication
      • Two-Factor Authentication
    • Roles and Permissions
      • Field Match-Based Access
      • Field-Based Resource Access
      • Group Permissions
    • Integrations
      • Email Integrations
      • File Storage
      • Google Developer Console
      • eSign Integrations
      • Relational Databases
    • Modules
    • Fetch Plugin API
    • CSS Frameworks
    • Offline Mode
    • Audit Logging
  • Deployments
    • Self-Hosted Deployment
      • Local Deployment
        • Local File Storage
      • Kubernetes
      • Cloud Deployment
        • AWS Deployment
          • AWS Lambda
          • Form.io/AWS Elastic Beanstalk End-To-End Encrypted Deployment
        • Azure Deployment
          • Azure App Service
            • Azure MSSQL Connector - Deprecated
          • Azure Virtual Machine
          • Azure Kubernetes Service
          • Set up the DB
        • GCP Deployment
          • GCP Cloud Run
      • On-Premise Deployment
      • Enterprise Server
      • PDF Server
    • Deployment Configurations
      • DNS Configuration
      • Load Balancer Configuration
    • Licenses
      • License Management
      • Library Licenses
    • Portal Base Project
      • Portal SSO
      • Portal Translations
    • Maintenance and Migration
      • Changes to Premium Libraries
  • FAQ
    • FAQ
    • Tutorials & Workflows
      • Password Reset
      • Dynamic Select Filtering
      • Approval Workflow
      • SSO Email Token
      • Embedding A Video
      • Data Source Validation
      • Select Data Source Options
      • Nested Form Workflows
        • Nested Wizard Forms
      • Save as Draft
      • Role-Based Conditions
      • Custom Component
      • Dynamic Radio and Select Box Values
      • Override CKEDITOR
    • Errors
    • Examples
    • License Utilization Checks
  • Contact Us
Powered by GitBook
On this page
  • Docker Compose Local Deployment
  • Download The Docker Compose File
  • Setting The License Key
  • Installing Form.io Using Docker Compose
  • Authenticating Into The Portal
  • Data Access Folder
  • Additional Software and Technology

Was this helpful?

  1. Deployments
  2. Self-Hosted Deployment

Local Deployment

PreviousSelf-Hosted DeploymentNextLocal File Storage

Last updated 15 days ago

Was this helpful?

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 a 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.

Contact sales@form.io to acquire a License

Docker Compose Local Deployment

Download The Docker Compose File

Setting The License Key

Open the zipped folder within your preferred IDE, click the .env file, and locate the following line.

LICENSE_KEY=YOURLICENSE

Change YOURLICENSE to the Enterprise License key distributed to you by Form.io.

Contact support@form.io to inquire about a license.

Installing Form.io Using Docker Compose

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.

Authenticating Into The Portal

After the installation process has been completed, navigate to the following URL to access the Local Deployment.

http://lvh.me

To authenticate into the platform, use the following credentials:

  • CHANGEME

Edit the .env file to modify the authentication credentials for the local deployment.

Data Access Folder

All MongoDB data as well as PDF files are stored within the local data directory which is part of the deployment folder.

Additional Software and Technology

The next section will detail additional software you can install to facilitate things like File Storage and Container Management within your local environment.

Form.io uses to define and run the containers necessary to locally install the Form.io Enterprise platform. Review the section of the Self-Hosted Deployment guide to learn more about Docker Desktop before continuing with the Local Deployment walkthrough.

Now that we have Docker Desktop running, navigate to the Form.io repo. Click the folder and download the local.zip file which holds the necessary files to install and run the Form.io containers. Locate the zip file on your Local Machine and unzip it into a folder.

Deploy
deployments/compose
admin@example.com
Prepare Your Environment