> For the complete documentation index, see [llms.txt](https://help.form.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.form.io/reference/environment-variables/enterprise-server-variables.md).

# Enterprise Server Variables

## Core Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td>PROTOCOL</td><td>https</td><td></td><td></td></tr><tr><td>DOMAIN</td><td>form.io</td><td></td><td></td></tr><tr><td>PORT</td><td>80</td><td></td><td></td></tr><tr><td>BASE_URL</td><td>' / {protocol}://api.{domain}</td><td>Empty string for config.baseUrl; the api host pattern for apiHost</td><td></td></tr><tr><td>PROJECT</td><td>formio</td><td></td><td></td></tr><tr><td>PROJECT_PLAN</td><td>commercial</td><td></td><td></td></tr><tr><td>DEBUG</td><td>FALSE</td><td></td><td></td></tr><tr><td>ENABLE_SSL, SSL_KEY, SSL_CERT</td><td>FALSE</td><td>Key/cert accept a file path or a literal value</td><td></td></tr><tr><td>MAX_BODY_SIZE</td><td>25mb</td><td></td><td></td></tr><tr><td>KEEP_ALIVE_TIMEOUT</td><td>unset</td><td></td><td></td></tr><tr><td>HSTS_MAX_AGE</td><td>31536000</td><td>Set to 0 to disable HSTS entirely</td><td></td></tr><tr><td>HSTS_INCLUDE_SUB_DOMAINS, HSTS_PRELOAD</td><td>TRUE</td><td></td><td></td></tr><tr><td>DEBUG_CONFIG_VARS</td><td>https,domain,port,host,project,plan,formioHost,apiHost,debug,docker</td><td>Which config keys the debug logger prints</td><td></td></tr></tbody></table>

## Database Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td>MONGO</td><td>mongodb://localhost:27017/{MONGO_COLLECTION}</td><td>mongodb://mongo:27017/... when running in Docker</td><td>Must be set to deployment-specific value</td></tr><tr><td>MONGO1</td><td>unset</td><td>LEGACY backward-compat alias for MONGO</td><td></td></tr><tr><td>MONGO_COLLECTION</td><td>formio</td><td></td><td></td></tr><tr><td>MONGO_PORT_27017_TCP_ADDR, MONGO_PORT_27017_TCP_PORT</td><td>unset (mongo / 27017)</td><td>LEGACY Docker v1 container-linking convention</td><td></td></tr><tr><td>MONGO_SA, MONGO_CA, MONGO_SSL, MONGO_SSL_VALIDATE, MONGO_SSL_PASSWORD, MONGO_CONFIG</td><td>unset</td><td>Only applied when provided</td><td></td></tr><tr><td>DB_SECRET</td><td>abc123</td><td>Encrypts settings at rest, change in production</td><td>Default value unsafe</td></tr><tr><td>DB_SECRET_OLD</td><td>FALSE</td><td>For secret rotation</td><td></td></tr></tbody></table>

## Authorization & Security Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th width="191">Required?</th></tr></thead><tbody><tr><td>JWT_SECRET</td><td>abc123</td><td>Change in production</td><td>Default value unsafe</td></tr><tr><td>JWT_EXPIRE_TIME</td><td>240</td><td>Minutes</td><td></td></tr><tr><td>SESSION_EXPIRE_TIME</td><td></td><td></td><td></td></tr><tr><td>PORTAL_SECRET</td><td></td><td>Remote secret</td><td></td></tr><tr><td>PORTAL_SSO, PORTAL_SSO_LOGOUT</td><td></td><td></td><td></td></tr><tr><td>SSO_TEAMS</td><td>FALSE</td><td>Forced on if PORTAL_SSO is set</td><td></td></tr><tr><td>TWO_FACTOR_AUTHENTICATION_APP_NAME</td><td>Form.io</td><td></td><td></td></tr><tr><td>2FA_TIMEOUT</td><td>15</td><td>Minutes</td><td></td></tr><tr><td>OAUTH_M2M_ENABLED</td><td>FALSE</td><td></td><td></td></tr><tr><td>NOAUDITLOG</td><td></td><td>Audit logging is enabled by default</td><td></td></tr><tr><td>FILTER_ACCESS</td><td>TRUE</td><td></td><td></td></tr><tr><td>ONLY_PRIMARY_WRITE_ACCESS</td><td>FALSE</td><td></td><td></td></tr><tr><td>ENABLE_RESTRICTIONS</td><td>FALSE</td><td>Plan limits enforcement (src/plans/index.js)</td><td></td></tr><tr><td>ADMIN_KEY</td><td>unset</td><td>Enables the x-admin-key header bypass; read by both the enterprise layer and OSS tokenHandler</td><td></td></tr><tr><td>API_KEYS</td><td>unset</td><td>Comma-separated list of project-independent API keys (OSS tokenHandler.js)</td><td></td></tr><tr><td>SAML_PASSPORT_PRIVATE_KEY_PATH, SAML_PASSPORT_DECRYPTION_PVK_PATH</td><td>null</td><td>Read in src/saml/</td><td></td></tr><tr><td>MAX_PASSWORD_LENGTH</td><td>200</td><td>Reset Password action (OSS src/actions/ResetPassword.js)</td><td></td></tr></tbody></table>

## License Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td><code>LICENSE_KEY</code></td><td></td><td>Enables Enterprise features</td><td>For all Enterprise Deployments</td></tr><tr><td><code>LICENSE_SERVER</code></td><td><code>https://license.form.io</code></td><td> </td><td></td></tr><tr><td><code>LICENSE_REMOTE</code></td><td><code>false</code></td><td> </td><td></td></tr><tr><td><code>SKIP_FORM_LICENSING</code></td><td>unset</td><td> </td><td></td></tr><tr><td><code>CACHE_TIME</code></td><td><code>900</code></td><td>Seconds (15 min) — license utilization cache (<code>src/util/utilization.js</code>); also the fallback for <code>PROJECT_CACHE_TIME_SECONDS</code></td><td></td></tr><tr><td><code>USAGE_CACHE_TTL</code></td><td><code>60</code></td><td><code>src/usage/UsageTracking.js</code></td><td></td></tr></tbody></table>

## PDF Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td><code>PDF_SERVER</code></td><td></td><td> </td><td>In PDF deployments</td></tr><tr><td><code>FORMIO_FILES_SERVER</code></td><td></td><td>Legacy, older alias for <code>PDF_SERVER</code></td><td></td></tr><tr><td><code>FORMIO_PDF_PROJECT</code></td><td><code>https://pdf.form.io</code></td><td> </td><td></td></tr><tr><td><code>FORMIO_PDF_APIKEY</code></td><td></td><td> </td><td></td></tr></tbody></table>

## VM & Performance Variables

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td><code>FORMIO_VM_TIMEOUT</code></td><td><code>500</code></td><td>ms</td><td></td></tr><tr><td><code>FORMIO_VM_MEMORY_LIMIT_MB</code></td><td>unset</td><td>Falls back to isolated-vm's own default</td><td></td></tr><tr><td><code>FORMIO_NEXTGEN_RENDER_CONCURRENCY</code></td><td><code>8</code></td><td> </td><td></td></tr><tr><td><code>FORMIO_NEXTGEN_RENDER_POOL_SIZE</code></td><td><code>1</code></td><td> </td><td></td></tr><tr><td><code>FORMIO_ENCAPSULATED_EVALUATION_THRESHOLD</code></td><td><code>2</code></td><td> </td><td></td></tr><tr><td><code>MAX_BULK_SUBMISSIONS</code></td><td><code>1000</code></td><td> </td><td></td></tr><tr><td><code>REPORT_MAX_TIME_MS</code></td><td>unset</td><td>No limit by default</td><td></td></tr><tr><td><code>PROJECT_CACHE_TIME_SECONDS</code></td><td><code>900</code></td><td>Falls back to <code>CACHE_TIME</code></td><td></td></tr><tr><td><code>PROJECT_CACHE_CHECK_PERIOD_SECONDS</code></td><td><code>60</code></td><td> </td><td></td></tr><tr><td><code>PROJECT_CACHE_POLL_INTERVAL_MS</code></td><td><code>5000</code></td><td> </td><td></td></tr><tr><td><code>NODE_OPTIONS</code></td><td>—</td><td>Parsed only to detect <code>--max_old_space_size</code></td><td></td></tr><tr><td><code>PERFORMANCE_TIMER</code></td><td>unset</td><td>Enables timing logs in OSS <code>lastModifiedIndexHandler</code></td><td></td></tr></tbody></table>

### Feature flags <a href="#feature-flags" id="feature-flags"></a>

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Deault</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td>Variable</td><td>Default</td><td>Enables</td><td></td></tr><tr><td><code>FORMIO_BULK_SUBMISSIONS</code></td><td><code>false</code></td><td>Bulk submissions endpoints</td><td></td></tr><tr><td><code>FORMIO_FEATURE_ENCAPSULATED_EVALUATION</code></td><td><code>false</code></td><td>Single encapsulated VM sweep for heavy-form custom JS</td><td></td></tr><tr><td><code>USE_NEXTGEN_VALIDATOR</code></td><td><code>false</code></td><td><code>@formio/nextgen</code> validation engine instead of legacy <code>@formio/core</code>; the OSS layer also reads it directly as a fallback when the enterprise hook is absent</td><td></td></tr><tr><td><code>FORMIO_FEATURE_EXAMPLE</code></td><td><code>false</code></td><td>Testing only — do not use in production</td><td></td></tr><tr><td><code>FF_FORBID_DUPLICATED_DATA_PATH</code></td><td>unset</td><td>OSS-only (<code>src/models/Form.js</code>): validates duplicate component paths by <code>dataPath</code> instead of <code>fullPath</code></td><td></td></tr></tbody></table>

### Email (OSS layer) <a href="#email-oss-layer" id="email-oss-layer"></a>

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td><code>DEFAULT_TRANSPORT</code></td><td>unset</td><td>Default email transport; the enterprise layer applies it for non-hosted deployments (<code>src/hooks/settings.js</code>)</td><td></td></tr><tr><td><code>DEFAULT_EMAIL_SOURCE</code></td><td><code>no-reply@example.com</code></td><td>Default from-address</td><td></td></tr><tr><td><code>EMAIL_OVERRIDE</code></td><td>unset</td><td>Redirects all outgoing email (JSON transport config) — testing/staging</td><td></td></tr><tr><td><code>EMAIL_CHUNK_SIZE</code></td><td><code>100</code></td><td>Batch size when sending to many recipients</td><td></td></tr><tr><td><code>RENDER_METHOD</code></td><td><code>static</code></td><td>Email template render method; falls back to the form's <code>renderingMethod</code> setting</td><td></td></tr><tr><td><code>SENDGRID_USERNAME</code>, <code>SENDGRID_PASSWORD</code></td><td>unset</td><td>Setting the password switches the default email transport to sendgrid</td><td></td></tr></tbody></table>

### OSS formio layer — other <a href="#oss-formio-layer-other" id="oss-formio-layer-other"></a>

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Header</th></tr></thead><tbody><tr><td><code>CAPTURE_IP_ADDRESS</code></td><td><code>false</code></td><td><code>true</code>/<code>1</code> stores the submitter's IP in submission metadata (<code>submissionHandler.js</code>)</td><td></td></tr><tr><td><code>PUBLIC_CONFIG</code></td><td>unset</td><td>JSON object merged into the public <code>/config.json</code> response (<code>configHandler.js</code>)</td><td></td></tr><tr><td><code>FORMIO_EXTENSIONS_PATH</code></td><td><code>/app/extensions.js</code></td><td>Path to an optional extensions module loaded at boot (<code>src/util/loadExtensions.js</code>)</td><td></td></tr></tbody></table>

### Integrations & misc <a href="#integrations-and-misc" id="integrations-and-misc"></a>

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Variable</th><th>Default</th><th>Notes</th><th>Required?</th></tr></thead><tbody><tr><td><code>DROPBOX_CLIENTID</code>, <code>DROPBOX_CLIENTSECRET</code></td><td><code>''</code></td><td>Dropbox storage provider (<code>src/storage/dropbox.js</code>)</td><td></td></tr><tr><td><code>CRM</code></td><td>unset</td><td>Enables the custom CRM action proxy</td><td></td></tr><tr><td><code>ESIGN_PRIVATE_KEY_FILE</code></td><td>unset</td><td> </td><td></td></tr><tr><td><code>TEMPLATE_SERVICE</code></td><td><code>''</code></td><td>External template worker (<code>src/hooks/alter/worker.js</code>)</td><td></td></tr><tr><td><code>WHITELABEL</code></td><td>unset (<code>false</code>)</td><td>Requires the license whitelabel option too</td><td></td></tr><tr><td><code>VPAT</code></td><td><code>false</code></td><td>Requires the license vpat option too</td><td></td></tr><tr><td><code>VERBOSE_HEALTH</code></td><td>unset</td><td> </td><td></td></tr><tr><td><code>PRIMARY</code></td><td>unset</td><td>Either being truthy (not <code>'false'</code>) makes this the primary/portal-serving instance and triggers install/default-project bootstrap</td><td></td></tr><tr><td><code>PORTAL_ENABLED</code></td><td></td><td></td><td>In Portal environments</td></tr><tr><td><code>ADMIN_EMAIL</code></td><td><code>admin@example.com</code> </td><td>Initial install admin (<code>src/util/install.js</code>)</td><td>Default value unsafe</td></tr><tr><td><code>ADMIN_PASS</code></td><td><code>p@ssw0rd!</code></td><td></td><td>Default value unsafe</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.form.io/reference/environment-variables/enterprise-server-variables.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
