Skip to main content
Version: Latest
Technical ManualLooking for step-by-step instructions? In the User Manual: Features and Settings (for Administrators)

Configuration Reference

This page lists every configuration section the CrestApps Orchard Core modules read outside the admin screens: the exact section path, what it controls, an appsettings.json example, and the environment variable form. Each entry links to the page that documents the setting in full.

Most settings are also, or only, available in the browser under Settings. Those are covered in the User Manual; see Features and settings.

How configuration reaches the modules​

The modules read their settings through Orchard Core's tenant configuration (IShellConfiguration). Orchard Core builds it from the host's configuration, takes the OrchardCore section, and layers the tenant's own values on top. A module that reads CrestApps:ContentTransfer in code is therefore configured at OrchardCore:CrestApps:ContentTransfer in the host's appsettings.json.

For Orchard Core's own description of these sources, see Configuration in the Orchard Core documentation.

appsettings.json​

In the startup project's appsettings.json (and appsettings.{Environment}.json), put every CrestApps section under the OrchardCore key:

{
  "OrchardCore": {
    "CrestApps": {
      "ContentTransfer": {
        "MaxUploadFileSize": 5368709120
      }
    }
  }
}

Values set here apply to every tenant on the host.

Environment variables​

Environment variables use a double underscore (__) for each level of the path, including the OrchardCore prefix. Array entries are addressed by index, as __0__, __1__ and so on:

OrchardCore__CrestApps__ContentTransfer__MaxUploadFileSize=5368709120
OrchardCore__CrestApps__AI__Connections__0__Name=openai-cloud
OrchardCore__CrestApps__AI__Connections__0__ApiKey=<api-key>

A section whose name already contains a single underscore keeps it. CrestApps_Telephony:Commands:Timeout becomes OrchardCore__CrestApps_Telephony__Commands__Timeout. Hosting platforms that take "app settings", such as Azure App Service, pass them to the application as environment variables, so the same names apply.

Array indexes are positions

An environment variable that sets Connections__0__Name replaces whatever the entry at index 0 was in appsettings.json; it does not add a new entry. To add an entry beside the ones in a file, use an index the file does not use. The AI connection list accepts gaps in its indexes.

Per-tenant configuration​

There are two ways to give one tenant its own values.

A tenant-named section. Inside the OrchardCore section, a section named after the tenant overrides the shared values for that tenant only. Use Default for the default tenant:

{
  "OrchardCore": {
    "CrestApps": {
      "ContentTransfer": {
        "MaxUploadFileSize": 1073741824
      }
    },
    "Contoso": {
      "CrestApps": {
        "ContentTransfer": {
          "MaxUploadFileSize": 5368709120
        }
      }
    }
  }
}

The environment-variable form adds the tenant name after OrchardCore:

OrchardCore__Contoso__CrestApps__ContentTransfer__MaxUploadFileSize=5368709120

The tenant's own file. App_Data/Sites/{TenantName}/appsettings.json holds values for that tenant only. The file is already scoped to the tenant, so write the keys without the OrchardCore wrapper, starting at CrestApps:

{
  "CrestApps": {
    "ContentTransfer": {
      "MaxUploadFileSize": 5368709120
    }
  }
}

Orchard Core writes this file during tenant setup, so keep the keys it already holds when you edit it.

The global App_Data file. App_Data/appsettings.json applies to every tenant, like the startup project's file, and uses the same OrchardCore wrapper.

note

Several pages in this documentation show examples that start at CrestApps without the OrchardCore wrapper. That shape is only correct inside a tenant's App_Data/Sites/{TenantName}/appsettings.json. In the startup project's appsettings.json, App_Data/appsettings.json and environment variables, the OrchardCore prefix is required.

Secrets​

Keep API keys, passwords and connection strings out of files that are committed to source control:

  • Environment variables are the simplest option for containers and hosted environments.

  • User secrets are read only when ASPNETCORE_ENVIRONMENT is Development, and only by a startup project that declares a UserSecretsId. The CrestApps.OrchardCore.Cms.Web host does not declare one, so run dotnet user-secrets init in that project once before you set a secret. The key uses : and includes the OrchardCore prefix:

    dotnet user-secrets set OrchardCore:CrestApps:AI:Connections:0:ApiKey "<api-key>"

  • Other secret stores, such as Azure Key Vault, are added to the host's configuration in Program.cs with their standard ASP.NET Core configuration provider. Tenants see their values like any other host configuration. Azure Key Vault secret names use -- in place of :, for example OrchardCore--CrestApps--AI--Connections--0--ApiKey.

Some admin screens also store secrets, such as the Telnyx API key or the Claude API key. Those are encrypted with ASP.NET Core data protection before they are saved.

Which source wins​

When the same key comes from more than one source, the later source in this list wins:

  1. The startup project's appsettings.json.
  2. appsettings.{Environment}.json.
  3. User secrets (Development only).
  4. Any other provider the host adds in Program.cs, such as a secret store, in the order it is added.
  5. App_Data/appsettings.json.
  6. Environment variables, then command-line arguments. Orchard Core applies these again after App_Data/appsettings.json, so they win over it.

