How to get the Development Staging production Hosting Environment in ConfigureServices

Question

How do I get the Development Staging production Hosting Environment in the ConfigureServices method in Startup   public void ConfigureServices IServiceCollection services           Which environment are we running under      The ConfigureServices method only takes a single IServiceCollection parameter

User · Answer

Starting from ASP NET Core 3 0  it is much simpler to access the environment variable  from both ConfigureServices and Configure  Simply inject IWebHostEnvironment into the Startup constructor itself  Like so    public class Startup       public Startup IConfiguration configuration  IWebHostEnvironment env                Configuration   configuration           env   env             public IConfiguration Configuration   get        private readonly IWebHostEnvironment  env       public void ConfigureServices IServiceCollection services                if   env IsDevelopment                            development                      public void Configure IApplicationBuilder app                if   env IsDevelopment                            development                    Reference  https   docs microsoft com en-us aspnet core fundamentals environments view aspnetcore-3 0 inject-iwebhostenvironment-into-the-startup-class

User · Answer

In  NET Core 2 0 MVC app   Microsoft AspNetCore All v2 0 0  you can have environmental specific startup class as described by  vaindil but I don t like that approach   You can also inject IHostingEnvironment into StartUp constructor  You don t need to store the environment variable in Program class   public class Startup       private readonly IHostingEnvironment  currentEnvironment      public IConfiguration Configuration   get  private set         public Startup IConfiguration configuration  IHostingEnvironment env                 currentEnvironment   env          Configuration   configuration             public void ConfigureServices IServiceCollection services                                services AddMvc config   gt                           Requiring authenticated users on the site globally             var policy   new AuthorizationPolicyBuilder                    RequireAuthenticatedUser                    Build                config Filters Add new AuthorizeFilter policy                    Validate anti-forgery token globally             config Filters Add new AutoValidateAntiforgeryTokenAttribute                     If it s Production  enable HTTPS             if   currentEnvironment IsProduction             lt ------                               config Filters Add new RequireHttpsAttribute

User · Answer

You can easily access it in ConfigureServices  just persist it to a property during Startup method which is called first and gets it passed in  then you can access the property from ConfigureServices   public Startup IHostingEnvironment env  IApplicationEnvironment appEnv           your code here        CurrentEnvironment   env     private IHostingEnvironment CurrentEnvironment  get  set      public void ConfigureServices IServiceCollection services        string envName   CurrentEnvironment EnvironmentName          your code here

User · Answer

If you need to test this somewhere in your codebase that doesn t have easy access to the IHostingEnvironment  another easy way to do it is like this   bool isDevelopment   Environment GetEnvironmentVariable  ASPNETCORE ENVIRONMENT       Development

User · Answer

per the docs     Configure and ConfigureServices support environment specific versions   of the form Configure EnvironmentName  and Configure EnvironmentName Services    You can do something like this     public void ConfigureProductionServices IServiceCollection services        ConfigureCommonServices services          Services only for production     services Configure       public void ConfigureDevelopmentServices IServiceCollection services        ConfigureCommonServices services          Services only for development     services Configure       public void ConfigureStagingServices IServiceCollection services        ConfigureCommonServices services          Services only for staging     services Configure       private void ConfigureCommonServices IServiceCollection services          Services common to each environment

User · Answer

Just in case someone is looking to this too  In  net core 3  most of this is obsolete  The update way is   public void Configure      IApplicationBuilder app      IWebHostEnvironment env      ILogger lt Startup gt  logger        if  env EnvironmentName    Environments Development                   logger LogInformation  In Development environment

User · Answer

I wanted to get the environment in one of my services   It is really easy to do   I just inject it to the constructor like this       private readonly IHostingEnvironment  hostingEnvironment       public MyEmailService IHostingEnvironment hostingEnvironment                 hostingEnvironment   hostingEnvironment          Now later on in the code I can do this   if   hostingEnvironment IsProduction             really send the email    else          send the email to the test queue      EDIT   Code above is for  NET Core 2   For version 3 you will want to use IWebHostEnvironment

User · Answer

This can be accomplished without any extra properties or method parameters  like so   public void ConfigureServices IServiceCollection services        IServiceProvider serviceProvider   services BuildServiceProvider        IHostingEnvironment env   serviceProvider GetService lt IHostingEnvironment gt          if  env IsProduction    DoSomethingDifferentHere

User · Answer

