mirrors/winsw
1
0
Fork 0
mirror of https://github.com/winsw/winsw.git synced 2025-12-10 18:37:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Revise docs for 3.0.0-alpha.3 (#608)

Browse Source 
* Mention optional settings

* Mention removed settings

* Add links to system requirements

* markdownlint fixes

* Remove trailing spaces

* Mention boolean elements

* Add preshutdown

* Add `dev ps` command

* Stop misleading

* Why aren't you using Windows 10?

* Add `stdoutPath`/`stderrPath`

* Relative paths and the default working directory

* Send a close message to Windows (GUI) apps

* Use valid XML

* Add `customize` and `dev kill` commands

* Update README.md

* Add commands

* Fix spacing

* Update installation.md

* Update README.md
This commit is contained in:
Next Turn
2020-08-11 07:54:32 +08:00
committed by GitHub
parent 1f188cf20b
commit dcf3013f75
15 changed files with 241 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -8,10 +8,9 @@
[![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*.
WinSW wraps and manages any application as a Windows service.
**We are actively developing WinSW v3. Please refer to the v2 branch for previous version documentation.**
**We are actively developing WinSW 3. Please refer to the v2 branch for previous version documentation.**
**Please help us prioritize items by voting or commenting on the issues!**
@@ -26,14 +25,23 @@ For systems without .NET Framework, the project provides native 64-bit and 32-bi
More executables can be added upon request.
[.NET Framework system requirements](https://docs.microsoft.com/dotnet/framework/get-started/system-requirements)\
Preinstalled on Windows 10, version 1511 and Windows Server 2016.\
Installable on Windows 7 SP1 and Windows Server 2008 R2 SP1.
[.NET 5 system requirements](https://github.com/dotnet/core/blob/master/release-notes/5.0/5.0-supported-os.md)\
Supported on Windows 7 SP1, Windows Server (Core) 2012 R2 and Nano Server, version 1809.
## Download
WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/).
Latest release and pre-release WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases).
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/).
* CI builds are available on [Azure Pipelines](https://dev.azure.com/winsw/winsw/_build?definitionId=1).
* [NuGet](https://www.nuget.org/packages/WinSW/). (2.x)
* [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/). (2.x)
## Usage
@@ -41,8 +49,8 @@ WinSW is being managed by the [XML configuration file](docs/xml-config-file.md).
Your renamed *WinSW.exe* binary also accepts the following commands:
| Command | Description |
| ----------- | ----------- |
| Command | Description |
| ------- | ----------- |
| [install](docs/cli-commands.md#install-command) | Installs the service. This command requires some preliminary steps described in the [installation guide](docs/installation.md). |
| [uninstall](docs/cli-commands.md#uninstall-command) | Uninstalls the service. |
| [start](docs/cli-commands.md#start-command) | Starts the service. |
@@ -51,8 +59,17 @@ Your renamed *WinSW.exe* binary also accepts the following commands:
| [status](docs/cli-commands.md#status-command) | Checks the status of the service. |
| [test](docs/cli-commands.md#test-command) | Checks if the service can be started and then stopped without installation. |
| [refresh](docs/cli-commands.md#refresh-command) | Refreshes the service properties without reinstallation. |
| [customize](docs/cli-commands.md#customize-command) | Customizes the wrapper executable. |
| dev | Experimental commands. |
Most commands require Administrator privileges to execute. Since 2.8, WinSW will prompt for UAC in non-elevated sessions.
Experimental commands:
| Command | Description |
| ------- | ----------- |
| dev ps | Draws the process tree associated with the service. |
| dev kill | Terminates the service if it has stopped responding. |
Most commands require Administrator privileges to execute. WinSW will prompt for UAC in non-elevated sessions.
## Documentation