---
title: Properties reference
---

_Key properties by category — what they do and where to set them._

This page documents commonly-modified Deephaven properties, organized by functional category. For a quick lookup by property name, see the [properties index](./properties-index.md).

> [!NOTE]
> This page covers key properties that customers frequently modify. To see all properties and their defaults, export the full files with [`dhconfig properties export`](./dhconfig/properties.md) (e.g., `dhconfig properties export iris-defaults.prop`). Use the [Property Inspector](../../resources/faq/property-inspector.md) to search for specific properties.

## System basics

Properties that identify and configure the Deephaven system.

| Property           | Default            | Set in                  | Description                                                                                                                 |
| ------------------ | ------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `system.name`      | `Deephaven`        | `iris-environment.prop` | Display name for the system. Shown in the UI to differentiate between multiple instances.                                   |
| `system.type`      | `PROD`             | `iris-environment.prop` | System type: `PROD`, `QA`, `DEV`, `SIM`, or any custom string.                                                              |
| `system.color`     | (unset)            | `iris-environment.prop` | Color for the System Information Bar. Any valid CSS color (hex, rgb, or CSS variable like `var(--dh-color-visual-notice)`). |
| `server.timezone`  | `America/New_York` | `iris-environment.prop` | Default timezone for the server.                                                                                            |
| `Calendar.default` | `USNYSE`           | `iris-environment.prop` | Default business calendar.                                                                                                  |

## Controller

Properties for the Persistent Query Controller. See [Controller configuration](../pq-controller/pq-controller.md) for complete documentation.

| Property                                                 | Default       | Set in                  | Description                                   |
| -------------------------------------------------------- | ------------- | ----------------------- | --------------------------------------------- |
| `PersistentQueryController.port`                         | `20126`       | `iris-endpoints.prop`   | Controller listening port.                    |
| `PersistentQueryController.maxInboundMessageSizeMiB`     | `64`          | `iris-environment.prop` | Maximum gRPC message size in MiB.             |
| `PersistentQueryController.queryStartThreadPoolCoreSize` | `20`          | `iris-environment.prop` | Thread pool size for starting queries.        |
| `PersistentQueryController.clientLoadBalancingPolicy`    | `round_robin` | `iris-environment.prop` | Load balancing policy for controller clients. |

## Dispatcher

Properties for the Remote Query Dispatcher. See [Dispatcher configuration](../pq-controller/dispatcher.md) for complete documentation.

| Property                                             | Default                                      | Set in                  | Description                                                      |
| ---------------------------------------------------- | -------------------------------------------- | ----------------------- | ---------------------------------------------------------------- |
| `RemoteQueryDispatcher.maxTotalQueryProcessorHeapMB` | `354304`                                     | `iris-environment.prop` | Maximum total heap for all workers on this dispatcher (MiB).     |
| `RemoteQueryDispatcher.maxPerWorkerHeapMB`           | (unset)                                      | `iris-environment.prop` | Maximum heap for any single worker. Defaults to total available. |
| `RemoteQueryDispatcher.workerServerPorts`            | `23000-23999` (query), `25000-25999` (merge) | `iris-environment.prop` | Port range for worker processes.                                 |
| `RemoteQueryDispatcher.workerServerWebsocketPorts`   | `24000-24999` (query), `26000-26999` (merge) | `iris-environment.prop` | Port range for worker websocket connections.                     |
| `RemoteQueryDispatcher.maxConcurrentStartups`        | `10`                                         | `iris-environment.prop` | Maximum queries starting simultaneously.                         |
| `RemoteQueryDispatcher.allowedGroups`                | `*`                                          | `iris-environment.prop` | Groups allowed to start queries on this dispatcher.              |
| `RemoteQueryDispatcher.adminGroups`                  | `iris-superusers`                            | `iris-environment.prop` | Groups with admin privileges on the dispatcher.                  |
| `RemoteQueryDispatcher.reservedAvailableMemoryMB`    | `2048`                                       | `iris-environment.prop` | Memory reserved for system use (MiB).                            |
| `minimumWorkerHeapSizeMB`                            | `512`                                        | `iris-environment.prop` | Minimum allowed heap size for workers (MiB).                     |

See [Worker heap size configuration](../pq-controller/worker-heap-size.md) for detailed heap management guidance.

## Web API Server

Properties for the Web API Service. See [Web API Service](../core-components/web-api-service.md) for complete documentation.