TL DR  Set an environment variable called ASPNETCORE ENVIRONMENT with the name of the environment  e g  Production   Then do one of two things    Inject IHostingEnvironment into Startup cs  then use that  env here  to check  env IsEnvironment  Production    Do not check using env EnvironmentName     Production   Use either separate Startup classes or individual Configure ConfigureServices functions  If a class or the functions match these formats  they will be used instead of the standard options on that environment    Startup EnvironmentName     entire class     example  StartupProduction   Configure EnvironmentName       example  ConfigureProduction   Configure EnvironmentName Services      example  ConfigureProductionServices        Full explanation  The  NET Core docs describe how to accomplish this  Use an environment variable called ASPNETCORE ENVIRONMENT that s set to the environment you want  then you have two choices   Check environment name  From the docs      The IHostingEnvironment service provides the core abstraction for working with environments  This service is provided by the ASP NET hosting layer  and can be injected into your startup logic via Dependency Injection  The ASP NET Core web site template in Visual Studio uses this approach to load environment-specific configuration files  if present  and to customize the app   s error handling settings  In both cases  this behavior is achieved by referring to the currently specified environment by calling EnvironmentName or IsEnvironment on the instance of IHostingEnvironment passed into the appropriate method    NOTE  Checking the actual value of env EnvironmentName is not recommended      If you need to check whether the application is running in a particular environment  use env IsEnvironment  environmentname   since it will correctly ignore case  instead of checking if env EnvironmentName     Development  for example     Use separate classes  From the docs      When an ASP NET Core application starts  the Startup class is used to bootstrap the application  load its configuration settings  etc   learn more about ASP NET startup   However  if a class exists named Startup EnvironmentName   for example StartupDevelopment   and the ASPNETCORE ENVIRONMENT environment variable matches that name  then that Startup class is used instead  Thus  you could configure Startup for development  but have a separate StartupProduction that would be used when the app is run in production  Or vice versa       In addition to using an entirely separate Startup class based on the current environment  you can also make adjustments to how the application is configured within a Startup class  The Configure   and ConfigureServices   methods support environment-specific versions similar to the Startup class itself  of the form Configure EnvironmentName    and Configure EnvironmentName Services    If you define a method ConfigureDevelopment   it will be called instead of Configure   when the environment is set to development  Likewise  ConfigureDevelopmentServices   would be called instead of ConfigureServices   in the same environment

User · Answer

The hosting environment comes from the ASPNET ENV environment variable  which is available during Startup using the IHostingEnvironment IsEnvironment extension method  or one of the corresponding convenience methods of IsDevelopment or IsProduction  Either save what you need in Startup    or in ConfigureServices call   var foo   Environment GetEnvironmentVariable  ASPNET ENV

User · Answer

In Dotnet Core 2 0 the Startup-constructor only expects a IConfiguration-parameter       public Startup IConfiguration configuration                Configuration   configuration          How to read hosting environment there  I store it in Program-class during ConfigureAppConfiguration  use full BuildWebHost instead of WebHost CreateDefaultBuilder    public class Program       public static IHostingEnvironment HostingEnvironment   get  set         public static void Main string   args                   Build web host         var host   BuildWebHost args            host Run               public static IWebHost BuildWebHost string   args                return new WebHostBuilder                UseConfiguration new ConfigurationBuilder                    SetBasePath Directory GetCurrentDirectory                     AddJsonFile  hosting json   optional  true                   Build                              UseKestrel                UseContentRoot Directory GetCurrentDirectory                 ConfigureAppConfiguration  hostingContext  config    gt                                var env   hostingContext HostingEnvironment                      Assigning the environment for use in ConfigureServices                 HostingEnvironment   env      lt ---                  config                    AddJsonFile  appsettings json   optional  true  reloadOnChange  true                     AddJsonFile   appsettings  env EnvironmentName  json   optional  true  reloadOnChange  true                    if  env IsDevelopment                                          var appAssembly   Assembly Load new AssemblyName env ApplicationName                        if  appAssembly    null                                                config AddUserSecrets appAssembly  optional  true                                                            config AddEnvironmentVariables                     if  args    null                                        config AddCommandLine args                                                 ConfigureLogging  hostingContext  builder    gt                                builder AddConfiguration hostingContext Configuration GetSection  Logging                     builder AddConsole                    builder AddDebug                                UseIISIntegration                UseDefaultServiceProvider  context  options    gt                                options ValidateScopes   context HostingEnvironment IsDevelopment                                UseStartup lt Startup gt                 Build            Ant then reads it in ConfigureServices like this   public IServiceProvider ConfigureServices IServiceCollection services        var isDevelopment   Program HostingEnvironment IsDevelopment

User · Answer

Since there is no full copy  amp  paste solution yet  based on Joe Audette s answer  public IWebHostEnvironment Environment   get     public Startup IWebHostEnvironment environment  IConfiguration configuration       Environment   environment            public void ConfigureServices IServiceCollection services       if  Environment IsDevelopment                   Do something     else            Do something

[c#] How to get the Development/Staging/production Hosting Environment in ConfigureServices

Examples related to c#

Examples related to asp.net-core

Examples related to asp.net-core-mvc