From a0af309a5bc069e9bf5a40cfa63cd4a70091e224 Mon Sep 17 00:00:00 2001 From: Christian Glahn Date: Sun, 5 Jun 2022 10:46:15 +0200 Subject: [PATCH] Better prose and retain old structure --- src/docs/markdown/getting-started.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/docs/markdown/getting-started.md b/src/docs/markdown/getting-started.md index 1c4ad50..c2047c7 100644 --- a/src/docs/markdown/getting-started.md +++ b/src/docs/markdown/getting-started.md @@ -56,6 +56,7 @@ This blocks forever, but what is it doing? At the moment... nothing. By default, We can make Caddy useful by giving it a config. This can be done many ways, but we'll start by making a POST request to the [/load](/docs/api#post-load) endpoint using `curl` in the next section. + ## Your first config To prepare our request, we need to make a config. At its core, Caddy's configuration is simply a [JSON document](/docs/json/). @@ -124,11 +125,12 @@ Another way to configure Caddy is with the [**Caddyfile**](/docs/caddyfile). The respond "Hello, world!" ``` + Save that to a file named `Caddyfile` (no extension) in the current directory. -Next we check if the configuration is valid. +Next we check if our new configuration is valid. Stop Caddy if it is already running (Ctrl+C), then run: @@ -198,7 +200,7 @@ Kind of boring | Kind of fun You will need to decide which is best for your use case. It is important to note that both JSON and the Caddyfile (and [any other supported config adapter](/docs/config-adapters)) can be used with [Caddy's API](/docs/api). However, you only get the full range of Caddy's functionality and API features if you use JSON. If using a config adapter, the only way to load or change the config with the API is the [/load endpoint](/docs/api#post-load). @@ -235,6 +237,7 @@ As you can see, Caddy is well-suited for a wide variety of use cases and deploym + ## Start, stop, run Since Caddy is a server, it runs indefinitely. That means your terminal won't unblock after you execute `caddy run` until the process is terminated (usually with Ctrl+C).