From caede64af5af94902e716c82d65782af8098907b Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Wed, 24 Feb 2021 11:29:17 -0700 Subject: [PATCH] docs: Minor improvements --- src/docs/markdown/command-line.md | 2 +- src/docs/markdown/getting-started.md | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/docs/markdown/command-line.md b/src/docs/markdown/command-line.md index 1c58a18..c100a6d 100644 --- a/src/docs/markdown/command-line.md +++ b/src/docs/markdown/command-line.md @@ -282,7 +282,7 @@ Runs Caddy and blocks indefinitely; i.e. "daemon" mode. `--envfile` loads environment variables from the specified file. -`--resume` uses the last loaded configuration, overriding the `--config` flag (if present) if a previous config was saved. Using this flag guarantees config durability through machine reboots or process restarts. It is most useful in [API](/docs/api)-heavy deployments. +`--resume` uses the last loaded configuration that was autosaved, overriding the `--config` flag (if present). Using this flag guarantees config durability through machine reboots or process restarts. It is most useful in [API](/docs/api)-centric deployments. `--watch` will watch the config file and automatically reload it after it changes. ⚠️ This feature is intended for use only in local development environments! diff --git a/src/docs/markdown/getting-started.md b/src/docs/markdown/getting-started.md index a0c62bf..d34ce2b 100644 --- a/src/docs/markdown/getting-started.md +++ b/src/docs/markdown/getting-started.md @@ -44,6 +44,10 @@ This blocks forever, but what is it doing? At the moment... nothing. By default, 
curl localhost:2019/config/
+ + 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. @@ -54,7 +58,7 @@ We can make Caddy useful by giving it a config. This can be done many ways, but To prepare our request, we need to make a config. At its core, Caddy's configuration is simply a [JSON document](/docs/json/). -Save this to a JSON file: +Save this to a JSON file (e.g. `caddy.json`): ```json { @@ -79,7 +83,7 @@ Save this to a JSON file: ``` Then upload it: