how to set ASPNETCORE ENVIRONMENT to be considered for publishing an asp net core application

Question

when i publish my asp net core web application to my local file system  it always takes the production-config and the ASPNETCORE ENVIRONMENT variable with the value    Production    how and where do i have to set the value of the ASPNETCORE ENVIRONMENT variable so that it will be considered not only for debugging  but also for the publishing  i already tried the following options without success    in windows settings in  pubxml file in launchSettings json in project json

User · Answer

I found it working for me by setting this variable directly on Azure platorm  if you use it   Just select your web app -  configuration -  application settings and add the variable and its value  then press Save button

User · Answer

This is how we can set it in run-time  public class Program       public static void Main string   args                Environment SetEnvironmentVariable  quot ASPNETCORE ENVIRONMENT quot    quot Development quot             BuildWebHost args  Run               public static IWebHost BuildWebHost string   args    gt          WebHost CreateDefaultBuilder args               UseStartup lt Startup gt                 Build

User · Answer

Create your appsettings   json files   Examples  appsettings Development json  appsettings Staging json  appsettings Production json  Add your variables to those files  Create a separate publish profile for each environment  like you normally would  Open PublishProfiles Development pubxml  naming will be based on what you named the Publish Profile    Simply add a tag to the PublishProfile to set the EnvironmentName variable  the appsettings   json file naming convention does the rest         lt PropertyGroup gt         lt EnvironmentName gt Development lt  EnvironmentName gt       lt  PropertyGroup gt    Reference  https   docs microsoft com en-us aspnet core host-and-deploy visual-studio-publish-profiles view aspnetcore-3 1  Refer to the    Set the Environment    section

User · Answer

Option1  To set the ASPNETCORE ENVIRONMENT environment variable in windows  Command line - setx ASPNETCORE ENVIRONMENT  quot Development quot  PowerShell -  Env ASPNETCORE ENVIRONMENT    quot Development quot  For other OS refer this - https   docs microsoft com en-us aspnet core fundamentals environments Option2  If you want to set ASPNETCORE ENVIRONMENT using web config then add aspNetCore like this-  lt configuration gt     lt  --     Configure your application settings in appsettings json  Learn more at http   go microsoft com fwlink  LinkId 786380   -- gt     lt system webServer gt       lt handlers gt         lt add name  quot aspNetCore quot  path  quot   quot  verb  quot   quot  modules  quot AspNetCoreModule quot  resourceType  quot Unspecified quot    gt       lt  handlers gt       lt aspNetCore processPath  quot   MyApplication exe quot  arguments  quot  quot  stdoutLogEnabled  quot false quot  stdoutLogFile  quot   logs stdout quot  forwardWindowsAuthToken  quot false quot  gt         lt environmentVariables gt           lt environmentVariable name  quot ASPNETCORE ENVIRONMENT quot  value  quot Development quot    gt         lt  environmentVariables gt       lt  aspNetCore gt     lt  system webServer gt   lt  configuration gt

User · Answer

With the latest version of dotnet cli  2 1 400 or greater   you can just set this msbuild property   EnvironmentName  and publish tooling will take care of adding ASPNETCORE ENVIRONMENT to the web config with the environment name    Also  XDT support is available starting 2 2 100-preview1   Sample  https   github com vijayrkn webconfigtransform blob master README md

User · Answer

I know this is an old post however thought I d throw my simple solution into the mix since no one has suggested it   I use the current directory to determine the current environment then flip the connection string and environment variable  This works great so long as you have a naming convention for your site folders such as test beta sandbox       protected override void OnConfiguring DbContextOptionsBuilder optionsBuilder                var dir   Environment CurrentDirectory          string connectionString           if  dir Contains  test   StringComparison OrdinalIgnoreCase                         connectionString   new ConnectionStringBuilder server   xxx   database   xxx   ConnectionString              Environment SetEnvironmentVariable  ASPNETCORE ENVIRONMENT    Development                      else                       connectionString   new ConnectionStringBuilder server   xxx   database   xxx   ConnectionString              Environment SetEnvironmentVariable  ASPNETCORE ENVIRONMENT    Production                       optionsBuilder UseSqlServer connectionString           optionsBuilder UseLazyLoadingProxies            optionsBuilder EnableSensitiveDataLogging

User · Answer

