mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-05-07 12:17:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Polish the Windows Service docs a bit

Browse source
This commit is contained in:
Francis Lavoie 2021-07-23 02:43:42 -04:00
parent 59468700fa
commit a1833284c4
No known key found for this signature in database
GPG key ID: E73DB3ECE64E7885
1 changed files with 23 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

46
src/docs/markdown/running.md
View file

@ -136,40 +136,40 @@ Install Caddy as a service on Windows with these instructions.
**Requirements:**
- `caddy.exe` binary that you [downloaded](/download) or [built from source](/docs/build)
- Any exe from the latest release of the
[WinSW](https://github.com/winsw/winsw/releases/latest) service wrapper (Stay
on a v2.x release for now)
- Any `.exe` from the latest release of the
[WinSW](https://github.com/winsw/winsw/releases/latest) service wrapper (the below service config is written for v2.x releases)
Put all files into a service directory. In the following examples, we use `c:\caddy`.
Put all files into a service directory. In the following examples, we use `C:\caddy`.
Rename the WinSW exe file to `caddy-service.exe`.
Rename the `WinSW-x64.exe` file to `caddy-service.exe`.
Add a `caddy-service.xml` in the directory:
Add a `caddy-service.xml` in the same directory:
<pre><code class="cmd">&lt;service>
&lt;id>caddy&lt;/id>
&lt;!-- Display name of the service -->
&lt;name>Caddy Web Server (powered by WinSW)&lt;/name>
&lt;!-- Service description -->
&lt;description>Caddy Web Server (https://caddyserver.com/)&lt;/description>
&lt;executable>%BASE%\caddy.exe&lt;/executable>
&lt;arguments>run&lt;/arguments>
&lt;log mode="roll-by-time">
&lt;pattern>yyyy-MM-dd&lt;/pattern>
&lt;/log>
&lt;/service>
</code></pre>
```xml
<service>
<id>caddy</id>
<!-- Display name of the service -->
<name>Caddy Web Server (powered by WinSW)</name>
<!-- Service description -->
<description>Caddy Web Server (https://caddyserver.com/)</description>
<executable>%BASE%\caddy.exe</executable>
<arguments>run</arguments>
<log mode="roll-by-time">
<pattern>yyyy-MM-dd</pattern>
</log>
</service>
```
You can now install the service using:
<pre><code class="cmd">caddy-service install</code></pre>
<pre><code class="cmd bash">caddy-service install</code></pre>
You might want to start the Windows Services Console to see if the service is runnnig correctly:
<pre><code class="cmd">services.msc</code></pre>
<pre><code class="cmd bash">services.msc</code></pre>
Be aware that Windows services cannot be reloaded, so you have to tell caddy directly to relaod:
<pre><code class="cmd">caddy reload</code></pre>
<pre><code class="cmd bash">caddy reload</code></pre>
Restarting is possible via the normal Windows services commands.
Restarting is possible via the normal Windows services commands, for example via the Task Manager's "Services" tab.
For customizing the service wrapper, see the [WinSW documentation](https://github.com/winsw/winsw/tree/master#usage)