| Property                              | Default  | Set in                  | Description                                    |
| ------------------------------------- | -------- | ----------------------- | ---------------------------------------------- |
| `Webapi.server.port`                  | `8123`   | `iris-endpoints.prop`   | Web API server port.                           |
| `Webapi.console.heap.default`         | `4`      | `iris-environment.prop` | Default heap size for consoles (GB).           |
| `Webapi.persistentquery.heap.default` | `4`      | `iris-environment.prop` | Default heap size for persistent queries (GB). |
| `WebServer.tls.keystore`              | (varies) | `iris-environment.prop` | Path to TLS keystore for the web server.       |
| `WebServer.tls.passphrase.file`       | (varies) | `iris-environment.prop` | Path to keystore password file.                |
| `cors.allowedOrigins`                 | (varies) | `iris-environment.prop` | Comma-separated list of allowed CORS origins.  |

See [CORS configuration](./cors.md) for CORS setup details.

## Authentication

Properties for the Authentication Server.

| Property                    | Default | Set in                  | Description                                                                                                          |
| --------------------------- | ------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `authentication.server.ssl` | `true`  | `iris-environment.prop` | Enable SSL for auth server connections. Set globally (not in a service stanza) so clients also receive this setting. |

The following properties apply only to the Authentication Server. Set these in the `[service.name=authentication_server]` stanza:

| Property                                    | Default  | Set in                  | Description                                                    |
| ------------------------------------------- | -------- | ----------------------- | -------------------------------------------------------------- |
| `authentication.server.ldap.enabled`        | `false`  | `iris-environment.prop` | Enable LDAP authentication.                                    |
| `authentication.server.acceptplaintext`     | `false`  | `iris-environment.prop` | Accept plaintext connections (not recommended for production). |
| `authentication.server.customauth.enabled`  | `true`   | `iris-environment.prop` | Enable custom authentication provider.                         |
| `authentication.server.customauth.class`    | (varies) | `iris-environment.prop` | Custom auth provider class.                                    |
| `authentication.server.logTokenAuditEvents` | `true`   | `iris-environment.prop` | Log token audit events.                                        |

See [LDAP](./ldap.md) and [SAML](./saml-auth.md) for authentication configuration.

## Logging

Properties that control logging behavior.

| Property                                        | Default              | Set in                  | Description                                                           |
| ----------------------------------------------- | -------------------- | ----------------------- | --------------------------------------------------------------------- |
| `logroot`                                       | `/var/log/deephaven` | `iris-environment.prop` | Base directory for log files.                                         |
| `IrisLogDefaults.logLevel`                      | `INFO`               | `iris-environment.prop` | Default log level.                                                    |
| `IrisLogDefaults.useLogAggregatorService`       | `false`              | `iris-environment.prop` | Send logs to Log Aggregator Service.                                  |
| `IrisLogDefaults.useDynamicPartitions`          | `false`              | `iris-environment.prop` | Use dynamic partitions for logs.                                      |
| `UpdatePerformanceTracker.reportingMode`        | `DB_ONLY`            | `iris-environment.prop` | Performance tracking mode: `NONE`, `LISTENER_ONLY`, `DB_ONLY`, `ALL`. |
| `UpdatePerformanceTracker.reportIntervalMillis` | `60000`              | `iris-environment.prop` | Performance report interval (ms).                                     |

## NIO/Networking

Properties that control NIO networking behavior.

| Property                                   | Default  | Set in                  | Description                      |
| ------------------------------------------ | -------- | ----------------------- | -------------------------------- |
| `NIO.driver.maxThreadCount`                | `400`    | `iris-environment.prop` | Maximum NIO driver threads.      |
| `NIO.RPC.timeout`                          | `60000`  | `iris-environment.prop` | RPC timeout (ms).                |
| `ConnectionMonitor.enabled`                | `true`   | `iris-environment.prop` | Enable connection monitoring.    |
| `ConnectionMonitor.heartbeatTriggerMillis` | `300000` | `iris-environment.prop` | Heartbeat trigger interval (ms). |
| `ConnectionMonitor.heartbeatFatalMillis`   | `300000` | `iris-environment.prop` | Heartbeat fatal timeout (ms).    |

## File handling

Properties that control file handle management.

| Property                                        | Default | Set in                  | Description                                       |
| ----------------------------------------------- | ------- | ----------------------- | ------------------------------------------------- |
| `TrackedFileHandleFactory.maxOpenFiles`         | `4096`  | `iris-environment.prop` | Maximum open file handles. Set below `ulimit -n`. |
| `TrackedFileHandleFactory.fastCyclingThreshold` | `0.20`  | `iris-environment.prop` | Fraction of capacity triggering cycling warning.  |

