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

docs: --watch flag (beta 19); better proxy docs for upgrade guide

Browse source
This commit is contained in:
Matthew Holt 2020-03-23 10:17:04 -06:00
parent 1aaff7aeb4
commit ee55602b14
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
2 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -246,7 +246,8 @@ This command disables the admin API, making it easier to run multiple instances
[--config <path>] [--config <path>]
[--adapter <name>] [--adapter <name>]
[--environ] [--environ]
[--resume]</code></pre> [--resume]
[--watch]</code></pre>
<aside class="tip"> <aside class="tip">
To change the active configuration while running in production, do not stop the server! That will result in downtime. (This should be obvious but you'd be surprised how many complaints we get about it.) Use the <a href="#caddy-reload">caddy reload</a> command instead. To change the active configuration while running in production, do not stop the server! That will result in downtime. (This should be obvious but you'd be surprised how many complaints we get about it.) Use the <a href="#caddy-reload">caddy reload</a> command instead.
@ -262,14 +263,17 @@ Runs Caddy and blocks indefinitely; i.e. "daemon" mode.
`--resume` uses the last loaded configuration. This flag is useful primarily in [API](/docs/api)-heavy deployments, and overrides `--config` if a saved config exists. `--resume` uses the last loaded configuration. This flag is useful primarily in [API](/docs/api)-heavy deployments, and overrides `--config` if a saved config exists.
`--watch` will watch the config file and automatically reload it after it changes. ⚠️ This feature is dangerous in production! Only use it in a local development environment.
### `caddy start` ### `caddy start`
<pre><code class="cmd bash">caddy start <pre><code class="cmd bash">caddy start
[--config &lt;path&gt;] [--config &lt;path&gt;]
[--adapter &lt;name&gt;]</code></code></pre> [--adapter &lt;name&gt;]
[--watch]</code></code></pre>
Same as `caddy run`, but in the background. This command only blocks until the background process is running successfully (or fails to run), then returns. Same as [`caddy run`](#caddy-run), but in the background. This command only blocks until the background process is running successfully (or fails to run), then returns.
Use of this command is discouraged with system services or on Windows. On Windows, the child process will remain attached to the terminal, so closing the window will forcefully stop Caddy, which is not obvious. Use of this command is discouraged with system services or on Windows. On Windows, the child process will remain attached to the terminal, so closing the window will forcefully stop Caddy, which is not obvious.

12
src/docs/markdown/v2-upgrade.md
View file

@ -7,7 +7,7 @@ Upgrade Guide
Caddy 2 is a whole new code base, written from scratch, to improve on Caddy 1. Caddy 2 is not backwards-compatible with Caddy 1. But don't worry, for most basic setups, not much is different. This guide will help you transition as easily as possible. Caddy 2 is a whole new code base, written from scratch, to improve on Caddy 1. Caddy 2 is not backwards-compatible with Caddy 1. But don't worry, for most basic setups, not much is different. This guide will help you transition as easily as possible.
This guide won't delve into the [new features](https://caddyserver.com/docs/getting-started) available -- which are really cool, by the way, you should learn them -- the goal here is to just get you up and running on Caddy 2 quickly. This guide won't delve into the new features available -- which are really cool, by the way, you should [learn them](https://caddyserver.com/docs/getting-started) -- the goal here is to just get you up and running on Caddy 2 quickly.
### Menu ### Menu
@ -67,7 +67,7 @@ This guide won't delve into the [new features](https://caddyserver.com/docs/gett
Caddy's default port is no longer `:2015`. Caddy 2's default port is `:443` or, if no hostname/IP is known, port `:80`. You can always customize the ports in your config. Caddy's default port is no longer `:2015`. Caddy 2's default port is `:443` or, if no hostname/IP is known, port `:80`. You can always customize the ports in your config.
Caddy 2's default protocol is [_always_ HTTPS if a hostname or IP is known](https://localhost/docs/automatic-https#tldr). This is different from Caddy 1, where only public-looking domains used HTTPS by default. Now, _every_ site uses HTTPS (unless you disable it by explicitly specifying port `:80` or `http://`). Caddy 2's default protocol is [_always_ HTTPS if a hostname or IP is known](/docs/automatic-https#tldr). This is different from Caddy 1, where only public-looking domains used HTTPS by default. Now, _every_ site uses HTTPS (unless you disable it by explicitly specifying port `:80` or `http://`).
IP addresses and localhost domains will be issued certificates from a [locally-trusted, embedded CA](/docs/automatic-https#local-https). All other domains will use Let's Encrypt. (This is all configurable.) IP addresses and localhost domains will be issued certificates from a [locally-trusted, embedded CA](/docs/automatic-https#local-https). All other domains will use Let's Encrypt. (This is all configurable.)
@ -180,6 +180,14 @@ log {
The v2 equivalent is [`reverse_proxy`](/docs/caddyfile/directives/reverse_proxy). The v2 equivalent is [`reverse_proxy`](/docs/caddyfile/directives/reverse_proxy).
Notable subdirective changes are `header_upstream` and `header_downstream` have become `header_up` and `header_down`, respectively; and load-balancing-related subdirectives are prefixed with `lb_`.
One other significant difference is that the v2 proxy passes all incoming headers thru by default (including the `Host` header) and sets the `X-Forwarded-For` header. In other words, v1's "transparent" mode is basically the default in v2 (but if you need other headers like X-Real-IP you have to set those yourself). You can still override/customize the `Host` header using the `header_up` subdirective.
Websocket proxying "just works" in v2; there is no need to "enable" websockets like in v1.
The `without` subdirective has been removed because [rewrite hacks](#rewrite) are no longer necessary in v2 thanks to improved matcher support.
- **v1:** `proxy / localhost:9005` - **v1:** `proxy / localhost:9005`
- **v2:** `reverse_proxy localhost:9005` - **v2:** `reverse_proxy localhost:9005`