Woof.ServiceInstaller 5.2.1

Woof.ServiceInstaller

.NET extension created by CodeDog

Distributed under MIT License. (c)2021 by CodeDog, All rights reserved.

About

Installs and runs systems services. Works both on Windows and Linux. On Linux uses systemd.

For help use dotnet {command} --help. To install: sudo dotnet {command} --install To uninstall: sudo dotnet {command} --uninstall To delete Windows Event Log: {command} --delete-log (administrator required)

This package uses Woof.CommandLine package to handle the command line arguments with POSIX syntax guidelines.

Usage

Given:

• ClientService is your service class implementing IHostedService,
• Config.Data contains your service metadata class instance implementing IConfiguration

Here's example Main mehtod:

private async static Task<int> Main(string[] args) {
    var commandLine = CommandLine.Default; // default CommandLine instance
    ServiceInstaller.Configure<ClientService>(Config.Data); // required
    if (ServiceInstaller.ServiceMetadata is null) throw new NullReferenceException();
    if (args?.Length > 0) { // run only when arguments present (not as service)
        commandLine.Map<Options>(); // optional additional options
        commandLine.Delegates.Add(Options.Help, Help); // optional additional delegates
        commandLine.Parse(args); // required
        var errors = CommandLine.ValidationErrors;
        if (errors is not null) Error(errors); // optionally show errors if any
        else await commandLine.RunDelegatesAsync(); // required
    }
    else
        await ServiceController
            .RunHostAsync<ClientService>(ServiceInstaller.ServiceMetadata!);
            // required
    return 0;
}

To execute code before or after installation / uninstallation simply check if the install/uninstall options are present before and/or after RunDelegatesAsync like this:

if (commandLine.HasOption(ServiceInstaller.Options.Install)) {
    // code to execute
}

The installed service is started with

ServiceController.RunHostAsync<ClientService>(ServiceInstaller.ServiceMetadata!);

If executing of some external commands is needed before or after the installation, ServiceController.ExecAsync method can be used for that. If the command executed that way fails, the method will throw an InvalidOperationException with the error message obtained from the command output.

For more information see the included example project.

Compatibility

The package is compatible with .NET Standard 2.1 and .NET 5.0 or newer. The applications using the module can run both on Windows and Linux.

Disclaimer

Please report any issues to the toolkit developer.

Woof Toolkit is a work in progress in constant development, however it's carefully maintained with production code quality.