Then, for each tenant:

  1. Keys under the tenant-named section (OrchardCore:{TenantName}:...), from any of the sources above, win over the shared OrchardCore:... keys.
  2. App_Data/Sites/{TenantName}/appsettings.json wins over everything else.

Configuration is read when a tenant starts. Restart the application after you change a configuration file or an environment variable.

Admin settings versus configuration​

Many modules can be set up both in the browser and in configuration. Which one wins depends on the module:

ModuleAdmin screenConfigurationWhich wins
AI connections and deploymentsArtificial Intelligence connections and deploymentsCrestApps:AI:Connections, CrestApps:AI:DeploymentsBoth are used. Entries from configuration appear beside the ones stored in the database; deployments from configuration are read-only in the admin.
AI default parametersSettings > Artificial IntelligenceCrestApps:AI:DefaultParametersConfiguration sets the defaults. The settings page can override maximum iterations, distributed caching and OpenTelemetry for the tenant, and cannot raise iterations above AbsoluteMaximumIterationsPerRequest.
ClaudeSettings > Artificial Intelligence > ClaudeCrestApps:AI:ClaudeThe settings page wins for every value it holds. The stored API key is used only while API-key authentication is selected.
CopilotSettings > Artificial Intelligence > CopilotCrestApps:AI:CopilotThe settings page wins for every value it holds.
MCP serverSettings > Artificial Intelligence, MCP Server cardCrestApps:AI:McpServerConfiguration wins. Values in configuration override the stored settings.
AI data sourcesThe data source editorCrestApps:PostgreSQL, CrestApps:Elasticsearch and the CrestApps:AI:DataSources overridesA connection stored on a data source wins over configuration.
Telnyx SMSSettings > Communication > SMS, TelnyxOrchardCore_Sms_TelnyxThe settings page wins while its provider is enabled. A field left blank there falls back to configuration.
Telnyx voiceSettings > Communication > Telephony, TelnyxNoneAdmin screen only.
AsteriskSettings > Communication > Telephony, AsteriskCrestApps:Asterisk:DefaultThey are two separate providers. Configuration adds a Default Asterisk provider; the tenant picks which provider to use as its default telephony provider.
Do Not Call registriesSettings > DNC RegistriesCrestApps:DncRegistry:AzureBlobStorageRegistry credentials are admin-only. File storage in Azure is configuration-only.
Phone number verificationSettings > Phone Number VerificationsNoneAdmin screen and recipes only.

Every other section on this page is configuration-only: it has no admin screen.

AI​

AI connections and deployments​

SectionsCrestApps:AI:Connections, CrestApps:AI:Deployments
Read byCrestApps.Core (the AI framework packages), through the tenant configuration
ControlsProvider connections (endpoint, credentials) and the model deployments that use them, with the capabilities each model supports

Both are arrays. A deployment names its provider in ClientName and its connection in ConnectionName:

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "Connections": [
          {
            "Name": "openai-cloud",
            "ClientName": "OpenAI",
            "ApiKey": "<api-key>"
          }
        ],
        "Deployments": [
          {
            "Name": "chat-default",
            "ClientName": "OpenAI",
            "ConnectionName": "openai-cloud",
            "ModelName": "gpt-4o",
            "Properties": {
              "AIDeploymentMetadata": {
                "Features": [ "textGeneration", "toolCalling", "streaming" ]
              }
            }
          }
        ]
      }
    }
  }
}
OrchardCore__CrestApps__AI__Connections__0__ApiKey=<api-key>
OrchardCore__CrestApps__AI__Deployments__0__ModelName=gpt-4o

Which deployment serves chat, utility, embedding and the other slots is chosen on the settings page, not in configuration. See AI Providers and Model Capabilities.

AI provider connection keys​

The keys on a connection depend on the provider (ClientName):

ProviderClientNameKeysDetails
OpenAI and OpenAI-compatible servicesOpenAIApiKey, Endpoint (for a compatible service)OpenAI
Azure OpenAIAzureEndpoint, AuthenticationType (Default, ManagedIdentity, ApiKey), ApiKey, IdentityIdAzure OpenAI
Azure AI Inference (GitHub models)AzureAIInferenceEndpoint, AuthenticationType, ApiKeyAzure AI Inference
OllamaOllamaEndpointOllama

Azure Speech deployments carry their own connection: a deployment with ClientName AzureSpeech holds Endpoint, AuthenticationType and ApiKey itself. See Azure OpenAI.

OrchardCore__CrestApps__AI__Connections__0__ClientName=Azure
OrchardCore__CrestApps__AI__Connections__0__AuthenticationType=ManagedIdentity

Default AI parameters​

SectionCrestApps:AI:DefaultParameters
ControlsThe completion parameters used when a profile does not set its own, and the request limits

