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

docs: Minor improvements

Browse source
This commit is contained in:
Matthew Holt 2021-02-24 11:29:17 -07:00
parent 23e40421c0
commit caede64af5
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/docs/markdown/command-line.md
View file

@ -282,7 +282,7 @@ Runs Caddy and blocks indefinitely; i.e. "daemon" mode.
`--envfile` loads environment variables from the specified file. `--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! `--watch` will watch the config file and automatically reload it after it changes. ⚠️ This feature is intended for use only in local development environments!

8
src/docs/markdown/getting-started.md
View file

@ -44,6 +44,10 @@ This blocks forever, but what is it doing? At the moment... nothing. By default,
<pre><code class="cmd bash">curl localhost:2019/config/</code></pre> <pre><code class="cmd bash">curl localhost:2019/config/</code></pre>
<aside class="tip">
This is <b>not</b> your website: the administration endpoint at localhost:2019 is used for controlling Caddy and is restricted to localhost by default.
</aside>
<aside class="complete">Try the API</aside> <aside class="complete">Try the API</aside>
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. 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/). 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 ```json
{ {
@ -79,7 +83,7 @@ Save this to a JSON file:
``` ```
<aside class="tip"> <aside class="tip">
You do not have to use files for configuration. The <a href="/docs/api">admin API</a> can always be used without files, which is handy when automating. You do not have to use config files, but we are for this tutorial. Caddy's <a href="/docs/api">admin API</a> is designed for use by other programs or scripts.
</aside> </aside>
Then upload it: Then upload it: