winsw/README.md

# Windows Service Wrapper in less restrictive license

[![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases)
[![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/)
[![Build Status](https://img.shields.io/azure-devops/build/winsw/aabe43dd-6f6d-4660-b5dd-5b79e1e2ef4e/1?style=flat-square)](https://dev.azure.com/winsw/winsw/_build?definitionId=1&_a=summary)
[![Gitter](https://img.shields.io/gitter/room/winsw/winsw?style=flat-square)](https://gitter.im/winsw/winsw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![License](https://img.shields.io/github/license/winsw/winsw?style=flat-square)](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).

## 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 which are based on .NET Core 3.1.

More executables can be added upon request.

## Download

WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/).

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/).

## Usage

WinSW is being managed by configuration files: [Main XML configuration file](docs/xml-config-file.md) and [EXE configuration file](docs/exe-config-file.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](docs/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.
* `stopwait` to stop the service and wait until it's actually stopped.
* `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.

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

## Documentation

User documentation:

* [Installation guide](docs/installation.md) - Describes the installation process for different systems and .NET versions
* Configuration:
  * [Main XML configuration file](docs/xml-config-file.md)
  * [EXE configuration file](docs/exe-config-file.md)
  * [Logging and error reporting](docs/logging-and-error-reporting.md)
  * [Extensions](docs/extensions/extensions.md)
* Use-cases:
  * [Self-restarting services](docs/self-restarting-service.md)
  * [Deferred file operations](docs/deferred-file-operations.md)

Developer documentation:

* [Developer guide](DEVELOPER.md)

## Contributing

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

## License

WinSW is licensed under the [MIT](LICENSE.txt) license.
Apply suggestions from code review by @NextTurn Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> 2020-04-11 12:16:52 +00:00			`# Windows Service Wrapper in less restrictive license`
adding doc 2013-03-01 23:55:22 +00:00
Clean up documentation 2018-11-29 16:00:00 +00:00			`[![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases)`
			`[![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/)`
Update build status badge on README 2019-09-17 16:00:00 +00:00			`[![Build Status](https://img.shields.io/azure-devops/build/winsw/aabe43dd-6f6d-4660-b5dd-5b79e1e2ef4e/1?style=flat-square)](https://dev.azure.com/winsw/winsw/_build?definitionId=1&_a=summary)`
Clean up documentation 2018-11-29 16:00:00 +00:00			`[![Gitter](https://img.shields.io/gitter/room/winsw/winsw?style=flat-square)](https://gitter.im/winsw/winsw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)`
			`[![License](https://img.shields.io/github/license/winsw/winsw?style=flat-square)](LICENSE.txt)`
Fixes #142 - Deploy the automatic build on Appveyor (#144) * First configuration stub * Get rid of the old winsw_cert.pfx references, adjust docs * Fix the corrupted log4net reference, we use 2.0.3 * Generate stub SNK file * Signing: Try full SDK path to generate SNKs * Fix the path * Signing: Sign all assemblies being packed into WinSW * Tests: Try enabling tests * Tests and artifacts: Use absolute paths * Artifact path must be relative * The test DLL is the NUnit one * nunit-console does not require loggers * NUnit: Try picking all DLLs in the output folder * NUnit console: No wildcards * Tests: Fix the test project to make it properly working with the new project structure * Docs: Clarify the specifics of external extension usage * Add AppVeyor badge to README.md 2016-12-04 08:34:19 +00:00
Update the readme file 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.`
Clean up documentation 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.`
Update the readme file 2016-11-25 22:26:12 +00:00
Update documentation headers 2018-11-27 16:00:00 +00:00			`## Why?`
Docs: Decouple the project manifest to a standalone page 2016-11-25 22:28:42 +00:00
			`See the [project manifest](MANIFEST.md).`

Cleanup and restructure the README page 2020-04-10 21:29:34 +00:00			`## Supported platforms`

			`WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1.`
Update README.md Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> 2020-04-17 06:03:12 +00:00			`It can run on Windows platforms which have these versions of .NET Framework installed.`
Apply suggestions from code review by @NextTurn Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> 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.`
Cleanup and restructure the README page 2020-04-10 21:29:34 +00:00
			`More executables can be added upon request.`

Update documentation headers 2018-11-27 16:00:00 +00:00			`## Download`
Update the readme file 2016-11-25 22:26:12 +00:00
Cleanup and restructure the README page 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/).`
Reference GitHub as a release source 2016-12-09 22:58:28 +00:00
Cleanup and restructure the README page 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/).`
Update the readme file 2016-11-25 22:26:12 +00:00
Update documentation headers 2018-11-27 16:00:00 +00:00			`## Usage`
Docs: Fix links 2016-11-25 20:56:39 +00:00
Rename docs for SEO 2020-02-03 16:00:00 +00:00			`WinSW is being managed by configuration files: [Main XML configuration file](docs/xml-config-file.md) and [EXE configuration file](docs/exe-config-file.md).`
Docs: Fix links 2016-11-25 20:56:39 +00:00
Clean up documentation 2018-11-29 16:00:00 +00:00			`Your renamed WinSW.exe binary also accepts the following commands:`
Docs: Fix links 2016-11-25 20:56:39 +00:00
			* `install` to install the service to Windows Service Controller.
Rename docs for SEO 2020-02-03 16:00:00 +00:00			`This command requires some preliminary steps described in the [Installation guide](docs/installation.md).`
moving more text from Wiki 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.
Update README.md with 'stopwait' command description 2019-12-16 21:50:15 +00:00			* `stopwait` to stop the service and wait until it's actually stopped.
moving more text from Wiki 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`.
Improve formatting of the help layout for the status command 2016-12-10 00:31:00 +00:00			* `status` to check the current status of the service.
Readme: Fix the documentation output 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.
moving more text from Wiki 2013-03-02 00:11:27 +00:00
Prompt for elevation (#457) * Prompt for elevation * Add error messages for interop errors * Assume process is elevated on Windows XP Co-authored-by: Oleg Nenashev <o.v.nenashev@gmail.com> 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.`

Update documentation headers 2018-11-27 16:00:00 +00:00			`## Documentation`
moving more text from Wiki 2013-03-02 00:11:27 +00:00
Add WinSW Developer Guide 2017-05-05 13:35:50 +00:00			`User documentation:`

Rename docs for SEO 2020-02-03 16:00:00 +00:00			`* [Installation guide](docs/installation.md) - Describes the installation process for different systems and .NET versions`
Decouple the documentation to several pages 2016-11-24 03:02:30 +00:00			`* Configuration:`
Rename docs for SEO 2020-02-03 16:00:00 +00:00			`* [Main XML configuration file](docs/xml-config-file.md)`
			`* [EXE configuration file](docs/exe-config-file.md)`
			`* [Logging and error reporting](docs/logging-and-error-reporting.md)`
			`* [Extensions](docs/extensions/extensions.md)`
Decouple the documentation to several pages 2016-11-24 03:02:30 +00:00			`* Use-cases:`
Rename docs for SEO 2020-02-03 16:00:00 +00:00			`* [Self-restarting services](docs/self-restarting-service.md)`
			`* [Deferred file operations](docs/deferred-file-operations.md)`
Descibe the build environment Follow-up to #62 Also resolves #5 2015-01-28 13:40:12 +00:00
Add WinSW Developer Guide 2017-05-05 13:35:50 +00:00			`Developer documentation:`

Update documentation headers 2018-11-27 16:00:00 +00:00			`* [Developer guide](DEVELOPER.md)`
Add WinSW Developer Guide 2017-05-05 13:35:50 +00:00
Cleanup and restructure the README page 2020-04-10 21:29:34 +00:00			`## Contributing`
Add compatibility notes to the documentation 2016-12-09 21:41:06 +00:00
Cleanup and restructure the README page 2020-04-10 21:29:34 +00:00			`Contributions are welcome!`
Apply suggestions from code review by @NextTurn Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> 2020-04-11 12:16:52 +00:00			`No Contributor License Agreement is needed, just submit your pull requests.`
Rename docs for SEO 2020-02-03 16:00:00 +00:00			`See the [contributing guidelines](CONTRIBUTING.md) for more information.`
Docs: Update WinSW 1/2 in README 2016-11-25 12:34:50 +00:00
Clean up documentation 2018-11-29 16:00:00 +00:00			`## License`

			`WinSW is licensed under the [MIT](LICENSE.txt) license.`