mirror of https://github.com/winsw/winsw
87 lines
3.9 KiB
Markdown
87 lines
3.9 KiB
Markdown
# winsw: Windows Service Wrapper in less restrictive license
|
|
|
|
[](https://github.com/winsw/winsw/releases)
|
|
[](https://www.nuget.org/packages/WinSW/)
|
|
[](https://ci.appveyor.com/project/winsw/winsw)
|
|
[](https://gitter.im/winsw/winsw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
[](LICENSE.txt)
|
|
|
|
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](MANIFEST.md).
|
|
|
|
## Download
|
|
|
|
Starting from WinSW v2, the releases are being hosted on [GitHub](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/).
|
|
|
|
Due to historical reasons, the project also uses the [Jenkins](https://jenkins.io/) Maven repository as a secondary source.
|
|
Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/).
|
|
|
|
## Usage
|
|
|
|
WinSW is being managed by configuration files: [Main XML configuration file](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md).
|
|
|
|
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](doc/installation.md).
|
|
* `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.
|
|
|
|
## Supported .NET versions
|
|
|
|
### WinSW v2
|
|
|
|
WinSW v2 offers two executables, which declare .NET Frameworks 2.0 and 4.0 as targets.
|
|
More executables can be added on-demand.
|
|
Please create an issue if you need such executables.
|
|
|
|
## Documentation
|
|
|
|
User documentation:
|
|
|
|
* [Installation guide](doc/installation.md) - Describes the installation process for different systems and .NET versions
|
|
* Configuration:
|
|
* [Main XML configuration file](doc/xmlConfigFile.md)
|
|
* [EXE configuration file](doc/exeConfigFile.md)
|
|
* [Logging and error reporting](doc/loggingAndErrorReporting.md)
|
|
* [Extensions](doc/extensions/extensions.md)
|
|
* Use-cases:
|
|
* [Self-restarting services](doc/selfRestartingService.md)
|
|
* [Deferred file operations](doc/deferredFileOperations.md)
|
|
* Configuration Management:
|
|
* [Puppet Forge Module](doc/puppetWinSW.md)
|
|
|
|
Developer documentation:
|
|
|
|
* [Developer guide](DEVELOPER.md)
|
|
|
|
## Release lines
|
|
|
|
### WinSW v2
|
|
|
|
This is a new baseline of WinSW with several major changes:
|
|
* Major documentation rework and update
|
|
* New executable package targeting the .NET Framework 4.0. .NET Framework 2.0 is still supported.
|
|
* [Extension engine](doc/extensions/extensions.md), which allows extending the wrapper's behavior. And a couple of extensions for it (Shared Directory Mapper, Runaway Process Killer)
|
|
* New release hosting: GitHub and NuGet
|
|
* Migration of the logging subsystem to Apache log4net
|
|
* Bugfixes
|
|
|
|
The version v2 is **fully compatible** with the v1 configuration file format,
|
|
hence the upgrade procedure just requires replacement of the executable file.
|
|
|
|
## License
|
|
|
|
WinSW is licensed under the [MIT](LICENSE.txt) license.
|