Configuration field reference

This inventory was taken from the current core-server configuration struct. Confirm it against the version you deploy. Types describe the implementation; duration syntax and accepted values need field-specific guidance.

YAML field	Implementation type
`displayedAppName`	`string`
`httpHost`	`string`
`httpPort`	`string`
`enableCors`	`bool`
`externalUrl`	`string`
`tcpHost`	`string`
`tcpPort`	`string`
`tcpEnabled`	`bool`
`logLevel`	`string`
`logClusterMessages`	`bool`
`logClientMessages`	`bool`
`auditLogEnabled`	`bool`
`auditLogBatchSize`	`int`
`auditLogBatchTimeout`	`time.Duration`
`serverRole`	`string`
`clusterHostIp`	`string`
`clusterHostPort`	`string`
`clusterHostUrl`	`string`
`clusterStateRefreshInterval`	`time.Duration`
`clusterStateExpiryDuration`	`time.Duration`
`clusterKey`	`string`
`httpRequestTimeout`	`time.Duration`
`wsHandshakeTimeout`	`time.Duration`
`outgoingMessageBufferSize`	`int`
`outgoingMessageBufferInterval`	`string`
`subscriptionBatchInterval`	`string`
`minCheckInterval`	`string`
`presenceRefreshRate`	`string`
`maxRecurseDepth`	`int`
`maxRequestBodySize`	`int`
`httpPath`	`string`
`websocketPath`	`string`
`restPathPrefix`	`string`
`healthCheckPath`	`string`
`serverStatusPath`	`string`
`adminDashboardEnabled`	`bool`
`adminDashboardHttpPath`	`string`
`adminPassword`	`string`
`authType`	`string`
`authTokenLocation`	`string`
`authCookieName`	`string`
`authTokenSecret`	`string`
`authTokenClockTolerance`	`time.Duration`
`pathToGoogleServiceAccountJson`	`string`
`awsCognitoRegion`	`string`
`awsCognitoUserPoolId`	`string`
`authTokenMaxLifeTime`	`string`
`authEmailDomains`	`[]string`
`authEmailTenantSplit`	`string`
`authSessionLifetime`	`time.Duration`
`smtpHost`	`string`
`smtpPort`	`string`
`smtpUser`	`string`
`smtpPassword`	`string`
`fromEmailAddress`	`string`
`tenantIdClaimKey`	`string`
`metricsInterval`	`time.Duration`
`persistenceType`	`string`
`persistenceMessageBufferSize`	`int`
`timeSeriesPersistenceType`	`string`
`timeSeriesPersistenceMaxRecordsPerWrite`	`int`
`timeSeriesPersistenceMaxTimeBetweenWrites`	`string`
`awsKeyId`	`string`
`awsKey`	`string`
`awsRegion`	`string`
`pgHost`	`string`
`pgPort`	`string`
`pgUser`	`string`
`pgPassword`	`string`
`pgDatabase`	`string`
`environment`	`string`
`reportStorageType`	`string`
`reportFileHttpBasePath`	`string`
`reportFileDirectory`	`string`
`reportS3BucketRegion`	`string`
`reportS3BucketName`	`string`
`userFileUploadDirectory`	`string`
`userFileUploadType`	`string`
`userFileUploadBucketName`	`string`
`userFileUploadBucketRegion`	`string`
`limitQueriesToRealmTable`	`bool`
`thirdPartyProtocolEndpoints`	`[]ThirdPartyProtocolEndpointDefinition`

Nested third-party protocol endpoint fields

The following fields belong to entries in thirdPartyProtocolEndpoints, not to the root configuration.

YAML field	Implementation type
`dataProtocol`	`string`
`transportProtocol`	`string`
`address`	`string`
`realmId`	`string`
`tenantId`	`string`
`categoryId`	`string`

See configuration guidance and identity deployment for the procedures already documented.

Nested third-party protocol endpoint fields​

Nested third-party protocol endpoint fields