Plinth.WindowsService 1.5.4

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0
dotnet add package Plinth.WindowsService --version 1.5.4
NuGet\Install-Package Plinth.WindowsService -Version 1.5.4
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.5.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Plinth.WindowsService --version 1.5.4
#r "nuget: Plinth.WindowsService, 1.5.4"
#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.5.4

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

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 --console --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 --console --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-windows was computed.  net6.0-windows7.0 is compatible.  net7.0-windows was computed.  net7.0-windows7.0 is compatible. 
Compatible target framework(s)
Additional computed target framework(s)
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.5.4 151 3/7/2023
1.5.3 150 3/3/2023
1.5.2 197 1/11/2023
1.5.2-b92.7c961f5f 65 1/11/2023
1.5.0 256 11/9/2022
1.5.0-b88.7a7c20cd 65 11/9/2022
1.4.7 327 10/20/2022
1.4.6 314 10/17/2022
1.4.5 344 10/1/2022
1.4.4 323 8/16/2022
1.4.3 328 8/2/2022
1.4.2 358 7/19/2022
1.4.2-b80.7fdbfd04 95 7/19/2022
1.4.2-b74.acaf86f5 85 6/15/2022
1.4.1 358 6/13/2022
1.4.0 360 6/6/2022
1.3.8 388 4/12/2022
1.3.7 349 3/21/2022
1.3.6 372 3/17/2022
1.3.6-b67.ca5053f3 86 3/16/2022
1.3.6-b66.4a9683e6 85 3/16/2022
1.3.5 372 2/23/2022
1.3.4 393 1/20/2022
1.3.3 268 12/29/2021
1.3.2 390 12/11/2021
1.3.1 244 11/12/2021
1.3.0 253 11/8/2021
1.2.3 285 9/22/2021
1.2.2 284 8/20/2021
1.2.1 264 8/5/2021
1.2.0 297 8/1/2021
1.2.0-b37.a54030b9 129 6/24/2021
1.1.6 350 3/22/2021
1.1.5 270 3/9/2021
1.1.4 278 2/27/2021
1.1.3 293 2/17/2021
1.1.2 297 2/12/2021
1.1.1 293 2/1/2021
1.1.0 400 12/16/2020
1.1.0-b27.b66c309b 245 11/15/2020
1.0.12 430 10/18/2020
1.0.11 368 10/6/2020
1.0.10 328 9/30/2020
1.0.9 343 9/29/2020
1.0.8 543 9/26/2020
1.0.7 485 9/19/2020
1.0.6 402 9/3/2020
1.0.5 419 9/2/2020
1.0.4 369 9/1/2020
1.0.3 436 9/1/2020
1.0.2 426 8/29/2020
1.0.1 426 8/29/2020
1.0.0 438 8/29/2020
1.0.0-b1.c22f563d 216 8/28/2020

net7.0 support and removed netcoreapp3.1