github
/
winsw
mirror of https://github.com/winsw/winsw
1
0
Fork 0
Code Issues Releases Wiki Activity
667 Commits
12 Branches
43 Tags
5 MiB
C# 99.6%
JavaScript 0.4%
 
 
Go to file
Next Turn 1b20d0db12
Revise docs for 3.0.0-alpha.1 (#587) 
* Add pre-release badge

* Update XML spec for `<username>`

* Update exit codes

* Update XML spec for `<prompt>`

* Create migration guide

* Add a note for the previous version

* docs -> documentation

* * Format usage

* Talk to myself

* * Add deployment status badge

* Update version strings

* Update README title

* Link to the migration guide

* * Remove .NET Core version number

* Delete exe-config-file.md

* Update README.md

* migration-guide.md -> migrate-to-3-x.md
 		2020-07-20 21:40:05 +08:00
.github Add a Dependabot configuration (#558) 2020-06-26 12:51:37 +02:00
docs Revise docs for 3.0.0-alpha.1 (#587) 2020-07-20 21:40:05 +08:00
eng Reorganize projects 2020-07-18 18:55:43 -07:00
samples Reorganize projects 2020-07-18 18:55:43 -07:00
src Introduce command exception 2020-07-20 00:17:08 -08:00
.gitignore Remove strong name signing 2020-04-16 12:19:59 +08:00
CONTRIBUTING.md Rename docs for SEO 2020-07-17 09:48:54 +08:00
Directory.Build.props Standardize coding styles 2020-07-18 10:31:55 +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 Revise docs for 3.0.0-alpha.1 (#587) 2020-07-20 21:40:05 +08:00
WinSW.nuspec Rename docs for SEO 2020-07-17 09:48:54 +08:00

README.md

Windows Service Wrapper in a permissive license

Github All Releases GitHub Release NuGet Build Status Deployment Status Gitter 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.

We are actively developing WinSW v3. Please refer to the v2 branch for previous version documentation.

Please help us prioritize items by voting or commenting on the issues!

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 64-bit and 32-bit executables based on .NET Core.

More executables can be added upon request.

Download

WinSW binaries are available on GitHub Releases and NuGet.

Alternative sources:

Usage

WinSW is being managed by the XML configuration file.

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

  • install

    Install the service to Windows Service Controller. This command requires some preliminary steps described in the Installation guide.

  • uninstall

    Uninstall the service. The opposite operation of above.

  • start

    Start the service. The service must have already been installed.

  • stop

    Stop the service.

  • stopwait

    Stop the service and wait until it's actually stopped.

  • restart

    Restart the service. If the service is not currently running, this command acts like start.

  • status

    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.

Most commands require Administrator privileges to execute. Since 2.8, WinSW will prompt for UAC in non-elevated sessions.

Documentation

User documentation:

Developer documentation:

Contributing

Contributions are welcome! No Contributor License Agreement is needed, just submit your pull requests. See the contributing guidelines for more information.

License

WinSW is licensed under the MIT license.