2013-03-01 23:55:22 +00:00
winsw: Windows service wrapper in less restrictive license
=========================
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
Right now the project uses [Jenkins ](https://jenkins.io/index.html ) Maven repository as a main storage of release files.
Binaries are available [here ](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/ ).
Some releases (e.g. alpha- and beta-versions) can be also downloaded from the project's GitHub page.
This source of releases is not an **official one** .
### 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` .
* `status` to check the current status of the service. This command prints one line to the console. `NonExistent` to indicate the service is not currently installed, `Started` to indicate the service is currently running, and `Stopped` to indicate that the service is installed but not currently running.
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.
API stability is not guaranteed till the first release, the project structure is in flux.
Major changes since 1.x:
* Rework of the project structure
* Better logging
2016-12-02 12:59:26 +00:00
* [Internal extension engine ](doc/extensions/extensions.md ), which allows extending the WinSW behavior
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)
2015-01-28 13:40:12 +00:00
* winsw_cert.pfx should be available in the project's root
* 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
