-host> * <xref:test/troubleshoot>  ::: moniker-end  ::: moniker range="= aspnetcore-0.0"  An ASP.NET Core app can be hosted on Windows as a [Windows Service](/dotnet/framework/windows-services/introduction-to-windows-service-applications) without using IIS. When hosted as a Windows Service, the app automatically starts after server reboots.  [View or download sample code](https://github.com/dotnet/AspNetCore.Docs/tree/master/aspnetcore/host-and-deploy/windows-service/samples) ([how to download](xref:index#how-to-download-a-sample))  ## Prerequisites  * [ASP.NET Core SDK 0.0 or later](https://dotnet.microsoft.com/download) * [PowerShell 0.0 or later](https://github.com/PowerShell/PowerShell)  ## App configuration  The app requires package references for [Microsoft.AspNetCore.Hosting.WindowsServices](https://www.nuget.org/packages/Microsoft.AspNetCore.Hosting.WindowsServices) and [Microsoft.Extensions.Logging.EventLog](https://www.nuget.org/packages/Microsoft.Extensions.Logging.EventLog).  To test and debug when running outside of a service, add code to determine if the app is running as a service or a console app. Inspect if the debugger is attached or a `--console` switch is present. If either condition is true (the app isn't run as a service), call <xref:Microsoft.AspNetCore.Hosting.WebHostExtensions.Run*>. If the conditions are false (the app is run as a service):  * Call <xref:System.IO.Directory.SetCurrentDirectory*> and use a path to the app's published location. Don't call <xref:System.IO.Directory.GetCurrentDirectory*> to obtain the path because a Windows Service app returns the *C:\\WINDOWS\\system00* folder when <xref:System.IO.Directory.GetCurrentDirectory*> is called. For more information, see the [Current directory and content root](#current-directory-and-content-root) section. This step is performed before the app is configured in `CreateWebHostBuilder`. * Call <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostWindowsServiceExtensions.RunAsService*> to run the app as a service.  Because the [Command-line Configuration Provider](xref:fundamentals/configuration/index#command-line-configuration-provider) requires name-value pairs for command-line arguments, the `--console` switch is removed from the arguments before <xref:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder*> receives the arguments.  To write to the Windows Event Log, add the EventLog provider to <xref:Microsoft.AspNetCore.Hosting.WebHostBuilder.ConfigureLogging*>. Set the logging level with the `Logging:LogLevel:Default` key in the *appsettings.Production.json* file.  In the following example from the sample app, `RunAsCustomService` is called instead of <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostWindowsServiceExtensions.RunAsService*> in order to handle lifetime events within the app. For more information, see the [Handle starting and stopping events](#handle-starting-and-stopping-events) section.  [!code-csharp[](windows-service/samples/0.x/AspNetCoreService/Program.cs?name=snippet_Program)]  ## Deployment type  For information and advice on deployment scenarios, see [.NET Core application deployment](/dotnet/core/deploying/).  ### SDK  For a web app-based service that uses the Razor Pages or MVC frameworks, specify the Web SDK in the project file:  ```xml <Project Sdk="Microsoft.NET.Sdk.Web"> ```  If the service only executes background tasks (for example, [hosted services](xref:fundamentals/host/hosted-services)), specify the Worker SDK in the project file:  ```xml <Project Sdk="Microsoft.NET.Sdk.Worker"> ```  ### Framework-dependent deployment (FDD)  Framework-dependent deployment (FDD) relies on the presence of a shared system-wide version of .NET Core on the target system. When the FDD scenario is adopted following the guidance in this article, the SDK produces an executable (*.exe*), called a *framework-dependent executable*.  The Windows [Runtime Identifier (RID)](/dotnet/core/rid-catalog) ([\<RuntimeIdentifier>](/dotnet/core/tools/csproj#runtimeidentifier)) contains the target framework. In the following example, the RID is set to `win0-x00`. The `<SelfContained>` property is set to `false`. These properties instruct the SDK to generate an executable (*.exe*) file for Windows and an app that depends on the shared .NET Core framework.  A *web.config* file, which is normally produced when publishing an ASP.NET Core app, is unnecessary for a Windows Services app. To disable the creation of the *web.config* file, add the `<IsTransformWebConfigDisabled>` property set to `true`.  ```xml <PropertyGroup>   <TargetFramework>netcoreapp0.0</TargetFramework>   <RuntimeIdentifier>win0-x00</RuntimeIdentifier>   <SelfContained>false</SelfContained>   <IsTransformWebConfigDisabled>true</IsTransformWebConfigDisabled> </PropertyGroup> ```  ### Self-contained deployment (SCD)  Self-contained deployment (SCD) doesn't rely on the presence of a shared framework on the host system. The runtime and the app's dependencies are deployed with the app.  A Windows [Runtime Identifier (RID)](/dotnet/core/rid-catalog) is included in the `<PropertyGroup>` that contains the target framework:  ```xml <RuntimeIdentifier>win0-x00</RuntimeIdentifier> ```  To publish for multiple RIDs:  * Provide the RIDs in a semicolon-delimited list. * Use the property name [\<RuntimeIdentifiers>](/dotnet/core/tools/csproj#runtimeidentifiers) (plural).  For more information, see [.NET Core RID Catalog](/dotnet/core/rid-catalog).  A `<SelfContained>` property is set to `true`:  ```xml <SelfContained>true</SelfContained> ```  ## Service user account  To create a user account for a service, use the [New-LocalUser](/powershell/module/microsoft.powershell.localaccounts/new-localuser) cmdlet from an administrative PowerShell 0 command shell.  On Windows 00 October 0000 Update (version 0000/build 00.0.00000) or later:  ```powershell New-LocalUser -Name {SERVICE NAME} ```  On Windows OS earlier than the Windows 00 October 0000 Update (version 0000/build 00.0.00000):  ```console powershell -Command "New-LocalUser -Name {SERVICE NAME}" ```  Provide a [strong password](/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements) when prompted.  Unless the `-AccountExpires` parameter is supplied to the [New-LocalUser](/powershell/module/microsoft.powershell.localaccounts/new-localuser) cmdlet with an expiration <xref:System.DateTime>, the account doesn't expire.  For more information, see [Microsoft.PowerShell.LocalAccounts](/powershell/module/microsoft.powershell.localaccounts/) and [Service User Accounts](/windows/desktop/services/service-user-accounts).  An alternative approach to managing users when using Active Directory is to use Managed Service Accounts. For more information, see [Group Managed Service Accounts Overview](/windows-server/security/group-managed-service-accounts/group-managed-service-accounts-overview).  ## Log on as a service rights  To establish *Log on as a service* rights for a service user account:  0. Open the Local Security Policy editor by running *secpol.msc*. 0. Expand the **Local Policies** node and select **User Rights Assignment**. 0. Open the **Log on as a service** policy. 0. Select **Add User or Group**. 0. Provide the object name (user account) using either of the following approaches:    0. Type the user account (`{DOMAIN OR COMPUTER NAME\USER}`) in the object name field and select **OK** to add the user to the policy.    0. Select **Advanced**. Select **Find Now**. Select the user account from the list. Select **OK**. Select **OK** again to add the user to the policy. 0. Select **OK** or **Apply** to accept the changes.  ## Create and manage the Windows Service  ### Create a service  Use PowerShell commands to register a service. From an administrative PowerShell 0 command shell, execute the following commands:  ```powershell $acl = Get-Acl "{EXE PATH}" $aclRuleArgs = {DOMAIN OR COMPUTER NAME\USER}, "Read,Write,ReadAndExecute", "ContainerInherit,ObjectInherit", "None", "Allow" $accessRule = New-Object System.Security.AccessControl.FileSystemAccessRule($aclRuleArgs) $acl.SetAccessRule($accessRule) $acl | Set-Acl "{EXE PATH}"  New-Service -Name {SERVICE NAME} -BinaryPathName {EXE FILE PATH} -Credential {DOMAIN OR COMPUTER NAME\USER} -Description "{DESCRIPTION}" -DisplayName "{DISPLAY NAME}" -StartupType Automatic ```  * `{EXE PATH}`: Path to the app's folder on the host (for example, `d:\myservice`). Don't include the app's executable in the path. A trailing slash isn't required. * `{DOMAIN OR COMPUTER NAME\USER}`: Service user account (for example, `Contoso\ServiceUser`). * `{SERVICE NAME}`: Service name (for example, `MyService`). * `{EXE FILE PATH}`: The app's executable path (for example, `d:\myservice\myservice.exe`). Include the executable's file name with extension. * `{DESCRIPTION}`: Service description (for example, `My sample service`). * `{DISPLAY NAME}`: Service display name (for example, `My Service`).  ### Start a service  Start a service with the following PowerShell 0 command:  ```powershell Start-Service -Name {SERVICE NAME} ```  The command takes a few seconds to start the service.  ### Determine a service's status  To check the status of a service, use the following PowerShell 0 command:  ```powershell Get-Service -Name {SERVICE NAME} ```  The status is reported as one of the following values:  * `Starting` * `Running` * `Stopping` * `Stopped`  ### Stop a service  Stop a service with the following Powershell 0 command:  ```powershell Stop-Service -Name {SERVICE NAME} ```  ### Remove a service  After a short delay to stop a service, remove a service with the following Powershell 0 command:  ```powershell Remove-Service -Name {SERVICE NAME} ```  ## Handle starting and stopping events  To handle <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostService.OnStarting*>, <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostService.OnStarted*>, and <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostService.OnStopping*> events:  0. Create a class that derives from <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostService> with the `OnStarting`, `OnStarted`, and `OnStopping` methods:     [!code-csharp[](windows-service/samples/0.x/AspNetCoreService/CustomWebHostService.cs?name=snippet_CustomWebHostService)]  0. Create an extension method for <xref:Microsoft.AspNetCore.Hosting.IWebHost> that passes the `CustomWebHostService` to <xref:System.ServiceProcess.ServiceBase.Run*>:     [!code-csharp[](windows-service/samples/0.x/AspNetCoreService/WebHostServiceExtensions.cs?name=ExtensionsClass)]  0. In `Program.Main`, call the `RunAsCustomService` extension method instead of <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostWindowsServiceExtensions.RunAsService*>:     ```csharp    host.RunAsCustomService();    ```     To see the location of <xref:Microsoft.AspNetCore.Hosting.WindowsServices.WebHostWindowsServiceExtensions.RunAsService*> in `Program.Main`, refer to the code sample shown in the [Deployment type](#deployment-type) section.  ## Proxy server and load balancer scenarios  Services that interact with requests from the Internet or a corporate network and are behind a proxy or load balancer might require additional configuration. For more information, see <xref:host-and-deploy/proxy-load-balancer>.  ## Configure endpoints  By default, ASP.NET Core binds to `http://localhost:0000`. Configure the URL and port by setting the `ASPNETCORE_URLS` environment variable.  For additional URL and port configuration approaches, see the relevant server article:  * <xref:fundamentals/servers/kestrel#endpoint-configuration> * <xref:fundamentals/servers/httpsys#configure-windows-server>  The preceding guidance covers support for HTTPS endpoints. For example, configure the app for HTTPS when authentication is used with a Windows Service.  > [!NOTE] > Use of the ASP.NET Core HTTPS development certificate to secure a service endpoint isn't supported.  ## Current directory and content root  The current working directory returned by calling <xref:System.IO.Directory.GetCurrentDirectory*> for a Windows Service is the *C:\\WINDOWS\\system00* folder. The *system00* folder isn't a suitable location to store a service's files (for example, settings files). Use one of the following approaches to maintain and access a service's assets and settings files.  ### Set the content root path to the app's folder  The <xref:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath*> is the same path provided to the `binPath` argument when a service is created. Instead of calling `GetCurrentDirectory` to create paths to settings files, call <xref:System.IO.Directory.SetCurrentDirectory*> with the path to the app's [content root](xref:fundamentals/index#content-root).  In `Program.Main`, determine the path to the folder of the service's executable and use the path to establish the app's content root:  ```csharp var pathToExe = Process.GetCurrentProcess().MainModule.FileName; var pathToContentRoot = Path.GetDirectoryName(pathToExe); Directory.SetCurrentDirectory(pathToContentRoot);  CreateWebHostBuilder(args)     .Build()     .RunAsService(); ```  ### Store a service's files in a suitable location on disk  Specify an absolute path with <xref:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath*> when using an <xref:Microsoft.Extensions.Configuration.IConfigurationBuilder> to the folder containing the files.  ## Troubleshoot  To troubleshoot a Windows Service app, see <xref:test/troubleshoot>.  ### Common errors  * An old or pre-release version of PowerShell is in use. * The registered service doesn't use the app's **published** output from the [dotnet publish](/dotnet/core/tools/dotnet-publish) command. Output of the [dotnet build](/dotnet/core/tools/dotnet-build) command isn't supported for app deployment. Published assets are found in either of the following folders depending on the deployment type:   * *bin/Release/{TARGET FRAMEWORK}/publish* (FDD)   * *bin/Release/{TARGET FRAMEWORK}/{RUNTIME IDENTIFIER}/publish* (SCD) * The service isn't in the RUNNING state. * The paths to resources that the app uses (for example, certificates) are incorrect. The base path of a Windows Service is *c:\\Windows\\System00*. * The user doesn't have *Log on as a service* rights. * The user's password is expired or incorrectly passed when executing the `New-Service` PowerShell command. * The app requires ASP.NET Core authentication but isn't configured for secure connections (HTTPS). * The request URL port is incorrect or not configured correctly in the app.  ### System and Application Event Logs  Access the System and Application Event Logs:  0. Open the Start menu, search for *Event Viewer*, and select the **Event Viewer** app. 0. In **Event Viewer**, open the **Windows Logs** node. 0. Select **System** to open the System Event Log. Select **Application** to open the Application Event Log. 0. Search for errors associated with the failing app.  ### Run the app at a command prompt  Many startup errors don't produce useful information in the event logs. You can find the cause of some errors by running the app at a command prompt on the hosting system. To log additional detail from the app, lower the [log level](xref:fundamentals/logging/index#log-level) or run the app in the [Development environment](xref:fundamentals/environments).  ### Clear package caches  A functioning app may fail immediately after upgrading either the .NET Core SDK on the development machine or changing package versions within the app. In some cases, incoherent packages may break an app when performing major upgrades. Most of these issues can be fixed by following these instructions:  0. Delete the *bin* and *obj* folders. 0. Clear the package caches by executing [dotnet nuget locals all --clear](/dotnet/core/tools/dotnet-nuget-locals) from a command shell.     Clearing package caches can also be accomplished with the [nuget.exe](https://www.nuget.org/downloads) tool and executing the command `nuget locals all -clear`. *nuget.exe* isn't a bundled install with the Windows desktop operating system and must be obtained separately from the [NuGet website](https://www.nuget.org/downloads).  0. Restore and rebuild the project. 0. Delete all of the files in the deployment folder on the server prior to redeploying the app.  ### Slow or hanging app  A *crash dump* is a snapshot of the system's memory and can help determine the cause of an app crash, startup failure, or slow app.  #### App crashes or encounters an exception  Obtain and analyze a dump from [Windows Error Reporting (WER)](/windows/desktop/wer/windows-error-reporting):  0. Create a folder to hold crash dump files at `c:\dumps`. 0. Run the [EnableDumps PowerShell script](https://github.com/dotnet/AspNetCore.Docs/blob/master/aspnetcore/host-and-deploy/windows-service/scripts/EnableDumps.ps0) with the application executable name:     ```console    .\EnableDumps {APPLICATION EXE} c:\dumps    ```  0. Run the app under the conditions that cause the crash to occur. 0. After the crash has occurred, run the [DisableDumps PowerShell script](https://github.com/dotnet/AspNetCore.Docs/blob/master/aspnetcore/host-and-deploy/windows-service/scripts/DisableDumps.ps0):     ```console    .\DisableDumps {APPLICATION EXE}    ```  After an app crashes and dump collection is complete, the app is allowed to terminate normally. The PowerShell script configures WER to collect up to five dumps per app.  > [!WARNING] > Crash dumps might take up a large amount of disk space (up to several gigabytes each).  #### App hangs, fails during startup, or runs normally  When an app *hangs* (stops responding but doesn't crash), fails during startup, or runs normally, see [User-Mode Dump Files: Choosing the Best Tool](/windows-hardware/drivers/debugger/user-mode-dump-files#choosing-the-best-tool) to select an appropriate tool to produce the dump.  #### Analyze the dump  A dump can be analyzed using several approaches. For more information, see [Analyzing a User-Mode Dump File](/windows-hardware/drivers/debugger/analyzing-a-user-mode-dump-file).  ## Additional resources  * [Kestrel endpoint configuration](xref:fundamentals/servers/kestrel#endpoint-configuration) (includes HTTPS configuration and SNI support) * <xref:fundamentals/host/web-host> * <xref:test/troubleshoot>  ::: moniker-end  ::: moniker range="