Woof.Service 1.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Framework 4.7.1
Suggested Alternatives


Additional Details

This package was Windows only, new Woof.ServiceInstaller is compatible with both Windows and Linux. Also it's much easier to use and compatible with modern dependencies.

There is a newer version of this package available.
See the version list below for details.
dotnet add package Woof.Service --version 1.0.0
NuGet\Install-Package Woof.Service -Version 1.0.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="Woof.Service" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Woof.Service --version 1.0.0
#r "nuget: Woof.Service, 1.0.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 Woof.Service as a Cake Addin
#addin nuget:?package=Woof.Service&version=1.0.0

// Install Woof.Service as a Cake Tool
#tool nuget:?package=Woof.Service&version=1.0.0

Woof.Service quick usage guide

To create Windows Service with WCF REST API using Woof.Service

  • Start new .NET Framework Console Application.

  • Edit Application/Assembly Information, fill every fied, make sure Title and Product fields are not the same.

  • The Title field will be used as service display name, the Product as the service strong name, Company as Windows log name.

  • Get Woof.Service

    Install-Package Woof.Service -Version 1.0.2
  • Create new ServiceInstaller.cs file in main directory with following content:

    using Woof.ServiceEx;
    public sealed class ServiceInstaller : ServiceInstallerEx { }
    public sealed class ServiceProcessInstaller : ServiceProcessInstallerEx { }
  • Create Messages directory.

  • Create empty Service.resx file.

  • Create ServiceUri property (in Application scope) in Properties.Settings, set it to something like "http://localhost:8080/myService".

  • Create sample web service class WebService.cs:

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Threading.Tasks;
    using System.ServiceModel;
    using System.ServiceModel.Web;
    using Woof.ServiceEx.Wcf;
    using System.IO;
    namespace ServiceTest {
        class WebService {
            [OperationContract, WebGet(UriTemplate = "hello")]
            public string HelloWorld(string sessionName) {
                return "Hello world!";
  • Create main service class Service.cs extending ServiceBaseEx:

    using System;
    using System.IO;
    using System.Linq;
    using System.Threading;
    using System.Threading.Tasks;
    using Woof.ServiceEx;
    using Woof.ServiceEx.Wcf;
    namespace ServiceTest {
        class Service : ServiceBaseEx {
            public new static Service Instance => ServiceBaseEx.Instance as Service;
            private WebServiceHost<WebService> Host;
            public Service() : base(Messages.Service.ResourceManager) { }
            protected override void OnStart(string[] args) {
                Host = new WebServiceHost<WebService>(new Uri(Properties.Settings.Default.ServiceUri));
            protected override void OnStop() {
                Host = null;
  • Edit Program.cs file like this:

    using Woof.ServiceEx;
    namespace ServiceTest {
        class Program {
            static int Main(string[] args) => new ServiceConsole<Service>(args).ReturnValue;
  • Compile...

  • Restart Visual Studio in Administrator mode (required for service installation and WCF hosting).

  • Test with -t switch, install with -i switch, uninstall with -u switch. More help with -h switch.

  • Refer to Woof.ServiceEx.ServiceBaseEx.Signal() and Woof.ServiceEx.ServiceBaseEx.WriteEvent() XML documentation to write to the service log correctly.

  • Use Messages\Service.resx resource file to define standard localized event messages like:

    Name Value Comment
    I1001 My dummy info event message
    W2001 My dummy warning event message
    E3001 My dummy error event message
  • Use ResXManager extension to localize the messages.

  • The event names must consist of severity character being one of 'I', 'W', or 'E' and numeric event identifier.

  • The message values can contain {0}...{n} parameter placeholders in this exact format.

  • The pre-configured event messages are available via Signal() method.

  • For all other events use WriteEvent() method with 0 as event identifier.

  • RTFM (Read The Friendly Manual, meaning XML documentation) to explore advanced features like CORS support.

  • WARNING: Consider CurrentDirectory is set to C:\Windows\System32 when refering to any files.

  • To refer to a file in service exe directory use following:

    var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, fileName);
  • Note the service started as LocalSystem user cannot use GUI, however user interaction is possible using inter-process communication available in Woof.Core package, Woof.SystemEx namespace. WPF or WinForms application can interact with the service.


  • Is there a easier or simpler way of doing this?
  • Nope. Not for now but stay tuned, maybe a sample package / project template will be released soon.

  • How safe and stable are those libraries?
  • Tested for years on real production server environments.

  • .NET Core...?
  • Nope. Windows OS (desktop / server) is required.


Installing a Windows Service on a server is a serious thing. Be warned you can do some serious damage to the system using this code. Get a testing environment (like your local PC) to test the service properly before deploying to production. CodeDog Ltd. is not responsible for any damage caused using this library. You are.

Product Compatible and additional computed target framework versions.
.NET Framework net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
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
2.6.1 571 9/18/2019
2.6.0 498 9/6/2019
2.1.0 491 9/1/2019
2.0.0 511 7/27/2019
1.0.5 868 7/18/2018
1.0.4 837 7/18/2018
1.0.3 869 7/17/2018
1.0.2 886 7/17/2018
1.0.1 850 6/17/2018
1.0.0 857 6/16/2018

Initial release.