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

Better prose and retain old structure

Browse source
This commit is contained in:
Christian Glahn 2022-06-05 10:46:15 +02:00 • committed by GitHub
parent 1f5f83879a
commit a0af309a5b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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.
<aside class="complete">Make a Caddyfile</aside>
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.
<aside class="tip" markdown="1">
The Caddyfile offers shortcuts for many common tasks that are require complex JSON configurations. Use `caddy adapt` to learn how these shortcuts work in JSON.
The Caddyfile offers shortcuts for many common tasks that require quite complex JSON configurations. You can use `caddy adapt` to learn how these shortcuts are translated between the formats.
</aside>
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
<aside class="complete">Compare API and config files</aside>
## 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).