diff --git a/src/docs/markdown/running.md b/src/docs/markdown/running.md index 7d7f803..fbc2a46 100644 --- a/src/docs/markdown/running.md +++ b/src/docs/markdown/running.md @@ -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: -
<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>
-
+```xml + + caddy + + Caddy Web Server (powered by WinSW) + + Caddy Web Server (https://caddyserver.com/) + %BASE%\caddy.exe + run + + yyyy-MM-dd + + +``` You can now install the service using: -
caddy-service install
+
caddy-service install
You might want to start the Windows Services Console to see if the service is runnnig correctly: -
services.msc
+
services.msc
Be aware that Windows services cannot be reloaded, so you have to tell caddy directly to relaod: -
caddy reload
+
caddy reload
-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)