Plinth.WindowsService 1.7.0

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Plinth.WindowsService --version 1.7.0                

                    
                

            
NuGet\Install-Package Plinth.WindowsService -Version 1.7.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Plinth.WindowsService" Version="1.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Plinth.WindowsService --version 1.7.0                

                    
                

            
#r "nuget: Plinth.WindowsService, 1.7.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Plinth.WindowsService as a Cake Addin
#addin nuget:?package=Plinth.WindowsService&version=1.7.0

// Install Plinth.WindowsService as a Cake Tool
#tool nuget:?package=Plinth.WindowsService&version=1.7.0

README

Plinth.WindowsService

Makes creating a windows service easy

1. Install as service

  • Include these in your csproj
     <OutputType>Exe</OutputType>
     <RuntimeIdentifier>win-x64</RuntimeIdentifier>

  • be sure to add the --urls {URLS} parameter to your binpath

    • to run multiple ports, use semi-colon ';' between urls
      • --urls http://localhost:5050;https://something/
    • note the usage of SetContentRoot() when using your own IWebHost/IHost
    • windows services don't start with the current directory where your .exe is

  • Install > sc create {ServiceName} displayName= "{DisplayName}" binpath= "D:\full\path\app.exe --urls http://localhost:9090" start= auto > sc description {ServiceName} "Service for Plinth WebApp"

  • Change path or params after installing > sc config {ServiceName} binPath= "{PathAndParams}"

  • Delete service > sc delete {ServiceName}

  • Start/Stop > net start {ServiceName} > net stop {ServiceName}

2. Standard ASP.NET Core project using NLog

  • Program.cs [below]
  • Add --urls http://localhost:5050 to your Debug settings as command line arguments
    • to run multiple ports, use semi-colon ';' between urls
      • --urls http://localhost:5050;https://something/
public class Program
{
	public static void Main(string[] args)
	{
		var log = StaticLogManagerSetup.BasicNLogSetup();
		log.Debug("startup!");

		WindowsServiceRunner.RunWebHost(
		    BuildWebHost,
		    args,
		    callbacks: new Dictionary<ServiceState, Action>()
		    {
		        [ServiceState.Starting] = () => log.Debug("Starting..."),
		        [ServiceState.Started] = () => log.Debug("Started"),
		        [ServiceState.Stopping] = () => log.Debug("Stopping..."),
		        [ServiceState.Stopped] = () => log.Debug("Stopped"),
		    });
	
		log.Debug("exit!");
	}

	public static IWebHost BuildWebHost(string[] args) =>
	    WebHost.CreateDefaultBuilder(args)
	        .UseStartup<Startup>()
	        .UseContentRoot(WindowsServiceRunner.FindContentRoot())   // <====  REALLY IMPORTANT!
	        .ConfigureLogging(builder => builder.AddNLog())
	        .CaptureStartupErrors(false)
	        .Build();
}

3. Console project (no web interface), without NLog

  • Program.cs [below]
  • Add --urls http://localhost:5050 to your Debug settings as command line arguments
    • to run multiple ports, use semi-colon ';' between urls
      • --urls http://localhost:5050;https://something/
	static void Main(string[] args)
	{
		var log = StaticLogManagerSetup.ConfigureForConsoleLogging();

		log.Debug("startup!");

		var mycallbacks = new Dictionary<ServiceState, Action>()
		{
		    [ServiceState.Starting] = () => log.Debug("Main: Starting..."),
		    [ServiceState.Started] = () => log.Debug("Main: Started"),
		    [ServiceState.Stopping] = () => log.Debug("Main: Stopping..."),
		    [ServiceState.Stopped] = () => log.Debug("Main: Stopped"),
		};

		try
		{
		    // option 1, make your own host and hosted service
		    // WindowsServiceRunner.RunHost(BuildHost, args, callbacks: mycallbacks);

		    // option 2, make your own hosted service
		    // WindowsServiceRunner.RunHostedService(new LoggerService(), args, callbacks: mycallbacks);

		    // option 3, a cancellable user action
		    // WindowsServiceRunner.RunAction(MyAction, args, callbacks: mycallbacks);

		    // option 4, a cancellable user action (async)
		    WindowsServiceRunner.RunAsyncAction(MyAsyncAction, args, callbacks: mycallbacks);
		}
		catch (Exception e)
		{
		    log.Fatal("failed during startup", e);
		    throw;
		}
	}

	// needed for option 1
	public static IHost BuildHost(string[] args) =>
		new HostBuilder()
		    .UseContentRoot(WindowsServiceRunner.FindContentRoot())   // <====  REALLY IMPORTANT!
		    .ConfigureServices((hostContext, services) =>
		    {
		        services.AddHostedService<LoggerService>();
		    })
		    .Build();

	// needed for option 1 and option 2
	public class LoggerService : IHostedService, IDisposable
	{
		private static readonly ILogger log = StaticLogManager.GetLogger();

		public Task StartAsync(CancellationToken cancellationToken)
		{
		    log.Debug("service start()");
		    return Task.CompletedTask;
		}

		public Task StopAsync(CancellationToken cancellationToken)
		{
		    return Task.CompletedTask;
		}

		public void Dispose()
		{
		    _timer?.Dispose();
		}
	}

	// option 3
	private static void MyAction(CancellationToken token)
	{
		while (!token.IsCancellationRequested)
		{
		    log.Debug("timer");
		    Task.Delay(TimeSpan.FromSeconds(2), token).Wait(); // try not to block on non cancellable calls
		}
	}

	// option 4
	private static async Task MyAsyncAction(CancellationToken token)
	{
		while (!token.IsCancellationRequested)
		{
		    log.Debug("timer");
		    await Task.Delay(TimeSpan.FromSeconds(2), token); // try not to block on non cancellable calls
		}
	}
