Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Add Settings File to .NET Console Application ======

===== App Settings File =====

Create appsettings.json file in project root. Example contents:

<file javascript appsettings.json>
{
  "Settings": {
    "Title": "My Application",
    "Timeout": 30
  }
}
</file>

===== Packages / Project Output =====

Add the following packages to the project's .csproj file:

<code xml>
<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="7.0.4" />
  <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="7.0.0" />
  <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
</ItemGroup>
</code>

Add the following directive to copy the appsettings file with the binary:

<code xml>
<ItemGroup>
  <Content Include="appsettings.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>
</ItemGroup>
</code>
===== Settings Class =====

Create a class to hold the settings:

<code csharp>
public sealed class AppSettings
{
  public required string Title { get; set; }
  public required int Timeout { get; set; }
}
</code>

===== Initialize Configuration =====

Initialize the configuration, and retrieve the settings:

<code csharp>
IConfiguration config = new ConfigurationBuilder()
  .AddJsonFile("appsettings.json")
  .AddEnvironmentVariables()
  .Build();

AppSettings appSettings = config.GetRequiredSection("Settings").Get<AppSettings>();
</code>

===== Access Settings =====

Access the settings:

<code csharp>
var title = appSettings.Title;
var timeout = appSettings.Timeout;
</code>

===== Alternate Access Method =====

<WRAP center round tip 60%>
If you use this method exclusively, you don't need the settings class.
</WRAP>

<code csharp>
var title = config.GetValue<string>("Settings:Title");
var timeout = config.GetValue<int>("Settings:Timeout");
</code>

{{tag>dotnet}}