2013-03-01 23:55:22 +00:00
winsw: Windows service wrapper in less restrictive license
=========================
2016-12-04 08:34:19 +00:00
[](https://ci.appveyor.com/project/oleg-nenashev/winsw)
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.
Once you download the installation package, you can rename `winsw.exe` to any name, e.g. `myService.exe` .
2016-11-25 22:28:42 +00:00
### Why?
See the [project manifest ](MANIFEST.md ).
2016-11-25 22:26:12 +00:00
### Download
2016-12-09 22:58:28 +00:00
Starting from WinSW `2.x` , the releases are being hosted on GitHub ([here](https://github.com/kohsuke/winsw/releases)).
The project also uses the [Jenkins ](https://jenkins.io/index.html ) Maven repository as a secondary storage of release files.
Binaries are available [here ](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/ ).
2016-11-25 22:26:12 +00:00
2016-12-10 00:40:04 +00:00
The executables in all sources are [strong-named assemblies ](https://msdn.microsoft.com/en-us/library/wd40t7ad%28v=vs.110%29.aspx ), which are being singed by randomly generated keys.
Do not rely on such strong names for security (as well as on other strong names as it recommended by Microsoft).
They provide a unique identity only.
2016-11-25 22:26:12 +00:00
### Usage
2016-11-25 20:56:39 +00:00
2016-11-25 22:36:39 +00:00
WinSW is being managed by configuration files: [Main XML Configuration file ](doc/xmlConfigFile.md ) and [EXE Config file ](doc/exeConfigFile.md ).
2016-11-25 20:56:39 +00:00
2016-11-25 22:26:12 +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.
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.
* `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.
* 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
2016-12-04 11:20:54 +00:00
### Supported .NET versions
WinSW `1.x` Executable is being built with a .NET Framework `2.0` target, and by defaut it will work only for .NET Framework versions below `3.5` .
On the other hand, the code is known to be compatible with .NET Framework `4.0` and above.
It is possible to declare the support of this framework via the `exe.config` file.
See the [Installation Guide ](doc/installation.md ) for more details.
WinSW `2.x` offers two executables, which declare .NET Frameworks `2.0` and `4.0` as targets.
Naming and download sources for these binaries are currently in flux.
2016-11-24 03:02:30 +00:00
### Documentation
2013-03-02 00:11:27 +00:00
2016-11-25 20:56:39 +00:00
* [Installation Guide ](doc/installation.md ) - Describes the installation process for different systems and .NET versions
2016-11-25 21:00:30 +00:00
* [Release notes ](CHANGELOG.md )
2016-11-24 03:02:30 +00:00
* Configuration:
* [Main XML Configuration file ](doc/xmlConfigFile.md )
2016-11-25 22:36:39 +00:00
* [EXE Configuration File ](doc/exeConfigFile.md )
2016-11-24 03:02:30 +00:00
* [Logging and Error Reporting ](doc/loggingAndErrorReporting.md )
2016-12-02 12:59:26 +00:00
* [Extensions ](doc/extensions/extensions.md )
2016-11-24 03:02:30 +00:00
* Use-cases:
* [Self-restarting services ](doc/selfRestartingService.md )
* [Deferred File Operations ](doc/deferredFileOperations.md )
2016-11-30 18:54:07 +00:00
* Configuration Management:
* [Puppet Forge Module ](doc/puppetWinSW.md )
2015-01-28 13:40:12 +00:00
2016-11-25 12:34:50 +00:00
### Release lines
#### WinSW 2.x
This is a new release line under active development.
Major changes since 1.x:
2016-12-09 21:41:06 +00:00
* New executable package targeting the .NET Framework `4.0` . .NET Framework `2.0` is still supported.
* Migration of the logging subsystem to `Apache log4net`
* Internal [extension engine ](doc/extensions/extensions.md ), which allows extending the wrapper's behavior.
See the full changelog in the [release notes ](CHANGELOG.md#20 ).
The version `2.x` is **fully compatible** with the `1.x` configuration file format,
hence the upgrade procedure just requires replacement of the executable file.
2016-11-25 12:34:50 +00:00
#### 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.
2015-02-04 12:18:01 +00:00
2015-01-28 13:40:12 +00:00
### Build Environment
2016-11-24 00:32:26 +00:00
* IDE: [Visual Studio Community 2013 ](http://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx ) (free for open-source projects)
2016-12-04 08:34:19 +00:00
* `winsw-key.snk` should be available in the project's root in order to build the executable
2015-01-28 13:40:12 +00:00
* You can generate the certificate in "Project Settings/Signing"
* The certificate is in < code > .gitignore</ code > list. Please do not add it to the repository
