Need help with winsw?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

winsw
6.3K Stars 1.0K Forks MIT License 785 Commits 116 Opened issues

Description

A wrapper executable that can run any executable as a Windows service, in a permissive license.

Services available

!
?

Need anything else?

Contributors list

Windows Service Wrapper in a permissive license

Github All Releases GitHub Release NuGet Build Status Deployment Status Gitter License

WinSW wraps and manages any application as a Windows service.

We are actively developing WinSW 3. Please refer to the v2 branch for previous version documentation.

Why?

See the project manifest.

Supported platforms

WinSW 3 can run on Windows platforms with .NET Framework 4.6.1 or later versions installed. For systems without .NET Framework, the project provides native 64-bit and 32-bit executables based on .NET Core.

More executables can be added upon request.

.NET Framework system requirements\ Preinstalled since Windows 10, version 1511 and Windows Server 2016.\ Installable since Windows 7 SP1 and Windows Server 2008 R2 SP1.

.NET 5 system requirements\ Supported since Windows 7 SP1, Windows Server (Core) 2012 R2 and Nano Server, version 1809.

Download

Latest release and pre-release WinSW binaries are available on GitHub Releases.

Alternative sources:

Get started

Use WinSW as a global tool

  1. Take WinSW.exe or WinSW.zip from the distribution.
  2. Write myapp.xml (see the XML config file specification and samples for more details).
  3. Run
    winsw install myapp.xml [options]
    to install the service.
  4. Run
    winsw start myapp.xml
    to start the service.
  5. Run
    winsw status myapp.xml
    to see if your service is up and running.

Use WinSW as a bundled tool

  1. Take WinSW.exe or WinSW.zip from the distribution, and rename the .exe to your taste (such as myapp.exe).
  2. Write myapp.xml (see the XML config file specification and samples for more details).
  3. Place those two files side by side, because that's how WinSW discovers its co-related configuration.
  4. Run
    myapp.exe install [options]
    to install the service.
  5. Run
    myapp.exe start
    to start the service.

Sample configuration file

You write the configuration file that defines your service. The example below is a primitive example being used in the Jenkins project:

  jenkins
  Jenkins
  This service runs Jenkins continuous integration system.
  
  java
  -Xrs -Xmx256m -jar "%BASE%\jenkins.war" --httpPort=8080
  

The full specification of the configuration file is available here. You can find more samples here.

Usage

WinSW is being managed by the XML configuration file.

Your renamed WinSW.exe binary also accepts the following commands:

| Command | Description | | ------- | ----------- | | install | Installs the service. | | uninstall | Uninstalls the service. | | start | Starts the service. | | stop | Stops the service. | | restart | Stops and then starts the service. | | status | Checks the status of the service. | | refresh | Refreshes the service properties without reinstallation. | | customize | Customizes the wrapper executable. | | dev | Experimental commands. |

Experimental commands:

| Command | Description | | ------- | ----------- | | dev ps | Draws the process tree associated with the service. | | dev kill | Terminates the service if it has stopped responding. | | dev list | Lists services managed by the current executable. |

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

Documentation

Contributing

Contributions are welcome! See the contributing guidelines for more information.

License

WinSW is licensed under the MIT license.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.