# FormSG

Welcome to the FormSG Self-Hosting Guide

[![FormSG logo](https://file.go.gov.sg/form-logo-background-rmved.png)](https://form.gov.sg)

**Self-host FormSG to:**

* **Maintain complete data sovereignty** within your jurisdiction
* **Meet compliance requirements** specific to your regulatory environment
* **Integrate seamlessly** with existing government systems and identity providers
* **Reduce vendor lock-in** while keeping full operational control

This guide takes you from evaluation to production deployment, with paths tailored for decision makers, developers, and IT teams.

### 🎯 Quick Start: See FormSG in Action

#### Try the Live Demo (5 minutes)

Experience FormSG's capabilities firsthand before deploying:

1. **Visit**: [form.demos.sg](https://form.demos.sg/)
2. **Sign in**: Use any Gmail, Yahoo, Hotmail or Outlook email
3. **Explore**: Create a form, test conditional logic, try file uploads
4. **Share**: Generate a link to demonstrate functionality to your team

{% hint style="warning" %}
**Demo environment**: Forms expire after 3 hours. Payment and webhook features are disabled. This environment is designed for evaluation and proof-of-concept demonstrations.
{% endhint %}

#### 📚 Additional Resources

* **This GitBook** - Complete, currently developed, self-hosting guide
* [**GitHub Repository**](https://github.com/opengovsg/FormSG) - Source code, issues, discussions

### 🚀 What is FormSG?

<figure><img src="https://3225095994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFiAVh1Ff3KUiYxMAZuJG%2Fuploads%2Fj1Yit0028IqQKYufcLu9%2FLanding-page-animation-1-%5Bcopy%5D.gif?alt=media&#x26;token=68f4cd96-b84f-4b86-af84-68f3a18dddc5" alt=""><figcaption></figcaption></figure>

FormSG is a **self-service, easy-to-use and feature-rich form builder** that enables public officers to collect citizen data quickly and securely.

#### Proven at Scale

* **200+ million** paper form submissions replaced
* **160+** public agencies actively using FormSG
* **150,000+** public officers as active users
* **Since 2017** - Battle-tested in production for over 7 years

FormSG handles everything from simple contact forms to complex multi-step applications with conditional logic, file uploads, and payment processing.

{% hint style="info" %}
This is the **self-hosting deployment guide**. For guides on creating, managing, and using forms, visit the user guide: <https://guide.form.gov.sg/>
{% endhint %}

## :anchor: Choose Your Starting Point

This guide assumes your team has experience with:

* Basic Linux server administration
* Docker or container orchestration
* Managing environment variables and secrets
* Working with Node.js applications

{% hint style="success" %}
While technical knowledge is helpful, don't let it stop you from getting started!
{% endhint %}

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="content-ref"></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>🎯 Decision Maker</td><td><em>"Should my organisation adopt FormSG?"</em></td><td><a href="formsg/evaluation-guide">evaluation-guide</a></td><td>Cost-benefit analysis, risk assessment, and technical feasibility frameworks for go/no-go decisions.</td><td><strong>📖 15 min read</strong></td><td></td></tr><tr><td>👨‍💻 Developer</td><td><em>"I want to try FormSG locally first"</em></td><td><a href="formsg/quickstart">quickstart</a></td><td>Get a local development environment running in 30 minutes to test FormSG's capabilities and understand the architecture hands-on.</td><td><strong>📖 10 min read + 30 min setup</strong></td><td></td></tr><tr><td>🏗️ Mature Team</td><td><em>"We want to deploy to production"</em></td><td><a href="formsg/deployment">deployment</a></td><td>Complete AWS deployment with security, monitoring, and validation.</td><td><strong>📖 45 min read</strong></td><td></td></tr><tr><td><span data-gb-custom-inline data-tag="emoji" data-code="2601">☁️</span> Alternative Cloud</td><td><em>"AWS may not be for us"</em></td><td><a href="formsg/infrastructure-guidance">infrastructure-guidance</a></td><td>Deploy to non-AWS cloud providers or on-premises infrastructure.</td><td><strong>📖 20 min read</strong></td><td></td></tr><tr><td>🔧 Platform Engineering Team</td><td><em>"We need to integrate with existing systems"</em></td><td><a href="formsg/component-customization">component-customization</a></td><td>Replace email, storage, identity providers, and other components with your organisation's alternatives.</td><td><strong>📖 25 min read</strong></td><td></td></tr><tr><td><span data-gb-custom-inline data-tag="emoji" data-code="2696">⚖️</span> Compliance Officer</td><td><em>"What are our legal obligations?"</em></td><td><a href="formsg/legal-and-compliance">legal-and-compliance</a></td><td>Legal and compliance requirements you must follow when forking FormSG.</td><td><strong>📖 10 min read</strong></td><td></td></tr></tbody></table>