2020-04-11 12:16:52 +00:00
|
|
|
# Windows Service Wrapper in less restrictive license
|
2013-03-01 23:55:22 +00:00
|
|
|
|
2018-11-29 16:00:00 +00:00
|
|
|
[](https://github.com/winsw/winsw/releases)
|
|
|
|
|
[](https://www.nuget.org/packages/WinSW/)
|
2019-09-17 16:00:00 +00:00
|
|
|
[](https://dev.azure.com/winsw/winsw/_build?definitionId=1&_a=summary)
|
2018-11-29 16:00:00 +00:00
|
|
|
[](https://gitter.im/winsw/winsw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
|
[](LICENSE.txt)
|
2016-12-04 08:34:19 +00:00
|
|
|
|
2016-11-25 22:26:12 +00:00
|
|
|
WinSW is an executable binary, which can be used to wrap and manage a custom process as a Windows service.
|
2018-11-29 16:00:00 +00:00
|
|
|
Once you download the installation package, you can rename *WinSW.exe* to any name, e.g. *MyService.exe*.
|
2016-11-25 22:26:12 +00:00
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
## Why?
|
2016-11-25 22:28:42 +00:00
|
|
|
|
|
|
|
|
See the [project manifest](MANIFEST.md).
|
|
|
|
|
|
2020-04-10 21:29:34 +00:00
|
|
|
## Supported platforms
|
|
|
|
|
|
|
|
|
|
WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1.
|
2020-04-17 06:03:12 +00:00
|
|
|
It can run on Windows platforms which have these versions of .NET Framework installed.
|
2020-04-11 12:16:52 +00:00
|
|
|
For systems without .NET Framework, the project provides native 64-bit and 32-bit executables which are based on .NET Core 3.1.
|
2020-04-10 21:29:34 +00:00
|
|
|
|
|
|
|
|
More executables can be added upon request.
|
|
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
## Download
|
2016-11-25 22:26:12 +00:00
|
|
|
|
2020-04-10 21:29:34 +00:00
|
|
|
WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/).
|
2016-12-09 22:58:28 +00:00
|
|
|
|
2020-04-10 21:29:34 +00:00
|
|
|
Alternative sources:
|
|
|
|
|
|
|
|
|
|
* [Maven packaging](https://github.com/jenkinsci/winsw-maven-packaging) for executables, hosted by the [Jenkins project](https://jenkins.io/).
|
|
|
|
|
Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/).
|
|
|
|
|
* [Puppet](./doc/puppetWinSW.md), currently outdated (WinSW 1.x). Binaries are available on [Puppet Forge](https://forge.puppet.com/kenmaglio/winsw)
|
2016-11-25 22:26:12 +00:00
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
## Usage
|
2016-11-25 20:56:39 +00:00
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
WinSW is being managed by configuration files: [Main XML configuration file](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md).
|
2016-11-25 20:56:39 +00:00
|
|
|
|
2018-11-29 16:00:00 +00:00
|
|
|
Your renamed *WinSW.exe* binary also accepts the following commands:
|
2016-11-25 20:56:39 +00:00
|
|
|
|
|
|
|
|
* `install` to install the service to Windows Service Controller.
|
2018-11-27 16:00:00 +00:00
|
|
|
This command requires some preliminary steps described in the [Installation guide](doc/installation.md).
|
2013-03-02 00:11:27 +00:00
|
|
|
* `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.
|
2019-12-16 21:50:15 +00:00
|
|
|
* `stopwait` to stop the service and wait until it's actually stopped.
|
2013-03-02 00:11:27 +00:00
|
|
|
* `restart` to restart the service. If the service is not currently running, this command acts like `start`.
|
2016-12-10 00:31:00 +00:00
|
|
|
* `status` to check the current status of the service.
|
2017-06-15 07:09:16 +00:00
|
|
|
* 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.
|
2013-03-02 00:11:27 +00:00
|
|
|
|
2020-04-19 07:04:50 +00:00
|
|
|
Most commands require Administrator privileges to execute. Since v2.8, WinSW will prompt for UAC in non-elevated sessions.
|
|
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
## Documentation
|
2013-03-02 00:11:27 +00:00
|
|
|
|
2017-05-05 13:35:50 +00:00
|
|
|
User documentation:
|
|
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
* [Installation guide](doc/installation.md) - Describes the installation process for different systems and .NET versions
|
2016-11-24 03:02:30 +00:00
|
|
|
* Configuration:
|
2018-11-27 16:00:00 +00:00
|
|
|
* [Main XML configuration file](doc/xmlConfigFile.md)
|
|
|
|
|
* [EXE configuration file](doc/exeConfigFile.md)
|
|
|
|
|
* [Logging and error reporting](doc/loggingAndErrorReporting.md)
|
2017-04-27 23:03:07 +00:00
|
|
|
* [Extensions](doc/extensions/extensions.md)
|
2016-11-24 03:02:30 +00:00
|
|
|
* Use-cases:
|
2017-04-27 23:03:07 +00:00
|
|
|
* [Self-restarting services](doc/selfRestartingService.md)
|
2018-11-27 16:00:00 +00:00
|
|
|
* [Deferred file operations](doc/deferredFileOperations.md)
|
2016-11-30 18:54:07 +00:00
|
|
|
* Configuration Management:
|
2017-04-27 23:03:07 +00:00
|
|
|
* [Puppet Forge Module](doc/puppetWinSW.md)
|
2015-01-28 13:40:12 +00:00
|
|
|
|
2017-05-05 13:35:50 +00:00
|
|
|
Developer documentation:
|
|
|
|
|
|
2018-11-27 16:00:00 +00:00
|
|
|
* [Developer guide](DEVELOPER.md)
|
2017-05-05 13:35:50 +00:00
|
|
|
|
2020-04-10 21:29:34 +00:00
|
|
|
## Contributing
|
2016-12-09 21:41:06 +00:00
|
|
|
|
2020-04-10 21:29:34 +00:00
|
|
|
Contributions are welcome!
|
2020-04-11 12:16:52 +00:00
|
|
|
No Contributor License Agreement is needed, just submit your pull requests.
|
|
|
|
|
See the [contributing guidelines](./CONTRIBUTING.md) for more information.
|
2016-11-25 12:34:50 +00:00
|
|
|
|
2018-11-29 16:00:00 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
WinSW is licensed under the [MIT](LICENSE.txt) license.
|