See [File handle management](../table-storage/file-handle-management.md) for details.

## Python/JPY

Properties for Python integration.

| Property          | Default             | Set in                  | Description                       |
| ----------------- | ------------------- | ----------------------- | --------------------------------- |
| `jpy.programName` | (varies by version) | `iris-environment.prop` | Path to Python executable.        |
| `jpy.pythonLib`   | (varies by OS)      | `iris-environment.prop` | Path(s) to Python shared library. |
| `jpy.jpyLib`      | (varies by version) | `iris-environment.prop` | Path to JPY shared library.       |
| `jpy.jdlLib`      | (varies by version) | `iris-environment.prop` | Path to JDL shared library.       |

See [Custom Python virtual environments](./custom-py-venvs.md) for Python setup.

## Performance

Properties that affect system performance.

| Property                                  | Default  | Set in                  | Description                                                                                               |
| ----------------------------------------- | -------- | ----------------------- | --------------------------------------------------------------------------------------------------------- |
| `statsdriver.enabled`                     | `true`   | `iris-environment.prop` | Enable statistics driver.                                                                                 |
| `allocation.stats.enabled`                | `false`  | `iris-environment.prop` | Enable allocation statistics.                                                                             |
| `measurement.per_thread_cpu`              | `false`  | `iris-environment.prop` | Enable per-thread CPU measurement.                                                                        |
| `StringUtils.cacheSize`                   | `65536`  | `iris-environment.prop` | String utility cache size.                                                                                |
| `DataBufferConfiguration.useDirectMemory` | `true`   | `iris-environment.prop` | Use direct memory for table data (recommended for large data).                                            |
| `DataBufferConfiguration.poolSize`        | (varies) | `hostconfig`            | Total size of the buffer pool. Set per service in hostconfig; for workers, derived from PQ heap settings. |

See [Memory management](../performance/memory-management.md) for buffer pool configuration details.

## Core+ specific

Properties specific to Core+ workers. Set these in `coreplus-environment.prop`.

| Property                                 | Default                                                               | Set in                      | Description                                                     |
| ---------------------------------------- | --------------------------------------------------------------------- | --------------------------- | --------------------------------------------------------------- |
| `SessionMonitor.noSessionsTimeoutMillis` | `3000`                                                                | `coreplus-environment.prop` | Terminate worker after losing all sessions (ms).                |
| `http.session.durationMs`                | `75000`                                                               | `coreplus-environment.prop` | Session token duration (ms). Core+ uses 75s vs Enterprise 5min. |
| `AuthHandlers`                           | `io.deephaven.enterprise.dnd.authentication.DheAuthenticationHandler` | `coreplus-environment.prop` | Authentication handler class.                                   |
| `authentication.anonymous.warn`          | `true`                                                                | `coreplus-environment.prop` | Warn about anonymous authentication.                            |
| `web.storage.layout.directory`           | `/layouts`                                                            | `coreplus-environment.prop` | Directory for layout storage.                                   |
| `web.storage.notebook.directory`         | `/notebooks`                                                          | `coreplus-environment.prop` | Directory for notebook storage.                                 |

### Core+ security headers

These properties control HTTP security headers for Core+ workers.

| Property                                            | Default | Set in                      | Description                         |
| --------------------------------------------------- | ------- | --------------------------- | ----------------------------------- |
| `http.add.header.Strict-Transport-Security.enabled` | `false` | `coreplus-environment.prop` | Enable HSTS header.                 |
| `http.add.header.X-Frame-Options.enabled`           | `false` | `coreplus-environment.prop` | Enable X-Frame-Options header.      |
| `http.add.header.Content-Security-Policy.enabled`   | `false` | `coreplus-environment.prop` | Enable CSP header.                  |
| `http.add.header.X-XSS-Protection.enabled`          | `true`  | `coreplus-environment.prop` | Enable XSS protection header.       |
| `http.add.header.X-Content-Type-Options.enabled`    | `true`  | `coreplus-environment.prop` | Enable content type options header. |
| `http.add.header.Referrer-Policy.enabled`           | `true`  | `coreplus-environment.prop` | Enable referrer policy header.      |

See [Hardening technical controls](../security/hardening-technical-controls.md) for security configuration.

## Related documentation

- [Deephaven properties overview](./deephaven-properties-overview.md)
- [Properties index](./properties-index.md)
- [Deephaven properties file format](./deephaven-properties-files.md)
- [Property Inspector](../../resources/faq/property-inspector.md)