Other option that we use in our projects in order to be able to set the environment per-site is to add a Parameters xml file to the project with the following content    lt parameters gt         lt parameter name  IIS Web Application Name  defaultValue  MyApp  tags  IisApp    gt             lt parameter name  Environment  description  Environment  tags    gt           lt parameterEntry kind  XmlFile  scope  Web config   match   configuration location system webServer aspNetCore environmentVariables environmentVariable  name  ASPNETCORE ENVIRONMENT    value    gt         lt  parameter gt       lt  parameters gt    The Build Action for this file is Content and the Copy Action is Copy If Newer so it will be part of the package to deploy   Then  to deploy the package and set the environment  in the Release  under the  WinRM - IIS Web App Deployment  task  it works just as well when using the  IIS web app deploy  task   we set additional arguments for msdeploy   -setParam kind ProviderPath scope contentPath value  MySite  -setParam name  Environment  value  Stage    This way we can have multiple releases  all using the same artifact  but deployed as different environments

User · Answer

Simple way to set it in visual studio IDE   Project   Properties  Debug   Environment variables

User · Answer

Other than the options mentioned above  there are a couple of other Solutions   1  Modifying the project file   CsProj  file    MSBuild supports the EnvironmentName Property which can help to set the right environment variable as per the Environment you wish to Deploy  The environment name would be added in the web config during the Publish phase   Simply open the project file    csProj  and add the following XML    lt  -- Custom Property Group added to add the Environment name during publish   The EnvironmentName property is used during the publish for the Environment variable in web config   -- gt     lt PropertyGroup Condition      Configuration         Or    Configuration       Debug   gt       lt EnvironmentName gt Development lt  EnvironmentName gt     lt  PropertyGroup gt     lt PropertyGroup Condition      Configuration         AND    Configuration       Debug    gt       lt EnvironmentName gt Production lt  EnvironmentName gt     lt  PropertyGroup gt    Above code would add the environment name as Development for Debug configuration or if no configuration is specified  For any other Configuration the Environment name would be Production in the generated web config file  More details here  2  Adding the EnvironmentName Property in the publish profiles   We can add the  lt EnvironmentName gt  property in the publish profile as well  Open the publish profile file which is located at the Properties PublishProfiles  profilename pubxml  This will set the Environment name in web config when the project is published  More Details here   lt PropertyGroup gt     lt EnvironmentName gt Development lt  EnvironmentName gt   lt  PropertyGroup gt    3  Command line options using dotnet publish  Additionaly  we can pass the property EnvironmentName as a command line option to the dotnet publish command  Following command would include the environment variable as Development in the web config file   dotnet publish -c Debug -r win-x64  p EnvironmentName Development

User · Answer

This variable can be saved in json  For example envsettings json with content as below             Possible string values reported below  When empty it use ENV variable value or          Visual Studio setting          - Production         - Staging         - Test         - Development      ASPNETCORE ENVIRONMENT    Development        Later modify your program cs as below     public class Program         public static IConfiguration Configuration   get  set        public static void Main string   args                var currentDirectoryPath   Directory GetCurrentDirectory            var envSettingsPath   Path Combine currentDirectoryPath   envsettings json            var envSettings   JObject Parse File ReadAllText envSettingsPath            var environmentValue   envSettings  ASPNETCORE ENVIRONMENT   ToString             var builder   new ConfigurationBuilder                   SetBasePath Directory GetCurrentDirectory                    AddJsonFile  appsettings json             Configuration   builder Build              var webHostBuilder   new WebHostBuilder                UseKestrel                CaptureStartupErrors true               UseContentRoot currentDirectoryPath               UseIISIntegration                UseStartup lt Startup gt                 If none is set it use Operative System hosting enviroment         if   string IsNullOrWhiteSpace environmentValue                         webHostBuilder UseEnvironment environmentValue                      var host   webHostBuilder Build             host Run                This way it will always be included in publish and you can change to required value according to environment where website is hosted  This method can also be used in console app as the changes are in Program cs

User · Answer

You should follow the instructions provided in the documentation  using the web config    lt aspNetCore processPath  dotnet          arguments    MyApp dll          stdoutLogEnabled  false          stdoutLogFile       home  LogFiles aspnetcore-stdout  gt     lt environmentVariables gt       lt environmentVariable name  ASPNETCORE ENVIRONMENT  value  Production    gt       lt environmentVariable name  CONFIG DIR  value  f  application config    gt     lt  environmentVariables gt   lt  aspNetCore gt    Note that you can also set other environment variables as well      The ASP NET Core Module allows you specify environment variables for   the process specified in the processPath attribute by specifying them   in one or more environmentVariable child elements of an   environmentVariables collection element under the aspNetCore element    Environment variables set in this section take precedence over system   environment variables for the process

[c#] how to set ASPNETCORE_ENVIRONMENT to be considered for publishing an asp.net core application?

Examples related to c#

Examples related to asp.net-core

Examples related to environment-variables