Product Compatible and additional computed target framework versions.
.NET net6.0-windows7.0 is compatible.  net7.0-windows was computed.  net8.0-windows was computed.  net8.0-windows7.0 is compatible.  net9.0-windows7.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.7.0 59 11/12/2024
1.6.6 68 11/8/2024
1.6.5 95 8/31/2024
1.6.4 83 8/2/2024
1.6.3 118 5/15/2024
1.6.2 133 2/16/2024
1.6.1 181 1/5/2024
1.6.0 171 11/30/2023
1.5.10-b186.aca976b4 78 11/30/2023
1.5.9 126 11/29/2023
1.5.9-b174.64153841 77 11/23/2023
1.5.9-b172.dfc6e7bd 66 11/17/2023
1.5.9-b171.4e2b92e2 75 11/4/2023
1.5.8 139 10/23/2023
1.5.7 172 7/31/2023
1.5.6 159 7/13/2023
1.5.5 158 6/29/2023
1.5.4 255 3/7/2023
1.5.3 250 3/3/2023
1.5.2 319 1/11/2023
1.5.2-b92.7c961f5f 116 1/11/2023
1.5.0 350 11/9/2022
1.5.0-b88.7a7c20cd 102 11/9/2022
1.4.7 434 10/20/2022
1.4.6 436 10/17/2022
1.4.5 426 10/1/2022
1.4.4 404 8/16/2022
1.4.3 418 8/2/2022
1.4.2 435 7/19/2022
1.4.2-b80.7fdbfd04 132 7/19/2022
1.4.2-b74.acaf86f5 122 6/15/2022
1.4.1 429 6/13/2022
1.4.0 462 6/6/2022
1.3.8 476 4/12/2022
1.3.7 443 3/21/2022
1.3.6 466 3/17/2022
1.3.6-b67.ca5053f3 126 3/16/2022
1.3.6-b66.4a9683e6 126 3/16/2022
1.3.5 461 2/23/2022
1.3.4 482 1/20/2022
1.3.3 351 12/29/2021
1.3.2 473 12/11/2021
1.3.1 322 11/12/2021
1.3.0 349 11/8/2021
1.2.3 387 9/22/2021
1.2.2 388 8/20/2021
1.2.1 347 8/5/2021
1.2.0 389 8/1/2021
1.2.0-b37.a54030b9 166 6/24/2021
1.1.6 444 3/22/2021
1.1.5 380 3/9/2021
1.1.4 374 2/27/2021
1.1.3 404 2/17/2021
1.1.2 374 2/12/2021
1.1.1 382 2/1/2021
1.1.0 484 12/16/2020
1.1.0-b27.b66c309b 281 11/15/2020
1.0.12 532 10/18/2020
1.0.11 480 10/6/2020
1.0.10 401 9/30/2020
1.0.9 419 9/29/2020
1.0.8 627 9/26/2020
1.0.7 588 9/19/2020
1.0.6 487 9/3/2020
1.0.5 506 9/2/2020
1.0.4 463 9/1/2020
1.0.3 526 9/1/2020
1.0.2 508 8/29/2020
1.0.1 539 8/29/2020
1.0.0 519 8/29/2020
1.0.0-b1.c22f563d 245 8/28/2020

net9.0 support