Keys: Temperature, MaxOutputTokens, TopP (default 1), FrequencyPenalty (0), PresencePenalty (0), PastMessagesCount (10), MaximumIterationsPerRequest (10), AbsoluteMaximumIterationsPerRequest (100), EnableOpenTelemetry (false) and EnableDistributedCaching (true). The defaults come from CrestApps.Core.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "DefaultParameters": {
          "Temperature": 0,
          "MaxOutputTokens": 800
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__DefaultParameters__Temperature=0
OrchardCore__CrestApps__AI__DefaultParameters__MaxOutputTokens=800

See AI Services.

Azure OpenAI client​

SectionCrestApps:AI:AzureClient
FeatureAzure OpenAI Chat (CrestApps.OrchardCore.OpenAI.Azure)
ControlsRetries and logging of the Azure OpenAI client

Keys: EnableDefaultRetryPolicy (default true), MaxRetryAttempts (5), RateLimitRetryDelay (00:00:01), MaxRetryDelay (00:00:32), BackoffType (Exponential), UseJitter (true), EnableLogging, EnableMessageLogging and EnableMessageContentLogging (all false). The defaults come from CrestApps.Core.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "AzureClient": {
          "MaxRetryAttempts": 3
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__AzureClient__MaxRetryAttempts=3

See Azure OpenAI.

Claude​

SectionCrestApps:AI:Claude
ControlsThe Anthropic API key, base URL and default model

Keys: ApiKey, BaseUrl (default https://api.anthropic.com), DefaultModel.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "Claude": {
          "ApiKey": "<anthropic-api-key>",
          "DefaultModel": "<model-name>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__Claude__ApiKey=<anthropic-api-key>

The settings page wins over these values. See Claude Integration.

Copilot​

SectionCrestApps:AI:Copilot
ControlsHow the Copilot orchestrator authenticates, and the model it uses

Keys: AuthenticationType (NotConfigured, GitHubOAuth or ApiKey), ClientId, ClientSecret and Scopes for GitHub OAuth; ProviderType (openai, azure or anthropic), BaseUrl, ApiKey, DefaultModel, WireApi (completions or responses) and AzureApiVersion for API-key authentication.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "Copilot": {
          "AuthenticationType": "ApiKey",
          "ProviderType": "openai",
          "BaseUrl": "https://api.openai.com/v1",
          "ApiKey": "<api-key>",
          "DefaultModel": "<model-name>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__Copilot__AuthenticationType=ApiKey
OrchardCore__CrestApps__AI__Copilot__ApiKey=<api-key>

The settings page wins over these values. See Copilot.

Realtime voice transport​

SectionsCrestApps:AI:RealtimeTransport, CrestApps:AI:RealtimeTransport:Cloudflare
ControlsWebRTC on or off, turn detection, idle and session limits, knowledge grounding, STUN and TURN servers, and Cloudflare-issued TURN credentials
{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "RealtimeTransport": {
          "EnableWebRtc": true,
          "IdleTimeoutSeconds": 30,
          "TurnUrls": [ "turns:turn.example.com:5349" ],
          "TurnSecret": "<shared-secret>",
          "Cloudflare": {
            "TokenId": "<turn-token-id>",
            "ApiToken": "<api-token>"
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__RealtimeTransport__EnableWebRtc=false
OrchardCore__CrestApps__AI__RealtimeTransport__TurnUrls__0=turns:turn.example.com:5349

A tenant that declares StunUrls or TurnUrls replaces the host's list rather than adding to it. See Realtime Voice for every key.

Chat interaction batch processing​

SectionCrestApps:AI:ChatInteractions:BatchProcessing
FeatureAI Chat Interactions
ControlsHow large tabular documents are processed row by row in batches

Keys: RowBatchSize (default 25), MaxConcurrentBatches (3), MaxRowsPerDocument (1000), ContinueOnBatchFailure (true), BatchTimeoutSeconds (300), DelayBetweenBatchesMs (100), EnableResultCaching (true) and CacheExpirationMinutes (30). The defaults come from CrestApps.Core.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "ChatInteractions": {
          "BatchProcessing": {
            "RowBatchSize": 50
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__ChatInteractions__BatchProcessing__RowBatchSize=50

See AI Chat Interactions.

AI documents, data sources and file sources​

Shared PostgreSQL and Elasticsearch connections​

SectionsCrestApps:PostgreSQL, CrestApps:Elasticsearch
ControlsThe connection every PostgreSQL or Elasticsearch feature uses when it does not define its own

CrestApps:PostgreSQL takes ConnectionString. CrestApps:Elasticsearch takes Url or CloudId, AuthenticationType (None, Basic, ApiKey, Base64ApiKey or KeyIdAndKey), Username, Password, ApiKey, Base64ApiKey, ApiKeyId and CertificateFingerprint.

{
  "OrchardCore": {
    "CrestApps": {
      "PostgreSQL": {
        "ConnectionString": "Host=localhost;Port=5432;Username=<user>;Password=<password>;Database=vectordb"
      },
      "Elasticsearch": {
        "Url": "http://localhost:9200",
        "AuthenticationType": "Basic",
        "Username": "<user>",
        "Password": "<password>"
      }
    }
  }
}
OrchardCore__CrestApps__PostgreSQL__ConnectionString=<connection-string>
OrchardCore__CrestApps__Elasticsearch__Url=http://localhost:9200

These are separate from OrchardCore_Elasticsearch, which configures Orchard Core's own Elasticsearch feature. See AI Data Sources - PostgreSQL and AI Data Sources - Elasticsearch.

Data source connection overrides​

SectionsCrestApps:AI:DataSources:PostgreSQL, CrestApps:AI:DataSources:Elasticsearch
ControlsA different server for AI data sources only. Values here override the shared section.
{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "DataSources": {
          "Elasticsearch": {
            "Url": "http://search.example.com:9200"
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__DataSources__PostgreSQL__ConnectionString=<connection-string>
OrchardCore__CrestApps__AI__DataSources__Elasticsearch__Url=http://search.example.com:9200

A connection stored on a data source wins over both sections. See AI Data Sources.

AI documents in Azure Blob Storage​

SectionCrestApps:AI:AzureDocuments
FeatureAI Documents - Azure Blob Storage (CrestApps.OrchardCore.AI.Documents.Azure)
ControlsWhere uploaded AI documents are stored, and what happens to the container when the tenant is removed

Keys: ConnectionString and ContainerName (both required), BasePath, CreateContainer, RemoveContainer, RemoveFilesFromBasePath. When either required key is missing, the feature logs an error and documents stay on the local file system.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "AzureDocuments": {
          "ConnectionString": "<storage-connection-string>",
          "ContainerName": "ai-documents",
          "CreateContainer": true
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__AzureDocuments__ConnectionString=<storage-connection-string>
OrchardCore__CrestApps__AI__AzureDocuments__ContainerName=ai-documents

See Azure Blob Storage for AI documents.

File sources​

SectionCrestApps:AI:FileSources
ControlsHow much work one file source run may take on, and how often sources re-index

Keys: MaxItemsPerRun (default 200), MaxConcurrentFetches (2), RunCheckIntervalMinutes (15, no effect under Orchard Core) and DefaultRunIntervalMinutes (1440). AllowedLocalRoots is ignored: a tenant can only read its own folder.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "FileSources": {
          "MaxItemsPerRun": 500
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__FileSources__MaxItemsPerRun=500

See File Sources.

MCP and A2A​

MCP server​

SectionCrestApps:AI:McpServer
ControlsHow MCP clients authenticate, and which tools the server exposes

Keys: AuthenticationType (OpenId, ApiKey or None), ApiKey, RequireAccessPermission, ExposeAllTools, Tools. Values here override the MCP Server settings stored in the admin.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "McpServer": {
          "AuthenticationType": "ApiKey",
          "ApiKey": "<api-key>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__McpServer__AuthenticationType=ApiKey
OrchardCore__CrestApps__AI__McpServer__ApiKey=<api-key>

Use None only for local development. See MCP Server.

A2A host​

SectionCrestApps:AI:A2AHost
ControlsHow A2A clients authenticate, and whether agents are exposed as one card with skills

Keys: AuthenticationType (OpenId by default, ApiKey or None), ApiKey, RequireAccessPermission, ExposeAgentsAsSkill.

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "A2AHost": {
          "AuthenticationType": "ApiKey",
          "ApiKey": "<api-key>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__AI__A2AHost__AuthenticationType=ApiKey
OrchardCore__CrestApps__AI__A2AHost__ExposeAgentsAsSkill=true

See A2A Host.

Omnichannel and SMS​

Automated activity processing​

SectionCrestApps:Omnichannel:Automation
FeatureOmnichannel Management, with AI Services enabled
ControlsHow much work one automated-activity pass takes on, and how failed activities are retried

Keys: ProcessorLeaseMilliseconds (default 600000), ProcessorBatchSize (100), MaxActivitiesPerInvocation (1000), MaxProcessingAttempts (5), RetryDelayMinutes (5). Every value must be greater than zero, and the batch size cannot exceed MaxActivitiesPerInvocation.

{
  "OrchardCore": {
    "CrestApps": {
      "Omnichannel": {
        "Automation": {
          "ProcessorBatchSize": 50
        }
      }
    }
  }
}
OrchardCore__CrestApps__Omnichannel__Automation__ProcessorBatchSize=50

See Omnichannel Management and Configuration validation.

Messaging workspace​

SectionCrestApps:Omnichannel:Messaging
ControlsInbox paging, conversation locks, outbox batches, the per-endpoint send budget, and inbound attachment limits

Keys: InboxPageSize (default 50), ConversationLockTimeoutSeconds (10), ConversationLockExpirationSeconds (30), OutboxBatchSize (200), MaxMessagesPerPassPerEndpoint (20), MaxInboundAttachmentBytes (10485760), MaxInboundAttachments (10), AttachmentLinkLifetimeHours (72).

{
  "OrchardCore": {
    "CrestApps": {
      "Omnichannel": {
        "Messaging": {
          "InboxPageSize": 100
        }
      }
    }
  }
}
OrchardCore__CrestApps__Omnichannel__Messaging__InboxPageSize=100

See Messaging Workspace.

Routed message distribution​

SectionCrestApps:Omnichannel:Messaging:RoutedDistribution
ControlsHow routed (push) conversations are offered to agents

Keys: PickupGraceMinutes (default 5), MaxReassignmentAttempts (2), VoiceCapacityWeight (3).

{
  "OrchardCore": {
    "CrestApps": {
      "Omnichannel": {
        "Messaging": {
          "RoutedDistribution": {
            "PickupGraceMinutes": 10
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__Omnichannel__Messaging__RoutedDistribution__PickupGraceMinutes=10

See Messaging Workspace.

SMS keyword replies​

SectionCrestApps:Omnichannel:Messaging:Sms:KeywordReplies
FeatureSMS Messaging Channel
ControlsThe replies sent when a contact texts STOP, HELP or START

Keys: StopMessage, HelpMessage, StartMessage. A key you leave out keeps the built-in reply.

{
  "OrchardCore": {
    "CrestApps": {
      "Omnichannel": {
        "Messaging": {
          "Sms": {
            "KeywordReplies": {
              "HelpMessage": "Contoso support: reply STOP to opt out."
            }
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__Omnichannel__Messaging__Sms__KeywordReplies__HelpMessage=<reply text>

See Messaging Workspace.

Azure Event Grid​

SectionCrestApps:Omnichannel:EventGrid
ControlsHow the Event Grid webhook authenticates incoming events

Keys: EventGridSasKey, AADIssuer, AADAudience, AADMetadataAddress.

{
  "OrchardCore": {
    "CrestApps": {
      "Omnichannel": {
        "EventGrid": {
          "EventGridSasKey": "<sas-key>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__Omnichannel__EventGrid__EventGridSasKey=<sas-key>

See Azure Event Grid.

Telnyx SMS​

SectionOrchardCore_Sms_Telnyx
FeatureTelnyx SMS (CrestApps.OrchardCore.Telnyx.Sms)
ControlsThe configuration-backed Telnyx SMS provider

Keys: ApiKey, MessagingProfileId, WebhookPublicKey, ApiBaseUrl. The provider is enabled whenever ApiKey has a value. The section name follows Orchard Core's OrchardCore_Sms_Twilio convention, and it also sits under the OrchardCore key in the startup project's appsettings.json:

{
  "OrchardCore": {
    "OrchardCore_Sms_Telnyx": {
      "ApiKey": "<telnyx-api-key>",
      "MessagingProfileId": "<messaging-profile-id>",
      "WebhookPublicKey": "<ed25519-public-key>"
    }
  }
}
OrchardCore__OrchardCore_Sms_Telnyx__ApiKey=<telnyx-api-key>
OrchardCore__OrchardCore_Sms_Telnyx__MessagingProfileId=<messaging-profile-id>

The SMS settings screen wins while its Telnyx provider is enabled. See Telnyx SMS.

Telephony​

Telnyx voice is configured only on the Telnyx tab of the telephony settings; it reads no configuration section. See Telnyx.

Telephony commands​

SectionCrestApps_Telephony:Commands
ControlsThe deadline for one PBX command, such as a dial, transfer or hang-up

Key: Timeout (default 00:00:10, from one second to two minutes).

{
  "OrchardCore": {
    "CrestApps_Telephony": {
      "Commands": {
        "Timeout": "00:00:15"
      }
    }
  }
}
OrchardCore__CrestApps_Telephony__Commands__Timeout=00:00:15

See Voice Routing.

Telephony coordination​

SectionCrestApps_Telephony:Coordination
ControlsLock waits and leases around calls, and how long client-recorded calls are kept open

Keys: InteractionLockTimeout (default 00:00:05), InteractionLockExpiration (00:02:00), NewInteractionGracePeriod (00:00:15), ClientRecordedCallMaxAge (04:00:00), ClientRecordedCallSilenceTimeout (00:05:00), TokenRefreshLockTimeout (00:00:10), TokenRefreshLockExpiration (00:01:00). Each lease expiry must be longer than its lock wait.

{
  "OrchardCore": {
    "CrestApps_Telephony": {
      "Coordination": {
        "InteractionLockTimeout": "00:00:10"
      }
    }
  }
}
OrchardCore__CrestApps_Telephony__Coordination__InteractionLockTimeout=00:00:10

See Timings are configuration, not constants.

Call recordings in Azure Blob Storage​

SectionCrestApps:Telephony:AzureRecordings
ControlsWhere call recordings are stored. Recordings stay encrypted before they reach Azure.

Keys: ConnectionString, ContainerName, BasePath (supports Liquid such as {{ ShellSettings.Name }}), CreateContainer.

{
  "OrchardCore": {
    "CrestApps": {
      "Telephony": {
        "AzureRecordings": {
          "ConnectionString": "<storage-connection-string>",
          "ContainerName": "telephony-recordings",
          "BasePath": "{{ ShellSettings.Name }}"
        }
      }
    }
  }
}
OrchardCore__CrestApps__Telephony__AzureRecordings__ConnectionString=<storage-connection-string>
OrchardCore__CrestApps__Telephony__AzureRecordings__ContainerName=telephony-recordings

See Recording storage in Azure Blob Storage.

Default Asterisk provider​

SectionCrestApps:Asterisk:Default
ControlsA host-level Default Asterisk provider that every tenant with the Asterisk module can select

Required keys: BaseUrl, UserName, Password, ApplicationName. The provider appears only when all four have values. Other keys include EndpointTemplate, TimeoutSeconds, VoicemailContext, VoicemailExtensionTemplate, VoicemailPriority and the browser WebRTC settings.

{
  "OrchardCore": {
    "CrestApps": {
      "Asterisk": {
        "Default": {
          "BaseUrl": "http://pbx.example.com:8088/ari/",
          "UserName": "<ari-user>",
          "Password": "<ari-password>",
          "ApplicationName": "crestapps-telephony"
        }
      }
    }
  }
}
OrchardCore__CrestApps__Asterisk__Default__BaseUrl=http://pbx.example.com:8088/ari/
OrchardCore__CrestApps__Asterisk__Default__Password=<ari-password>

In the Production environment a tenant refuses to start when this section holds one of the development credentials published in this repository. See Asterisk.

Asterisk coordination​

SectionCrestApps:Asterisk:Coordination
ControlsLock and HTTP timings for Asterisk, and the real-time event buffer

Keys: CredentialLockTimeout (default 00:00:05), CredentialLockExpiration (00:00:30), ChannelBindingCreateLockTimeout (00:00:10), PendingReclamationThreshold (00:05:00), HttpTotalRequestTimeout (00:00:30), HttpAttemptTimeout (00:00:10), RealtimeEventBufferCapacity (1000, at most 100000), RealtimeEventBackpressureTimeout (00:00:05), MaxRealtimeMessageBytes (1048576).

{
  "OrchardCore": {
    "CrestApps": {
      "Asterisk": {
        "Coordination": {
          "HttpTotalRequestTimeout": "00:01:00"
        }
      }
    }
  }
}
OrchardCore__CrestApps__Asterisk__Coordination__HttpTotalRequestTimeout=00:01:00

See Configuration validation.

WebSockets​

SectionCrestApps:WebSockets
ControlsThe ASP.NET Core WebSocket middleware used by features that host raw WebSockets, such as Telnyx voice media

Keys: KeepAliveInterval, KeepAliveTimeout, AllowedOrigins. ASP.NET Core's defaults apply to any key you leave out.

{
  "OrchardCore": {
    "CrestApps": {
      "WebSockets": {
        "KeepAliveInterval": "00:00:30",
        "AllowedOrigins": [ "https://app.example.com" ]
      }
    }
  }
}
OrchardCore__CrestApps__WebSockets__KeepAliveInterval=00:00:30
OrchardCore__CrestApps__WebSockets__AllowedOrigins__0=https://app.example.com

See WebSockets.

Contact Center​

The Contact Center sections are validated when the tenant starts. An invalid value stops that tenant from starting instead of failing later. See Configuration validation.

Topology​

SectionCrestApps:ContactCenter:Topology
ControlsThe deployment topology the tenant declares, and whether its infrastructure requirements are enforced

Key: ProfileId, such as single-node-distributed or single-node-development. Leaving it out runs the tenant as a single node with no infrastructure checks.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Topology": {
          "ProfileId": "single-node-distributed"
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Topology__ProfileId=single-node-distributed

See The declared topology is enforced at startup.

Health checks​

SectionCrestApps:ContactCenter:HealthChecks
ControlsHealth check thresholds, the optional node serving gate, and the shared health endpoint warning

Keys: DeadLetterDegradedThreshold (default 1), DeadLetterUnhealthyThreshold (25), OverdueBacklogDegradedThreshold (50), OverdueBacklogUnhealthyThreshold (500), EnableNodeServingGate (false), ConsecutiveFailuresBeforeUnready (3), ConsecutiveSuccessesBeforeReady (2), AllowUnsafeSharedEndpointRoute.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "HealthChecks": {
          "DeadLetterUnhealthyThreshold": 50
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__HealthChecks__DeadLetterUnhealthyThreshold=50

See Health checks.

Base-voice verification​

SectionCrestApps:ContactCenter:BaseVoiceVerification
ControlsThe operator's declaration that the WebRTC audio path of this deployment was verified

Keys: AudioVerificationAcknowledged, AudioVerificationEvidenceReference. An acknowledgment needs an evidence reference. In the Production environment, readiness is withheld until the acknowledgment is set.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "BaseVoiceVerification": {
          "AudioVerificationAcknowledged": true,
          "AudioVerificationEvidenceReference": "<ticket-or-document-id>"
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__BaseVoiceVerification__AudioVerificationAcknowledged=true

See Base-voice deployment acceptance.

Feature lifecycle​

SectionCrestApps:ContactCenter:FeatureLifecycle
ControlsHow long a Contact Center feature waits for running work to finish when it is disabled

Key: DrainTimeoutSeconds (default 30, from 1 to 300).

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "FeatureLifecycle": {
          "DrainTimeoutSeconds": 60
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__FeatureLifecycle__DrainTimeoutSeconds=60

See Feature lifecycle contract.

Coordination​

SectionCrestApps:ContactCenter:Coordination
ControlsLock waits and leases for inbound calls, assignments and reservations, and agent pre-dial timing

Keys: InboundLockTimeout (default 00:00:10), InboundLockExpiration (00:01:00), AssignmentLockTimeout (00:00:10), AssignmentLockExpiration (00:00:30), ReservationLockTimeout (00:00:10), ReservationLockExpiration (00:00:30), AgentPreDialEnabled (true), AgentPreDialRingGrace (00:00:05), AgentPreDialMinimumOfferRemaining (00:00:02), ReclaimLockWait (00:00:00.050), ExpiryPageSize (100), QueuedWorkSyncLease (00:00:02), QueuedWorkSyncFallbackInterval (00:00:30).

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Coordination": {
          "AssignmentLockTimeout": "00:00:15"
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Coordination__AssignmentLockTimeout=00:00:15

See Timings are configuration, not constants.

Agent availability​

SectionCrestApps:ContactCenter:Availability
FeatureContact Center Agents
ControlsHow long an agent heartbeat counts as live, and the longest wrap-up before capacity is recovered

Keys: HeartbeatTimeout (default 00:01:30), MaximumWrapUpDuration (00:15:00).

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Availability": {
          "MaximumWrapUpDuration": "00:10:00"
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Availability__MaximumWrapUpDuration=00:10:00

See Agent availability tuning.

Webhook ingress​

SectionCrestApps:ContactCenter:WebhookIngress
FeatureContact Center Voice
ControlsPer-node rate and concurrency limits for provider webhooks, and accepted event age

Keys: ConcurrencyPermitLimit (default 8), RatePermitLimit (120), RatePeriodSeconds (60), MaximumDeliveryAgeSeconds (900), MaximumFutureSkewSeconds (120).

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "WebhookIngress": {
          "RatePermitLimit": 300
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__WebhookIngress__RatePermitLimit=300

See Provider webhook ingress tuning.

Dialer compliance​

SectionsCrestApps:ContactCenter:Compliance, CrestApps:ContactCenter:Compliance:ManualDialing
FeatureContact Center Outbound Dialer
ControlsThe abandonment measurement window, and how soft-phone dials are screened

Compliance takes AbandonmentRollingWindowMinutes (default 30, from 1 to 1440). ManualDialing takes RespectDoNotCall (true), EnforceCallingWindow (false), CallingCalendarId and DefaultRegionCode.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Compliance": {
          "AbandonmentRollingWindowMinutes": 60,
          "ManualDialing": {
            "EnforceCallingWindow": true,
            "DefaultRegionCode": "US"
          }
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Compliance__AbandonmentRollingWindowMinutes=60
OrchardCore__CrestApps__ContactCenter__Compliance__ManualDialing__RespectDoNotCall=true

See Outbound compliance gate and Manual soft-phone screening.

Predictive dialing​

SectionCrestApps:ContactCenter:PredictiveDialing
FeatureContact Center Paced Dialing
ControlsThe timings and limits of predictive pacing, and how its statistics are measured

Every value is validated on start, and an invalid one stops the tenant with the key named.

KeyDefaultRule
PacingInterval00:00:02Greater than zero.
PacingDebounce00:00:00.250Greater than zero and shorter than PacingInterval.
PacingLockExpiration00:00:15Longer than PacingInterval.
MaxDialsPerCycle251 to 500.
ConnectLockWait00:00:00.150Greater than zero and shorter than 2 seconds.
ComplianceWindowDays301 to 90.
DefaultRingHorizon00:00:12Greater than zero.
AnsweredUnconnectedSweepAfter00:00:05Longer than 2 seconds.
StatisticsCacheDuration00:00:05Greater than zero.
MaxTimingSamples2000Greater than zero.

Predictive profiles reserve an agent for every call, so today only StatisticsCacheDuration and MaxTimingSamples are read, when a Predictive profile's measured answer rate is shown. The rest govern over-dialing, which is not available yet.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "PredictiveDialing": {
          "StatisticsCacheDuration": "00:00:10",
          "MaxTimingSamples": 1000
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__PredictiveDialing__MaxTimingSamples=1000

See Predictive dialing.

Reporting​

SectionCrestApps:ContactCenter:Reporting
ControlsThe widest date range a Contact Center report accepts

Key: MaximumReportRange (default 400.00:00:00, 400 days).

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Reporting": {
          "MaximumReportRange": "180.00:00:00"
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Reporting__MaximumReportRange=180.00:00:00

See Report Catalog.

Retention​

SectionCrestApps:ContactCenter:Retention
ControlsHow many days each kind of Contact Center record is kept, the floors that hold records longer, and the purge batch size

Every ...RetentionDays key defaults to 0, which keeps records indefinitely. Keys include InteractionRetentionDays, InteractionEventRetentionDays, CallSessionRetentionDays, QueueItemRetentionDays, SharedVoicemailRetentionDays, CallQualityRecordRetentionDays, LegalHoldMinimumDays, ProjectionReplayHorizonDays, PurgeBatchSize and MaxPurgeBatchesPerCycle.

{
  "OrchardCore": {
    "CrestApps": {
      "ContactCenter": {
        "Retention": {
          "InteractionEventRetentionDays": 400,
          "CallSessionRetentionDays": 400
        }
      }
    }
  }
}
OrchardCore__CrestApps__ContactCenter__Retention__InteractionEventRetentionDays=400

See Retention, legal holds, and replay horizon for the full list.

Content transfer, Do Not Call and background work​

Content transfer​

SectionCrestApps:ContentTransfer
ControlsImport and export batch sizes, upload size limits, and which content types can be imported

Keys: ImportBatchSize (default 100), ExportBatchSize (200), ExportQueueThreshold (500), MaxUploadFileSize (1073741824), MaxUploadChunkSize (26214400), TemporaryFileLifetime (01:00:00), AllowAllContentTypes (true), AllowedContentTypes.

{
  "OrchardCore": {
    "CrestApps": {
      "ContentTransfer": {
        "MaxUploadFileSize": 5368709120
      }
    }
  }
}
OrchardCore__CrestApps__ContentTransfer__MaxUploadFileSize=5368709120
OrchardCore__Default__CrestApps__ContentTransfer__ImportBatchSize=50

See Content Transfer.

Background work pacing​

SectionCrestApps:BackgroundWork:Pacing
ControlsHow much database time bulk imports and Do Not Call list jobs may use

Keys: DatabaseShare (default 0.25, from 0.05 to 1), MaxPause (00:00:30).

{
  "OrchardCore": {
    "CrestApps": {
      "BackgroundWork": {
        "Pacing": {
          "DatabaseShare": 0.5
        }
      }
    }
  }
}
OrchardCore__CrestApps__BackgroundWork__Pacing__DatabaseShare=0.5

See Limiting how much of the database an import uses.

Do Not Call files in Azure Blob Storage​

SectionCrestApps:DncRegistry:AzureBlobStorage
FeatureDNC Registry - Azure Blob Storage (CrestApps.OrchardCore.DncRegistry.Azure)
ControlsWhere uploaded local Do Not Call list files are stored

Keys: ConnectionString and ContainerName (both required), BasePath, CreateContainer, RemoveContainer, RemoveFilesFromBasePath. When either required key is missing, files stay on the local file system and an error is logged.

{
  "OrchardCore": {
    "CrestApps": {
      "DncRegistry": {
        "AzureBlobStorage": {
          "ConnectionString": "<storage-connection-string>",
          "ContainerName": "dnc-registry"
        }
      }
    }
  }
}
OrchardCore__CrestApps__DncRegistry__AzureBlobStorage__ConnectionString=<storage-connection-string>
OrchardCore__CrestApps__DncRegistry__AzureBlobStorage__ContainerName=dnc-registry

The registry credentials (USA FTC, Canada DNCL) are set only in the admin. See DNC Registry.

Phone number verification​

The phone number verification providers have no configuration section. Set them up under Settings > Phone Number Verifications, or with the recipe settings step. See Phone Number Verifications.

Orchard Core sections the modules depend on​

Some features rely on Orchard Core's own configuration. These sections belong to Orchard Core; see its documentation for their keys.

SectionUsed for
OrchardCore_RedisThe Redis connection behind the distributed lock and the SignalR Redis backplane that a production Contact Center requires. See Multi-node real-time backplane.
OrchardCore_HealthChecksThe route of Orchard Core's shared health endpoint. Contact Center warns when it still claims a liveness route. See Health checks.
OrchardCore_ElasticsearchOrchard Core's Elasticsearch feature, which owns the Orchard-managed search indexes.
OrchardCore_Sms_TwilioOrchard Core's configuration-backed Twilio SMS provider.
OrchardCore__OrchardCore_Redis__Configuration=<redis-connection-string>
OrchardCore__OrchardCore_HealthChecks__Url=/health/aggregate

Local development with Aspire​

The Aspire host (CrestApps.Aspire.AppHost) passes configuration to the CMS as environment variables, so the CMS needs no per-feature setup. It sets:

  • OrchardCore__CrestApps__PostgreSQL__ConnectionString and OrchardCore__CrestApps__Elasticsearch__* for the shared connections;
  • OrchardCore__OrchardCore_Elasticsearch__* and OrchardCore__OrchardCore_Redis__Configuration for Orchard Core's own features;
  • an Ollama connection at OrchardCore__CrestApps__AI__Connections__90__*, a high index so it is added beside your own connections rather than replacing the first one;
  • AuthenticationType None for the MCP server and the A2A host, for local clients only;
  • the OrchardCore__CrestApps__Asterisk__Default__* keys for the local Asterisk container.

The app host's own credentials are Aspire parameters (Parameters:PostgresUser, Parameters:PostgresPassword, Parameters:ElasticsearchPassword), which you can set with user secrets in the app host project. See Getting Started.

Deprecated section names​

These older names still work unless noted, but use the new names in new configuration:

Old sectionNew sectionStill read
CrestApps_AI:DefaultParametersCrestApps:AI:DefaultParametersYes, with a warning in the log. The new section wins.
CrestApps_AI:Providers (connections nested under each provider)CrestApps:AI:Connections and CrestApps:AI:DeploymentsYes
CrestApps:McpServerCrestApps:AI:McpServerYes. The new section wins.
CrestApps:A2AHostCrestApps:AI:A2AHostYes. The new section wins.
CrestApps:Sms:WorkspaceCrestApps:Omnichannel:MessagingNo
CrestApps:Sms:RoutedDistributionCrestApps:Omnichannel:Messaging:RoutedDistributionNo
CrestApps:Sms:Portal:KeywordRepliesCrestApps:Omnichannel:Messaging:Sms:KeywordRepliesNo