winsw/README.md

winsw: Windows service wrapper in less restrictive license

WinSW is an executable binary, which can be used to wrap and manage a custom process as a Windows service. Once you download the installation package, you can rename winsw.exe to any name, e.g. myService.exe.

Why?

See the project manifest.

Download

Right now the project uses Jenkins Maven repository as a main storage of release files. Binaries are available here.

Some releases (e.g. alpha- and beta-versions) can be also downloaded from the project's GitHub page. This source of releases is not an official one.

Usage

WinSW is being managed by configuration files: Main XML Configuration file and EXE Config file.

Your renamed winsw.exe binary also accepts the following commands:

• install to install the service to Windows Service Controller. This command requires some preliminary steps described in the Installation Guide.
• uninstall to uninstall the service. The opposite operation of above.
• start to start the service. The service must have already been installed.
• stop to stop the service.
• restart to restart the service. If the service is not currently running, this command acts like start.
• status to check the current status of the service. This command prints one line to the console. NonExistent to indicate the service is not currently installed, Started to indicate the service is currently running, and Stopped to indicate that the service is installed but not currently running.

Documentation

• Installation Guide - Describes the installation process for different systems and .NET versions
• Release notes
• Configuration:
• Main XML Configuration file
• EXE Configuration File
• Logging and Error Reporting
• Extensions
• Use-cases:
• Self-restarting services
• Deferred File Operations
• Configuration Management:
• Puppet Forge Module

Release lines

WinSW 2.x

This is a new release line under active development. API stability is not guaranteed till the first release, the project structure is in flux.

Major changes since 1.x:

• Rework of the project structure
• Better logging
• Internal extension engine, which allows extending the WinSW behavior

WinSW 1.x

This is an old baseline of WinSW. Currently it is in the maintenance-only state. New versions with fixes may be released on-demand.

Build Environment

• IDE: Visual Studio Community 2013 (free for open-source projects)
• winsw-key.snk should be available in the project's root in order to build the executable
• You can generate the certificate in "Project Settings/Signing"
• The certificate is in .gitignore list. Please do not add it to the repository