Skip to content

Configuring Arc

Arc reads all of its settings from a single ArcOptions object. Wherever Arc runs — an ASP.NET Core web app, an Arc.Core console or worker, or the full Cratis stack — you configure it the same way: bind ArcOptions from configuration, then optionally override it in code. This page is the map: the hosting models, the three configuration mechanisms, and the full ArcOptions tree.

HostBootstrapActivateUse it for
ASP.NET CoreWebApplication.CreateBuilder(args)builder.AddCratisArc(...)app.UseCratisArc()app.Run()A web API or full-stack app. The listen URL comes from Kestrel / launchSettings.json.
Arc.CoreArcApplication.CreateBuilder(args)builder.AddCratisArc(...)app.UseCratisArc()await app.RunAsync()A console app or worker with no ASP.NET Core. The listen URL comes from ArcOptions.Hosting.ApplicationUrl.
Cratis stackWebApplication.CreateBuilder(args)builder.AddCratis(...)app.UseCratis()app.Run()Arc + Chronicle in one host — see the Cratis package.

AddCratisArc takes its arguments in this order: configureOptions (an Action<ArcOptions>), configureBuilder (an Action<IArcBuilder> for adding Chronicle, MongoDB, or EF Core), and configSectionPath. Use the named configureBuilder: argument when you only want to add a builder feature:

builder.AddCratisArc(configureBuilder: arc => arc.WithChronicle());

For raw IServiceCollection wiring (advanced), AddCratisArcCore() registers the same services without the builder.

Every setting can be supplied three ways, layered in this order — later wins:

  1. appsettings.json under the Cratis:Arc section.
  2. Environment variables with the Cratis__Arc__ prefix (.NET maps the __ separator onto nested keys), for example Cratis__Arc__GeneratedApis__RoutePrefix.
  3. Code, via the configureOptions callback — it runs after binding, so it overrides the file and the environment.
builder.AddCratisArc(options =>
{
options.GeneratedApis.RoutePrefix = "v1/api"; // overrides appsettings / env
});
OptionTypeDefaultWhat it controls
CorrelationId.HttpHeaderstringX-Correlation-IDThe header carrying the correlation ID.
Tenancy.ResolverTypeTenantResolverTypeHeaderHow the tenant is resolved: Header, Query, Claim, Subdomain, Development, or Fixed.
Tenancy.HttpHeaderstringx-cratis-tenant-idThe header used when ResolverType is Header, and the fallback header when it is Subdomain.
Tenancy.QueryParameterstringtenantIdThe query parameter used when ResolverType is Query.
Tenancy.ClaimTypestringtenant_idThe claim used when ResolverType is Claim.
Tenancy.FixedTenantIdstringdevelopmentThe tenant every request resolves to when ResolverType is Fixed or Development.
Tenancy.DevelopmentTenantIdstringdevelopmentThe same value under its original name — reading or writing either key sets both. Supply only one; if both are present the binder’s property order decides.
GeneratedApis.RoutePrefixstringapiBase prefix for generated command and query routes.
GeneratedApis.SegmentsToSkipForRouteint0Namespace segments to drop when building a route.
GeneratedApis.IncludeCommandNameInRoutebooltrueAppend the command name as the last route segment.
GeneratedApis.IncludeQueryNameInRoutebooltrueAppend the query name as the last route segment.
Query.KeepAliveIntervalTimeSpan00:00:30Keep-alive cadence for observable (real-time) queries.
IdentityDetailsProviderType?null (auto-discovered)The identity details provider type.
Hosting.ApplicationUrlstringhttp://+:5001/The listen URL — Arc.Core only (ignored under ASP.NET Core).
JsonSerializerOptionsJsonSerializerOptionsArc defaultsThe serializer used across controllers, manual serialization, and generated endpoints. Configure in code only.

Route generation (GeneratedApis) and JSON serialization have worked examples on the ASP.NET Core configuration page; Query.KeepAliveInterval is covered with the observable query demultiplexer.

The configureBuilder callback exposes IArcBuilder, which is where Arc’s pluggable backends attach:

  • arc.WithChronicle() — event sourcing with Cratis Chronicle.
  • arc.WithMongoDB() — MongoDB read models. See MongoDB.
  • arc.WithEntityFrameworkCore() — relational read models. See Entity Framework.

Arc resolves an identity details provider automatically by type discovery. Set ArcOptions.IdentityDetailsProvider to pin a specific type, or register one explicitly:

builder.Services.AddIdentityProvider<MyIdentityDetailsProvider>();

For authenticating requests, see Authentication. When you use the Cratis package, Microsoft Identity Platform authentication is wired for you.

A singleton that takes a scoped dependency in its constructor holds that one instance forever — the classic captive dependency. In a multi-tenant application it is the difference between “the right tenant’s data” and “whichever tenant happened to be first”, and nothing about it fails loudly. .NET has a detector for exactly this: ServiceProviderOptions.ValidateScopes, which the host turns on in Development so the capture throws the moment you resolve it.

Arc keeps that detector on. Every host Arc supports settles two ServiceProviderOptions fields for you:

OptionValue Arc appliesWhy
ValidateScopesbuilder.Environment.IsDevelopment()The host’s own default, restated so it survives. On in Development, off everywhere else.
ValidateOnBuildfalseArc supplies registrations contextually — IHostApplicationBuilder, the type a convention binding is for, values only an executing command or an in-flight request can hand over. Eager validation constructs every registration up front and can resolve none of them, so leaving it on fails Build() outright.

The reason both fields have to be stated together is that UseDefaultServiceProvider and ConfigureContainer each start from a brand new options object — setting one field discards every other value the host had already applied. Turning ValidateOnBuild off without restating ValidateScopes is what silently took the captive-dependency check with it.

You own your container. State your own choice and it wins — with one ordering rule that differs by host:

// ASP.NET Core and the generic host: call it AFTER AddCratisArc.
builder.AddCratisArc();
builder.Host.UseDefaultServiceProvider(options =>
{
options.ValidateScopes = true; // on in every environment, not just Development
options.ValidateOnBuild = false; // keep this off — see the table above
});

AddCratisArc calls UseDefaultServiceProvider itself on these hosts, and the last call wins, so a call placed before AddCratisArc is discarded.

Arc.Core has no such ordering rule. ArcApplicationBuilder applies its defaults while it is being constructed, so a ConfigureContainer call — your own factory, Autofac, Lamar — replaces them whether you make it before or after AddCratisArc:

var builder = ArcApplication.CreateBuilder(args);
builder.ConfigureContainer(new MyServiceProviderFactory()); // before or after — either wins
builder.AddCratisArc();

ValidateScopes follows IsDevelopment(), which is an exact match on the environment name Development. A host running under a custom name — Local, Dev, Staging — is not Development by that rule, so it gets no scope validation, exactly as a bare .NET host would. If you want the check there, ask for it explicitly with the override above.

CORS is not an Arc option — configure it with standard ASP.NET Core (builder.Services.AddCors(...) and app.UseCors(...)). Arc neither wraps nor replaces it.

If you opt queries into the HTTP QUERY method, add QUERY to your allowed methods (policy.WithMethods("GET", "POST", "QUERY")) — it is not a simple method, so cross-origin calls preflight. The default GET transport needs no CORS change.