github
/
winsw
mirror of https://github.com/winsw/winsw
1
0
Fork 0
Code Issues Releases Wiki Activity

Update installation.md

pull/608/head
Next Turn 2020-08-10 22:34:45 +08:00 committed by GitHub
parent cf502ff4c7
commit 6b353176cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/installation.md
View File

@ -1,16 +1,24 @@
# Installation guide # Get started
This page provides WinSW installation guidelines for different cases. This page provides WinSW installation guidelines for different cases.
## Installation steps ## Use WinSW as a global tool
1. Take *WinSW.exe* or *WinSW.zip* from the distribution.
1. Write *myapp.xml* (see the [XML config file specification](xml-config-file.md) for more details)
1. Run [`winsw install myapp.xml [options]`](cli-commands.md#install-command) to install the service.
1. Run [`winsw start myapp.xml`](cli-commands.md#start-command) to start the service.
1. Run [`winsw status myapp.xml`](cli-commands.md#status-command) to see if your service is up and running.
## Use WinSW as a bundled tool
In order to setup WinSW, you commonly need to perform the following steps: In order to setup WinSW, you commonly need to perform the following steps:
1. Take *WinSW.exe* from the distribution, and rename it to your taste (such as *myapp.exe*) 1. Take *WinSW.exe* from the distribution, and rename it to your taste (such as *myapp.exe*)
1. Write *myapp.xml* (see the [XML config file specification](xml-config-file.md) for more details) 1. Write *myapp.xml* (see the [XML config file specification](xml-config-file.md) for more details)
1. Place those two files side by side, because that's how WinSW discovers its configuration. 1. Place those two files side by side, because that's how WinSW discovers its configuration.
1. Run `myapp.exe install <OPTIONS>` in order to install the service wrapper. 1. Run [`myapp.exe install [options]`](cli-commands.md#install-command) to install the service.
1. Run `myapp.exe start` to start the service. 1. Run [`myapp.exe start`](cli-commands.md#start-command) to start the service.
There are some details for each step available below. There are some details for each step available below.
@ -37,15 +45,5 @@ The full specification of the configuration file is available [here](xml-config-
### Step 3. Service registration ### Step 3. Service registration
You can then install the service like:
```console
myapp.exe install <OPTIONS>
```
... and you can use the exit code from these processes to determine whether the operation was successful.
Possible exit codes are described [here](https://docs.microsoft.com/windows/win32/cimwin32prov/create-method-in-class-win32-service#return-value).
Beyond these error codes, all the non-zero exit code should be assumed as a failure.
The Installer can be also started with the `/p` option. The Installer can be also started with the `/p` option.
In such case it will prompt for an account name and password, which should be used as a service account. In such case it will prompt for an account name and password, which should be used as a service account.