mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-04-23 21:46:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

restructure the "build from source" page (#370)

Browse source 
* restructure the "build from source" page

* partially address feedback

* address feedback

* Polishing, more cross-linking, update Docker Compose

---------

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
This commit is contained in:
Mohammed Al Sahaf 2024-02-08 09:40:50 +03:00 • committed by GitHub
parent a57d9e3ea2
commit 6882c88152
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 81 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -188,29 +188,23 @@ To tag the `caddy` binary, you can use the following command:
## Windows service
There are two ways to run Caddy as a service on Windows: sc.exe or WinSW.
There are two ways to run Caddy as a service on Windows: [sc.exe](#scexe) or [WinSW](#winsw).
### sc.exe
To create the service, run:
```
sc.exe create caddy start= auto binPath= "YOURPATH\caddy.exe run"
```
<pre><code class="cmd bash">sc.exe create caddy start= auto binPath= "YOURPATH\caddy.exe run"</code></pre>
(replace YOURPATH with the actual path to your `caddy.exe`)
(replace `YOURPATH` with the actual path to your `caddy.exe`)
To start:
```
sc.exe start caddy
```
<pre><code class="cmd bash">sc.exe start caddy</code></pre>
To stop:
```
sc.exe stop caddy
```
<pre><code class="cmd bash">sc.exe stop caddy</code></pre>
### WinSW
@ -270,11 +264,9 @@ This assumes you're using [Docker Compose V2](https://docs.docker.com/compose/re
### Setup
First, create a file `docker-compose.yml` (or add this service to your existing file):
First, create a file `compose.yml` (or add this service to your existing file):
```yaml
version: "3.9"
services:
caddy:
image: caddy:<version>
@ -304,7 +296,7 @@ What this does:
- Bind mounts the `site` directory to serve your site's static files from `/srv`.
- Named volumes for `/data` and `/config` to [persist important information](/docs/conventions#file-locations).
Then, create a file named `Caddyfile` beside the `docker-compose.yml`, and write your [Caddyfile](/docs/caddyfile/concepts) configuration.
Then, create a file named `Caddyfile` beside the `compose.yml`, and write your [Caddyfile](/docs/caddyfile/concepts) config.
If you have static files to serve, you may place them in a `site/` directory beside the configs, then set the [`root`](/docs/caddyfile/directives/root) using `root * /srv`. If you don't, then you may remove the `/srv` volume mount.
@ -314,6 +306,10 @@ If you're using Caddy to [reverse proxy](/docs/caddyfile/directives/reverse_prox
</aside>
If you need a custom build of Caddy with plugins, follow the [Docker build instructions](/docs/build#docker) to create a custom Docker image. Create the `Dockerfile` beside your `compose.yml`, then replace the `image:` line in your `compose.yml` with `build: .` instead.
### Usage
Then, you can start the container: