跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
部署与云服务

configuration-and-environments

How settings are layered with appsettings files and environment variables, what the local and docker environments are, and how to add a new setting. Use when adding configuration, a connection string or environment-specific behaviour.

LeanMeanCleanApps · 已有静态检查记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add LeanMeanCleanApps/CleanMinimalApi --skill configuration-and-environments

技能说明


name: configuration-and-environments description: How settings are layered with appsettings files and environment variables, what the local and docker environments are, and how to add a new setting. Use when adding configuration, a connection string or environment-specific behaviour. metadata: scope: shared

Configuration and environments

The rule

Settings come from appsettings.json, then appsettings.<environment>.json, then environment variables (Section__Key). The base file holds safe defaults for anywhere; the environment files hold what's only true for that environment.

The Lambda template has no appsettings files or environments. Its startup builds configuration from environment variables alone, so the same keys are set as ConnectionStrings__MovieReviews and Database__SeedSampleData, and the defaults live in Startup.

EnvironmentSet byUsed for
locallaunchSettings.json (DOTNET_ENVIRONMENT=local)dotnet run on a developer machine: console logs, sample data on
dockerdocker-compose.yml and the Dockerfiledocker compose up: telemetry over OTLP through the collector to the Aspire dashboard, database in /app/data, sample data on
anything elsethe hostReal deployments: base settings only, sample data off, HSTS on

Settings that exist today:

KeyMeaning
ConnectionStrings:MovieReviewsSQLite connection string. Data Source=Name;Mode=Memory;Cache=Shared keeps everything in memory.
Database:SeedSampleDataSeed sample data into an empty database (sample-data).
Authentication:Authority, Authentication:AudienceOnly in a solution created with --include-auth: turn on token authentication (optional-token-auth). MCP also has Authentication:Scopes, published in its protected resource metadata.
Serilog:*Logging (serilog).

Steps

  1. Put the safe default in appsettings.json. If the default is "off" or empty, still write the key so people can find it.
  2. Override it only in the environment files that need a different value.
  3. Read a single value with configuration.GetValue<T>("Section:Key"); read a group into a settings class with a SectionName constant and a FromConfiguration(IConfiguration) method, like AuthenticationSettings in a solution with authentication.
  4. Document the key in docs/RUN.md if someone running the app might change it.
  5. Tests override settings in memory (integration-tests), never by editing the JSON.

Don't

  • Put secrets, passwords or tokens in any appsettings*.json file. Use environment variables or user secrets.
  • Check IsEnvironment("local") for behaviour that should be a setting. Add a setting instead.
  • Read Environment.GetEnvironmentVariable directly. Go through IConfiguration.

Check

dotnet test