Elarion
Reference

Configuration

Every configuration key and MSBuild property Elarion reads, in one place.

This page collects the runtime configuration sections and build properties Elarion reads. Most are optional with sensible defaults.

Modules

Feature modules are enabled by default. Disable one by name:

{
  "Modules": {
    "Clients": { "Enabled": false }
  }
}
KeyDefaultEffect
Modules:{Name}:EnabledtrueDisables a feature module's handlers, endpoints, JSON metadata, and scheduled jobs. Ignored for core modules.

See Modules.

Scheduler

Read by AddInMemoryScheduler(IConfiguration):

{
  "Scheduler": {
    "Enabled": true,
    "MaxConcurrentExecutions": 8,
    "MaxRetainedCompletedJobs": 1024,
    "MaxMisfireCatchUpRuns": 32
  }
}
KeyDefaultEffect
Scheduler:EnabledtrueMaster switch for the in-memory scheduler.
Scheduler:MaxConcurrentExecutionsimplementation defaultGlobal cap on concurrent job executions.
Scheduler:MaxRetainedCompletedJobsimplementation defaultHow many terminal job states are kept in memory.
Scheduler:MaxMisfireCatchUpRunsimplementation defaultUpper bound on catch-up runs for the CatchUp misfire policy.

See Scheduling.

Scheduled job placeholders

[ScheduledJob] string properties (FixedRate, FixedDelay, Cron, Enabled, …) support Spring-style configuration placeholders, re-resolved per occurrence:

PlaceholderBehavior
${Jobs:Interval}Resolve the key; throw during resolution if missing.
${Jobs:Interval:-15m}Resolve the key; fall back to 15m if missing or blank.

See Schedules.

JSON-RPC schema generation (MSBuild)

Properties read by Elarion.AspNetCore.SchemaGeneration during build:

PropertyDefaultPurpose
ElarionJsonRpcGenerateSchemafalseEnables the build-time export targets.
ElarionJsonRpcGenerateSchemaOnBuildsame as aboveControls automatic generation during dotnet build.
ElarionJsonRpcSchemaOutputPath$(BaseIntermediateOutputPath)rpc-schema.jsonExact output file path.
ElarionJsonRpcSchemaOutputDirectory$(BaseIntermediateOutputPath)Output directory (with …FileName).
ElarionJsonRpcSchemaFileNamerpc-schema.jsonOutput file name.
ElarionJsonRpcSchemaEnvironmentDevelopmentEnvironment used while loading the app.
ElarionJsonRpcSchemaApplicationArgumentsemptyArgs passed to the app entry point.
ElarionJsonRpcSchemaGenerationOptionsemptyExtra tool arguments.

See Schema generation.

Current user (options, not config)

AddElarionCurrentUser(options => …) configures claim mapping in code rather than appsettings:

OptionDefault
UserIdClaimType"sub"
EmailClaimType"email"
RoleClaimTypeClaimTypes.Role
DefaultRolesWhenAuthenticatedempty

See Current user.

Packages

What each Elarion package contains, its expected dependencies, and when you need it.

How Elarion differs from ASP.NET Core

A side-by-side look at where Elarion's conventions diverge from idiomatic ASP.NET Core, and the trade-off you accept.

On this page

ModulesSchedulerScheduled job placeholdersJSON-RPC schema generation (MSBuild)Current user (options, not config)