Go to file

Oleg Nenashev 51833adc7a Update README.md		2020-04-10 23:32:53 +02:00
.github	Update tag format	2020-04-06 22:27:33 +08:00
doc	Merge pull request #474 from NextTurn/accounts	2020-04-06 10:08:28 +02:00
eng	Disable PR trigger in release builds	2020-04-09 17:02:02 +08:00
examples	Support security descriptor string	2020-03-28 14:50:19 +08:00
src	Enable strong cryptography when running on .NET Framework 4.6	2020-04-09 18:07:22 +08:00
.gitignore	Update .gitignore	2020-04-06 14:01:59 +08:00
CHANGELOG.md	Update documentation headers	2020-04-01 21:52:12 +08:00
CONTRIBUTING.md	Initialize contributing guidelines	2020-03-29 11:57:04 +08:00
Directory.Build.props	Produce ready-to-publish artifacts in build phase for AppVeyor	2020-01-27 17:24:49 +08:00
Directory.Build.targets	Disable MMI	2020-02-18 11:37:31 +08:00
LICENSE.txt	Update license for GitHub	2020-03-17 08:24:05 +08:00
MANIFEST.md	Clean up documentation	2020-04-01 13:02:47 +08:00
README.md	Update README.md	2020-04-10 23:32:53 +02:00
WinSW.nuspec	Merge pull request #452 from winsw/nuget-dotnet-461	2020-03-25 11:09:05 +01:00
appveyor.yml	Merge pull request #384 from NextTurn/config	2020-02-05 12:47:27 -05:00
generate-key.ps1	Update DEVELOPER.md	2020-01-15 17:32:04 +08:00

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.

Supported platforms

WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1. It can run on Windows platforms which have these versions of .NET framework installed. For systems without .NET Framework, the project provides native 64bit and 32bit executables which are based on .NET Core 3.1.

More executables can be added upon request.

Download

WinSW binaries are available on GitHub Releases and NuGet.

Alternative sources:

Maven packaging for executables, hosted by the Jenkins project. Binaries are available here.
Puppet, currently outdated (WinSW 1.x). Binaries are available on Puppet Forge

Usage

WinSW is being managed by configuration files: Main XML configuration file and EXE configuration 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 indicates the service is not currently installed
  - Started to indicate the service is currently running
  - Stopped to indicate that the service is installed but not currently running.

Documentation

User documentation:

Installation guide - Describes the installation process for different systems and .NET versions
Configuration:
Use-cases:
- Self-restarting services
- Deferred file operations
Configuration Management:
- Puppet Forge Module

Developer documentation:

Developer guide

Contributing

Contributions are welcome! No Clontributor Licence Agreement is needed, just submit your pull requests. See the contributor guidelines for more information and guidelines.

License

WinSW is licensed under the MIT license.