Skip to content

docs: update caddy config example & guide #13964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 22, 2024
Merged

docs: update caddy config example & guide #13964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
369bc47
Update README.md
nanospearing Jul 21, 2024
5051cf8
docs: add on_demand_tls server
nanospearing Jul 21, 2024
8aad30c
docs: fix formatting to match the rest of the of the caddyfile
nanospearing Jul 21, 2024
9bbd3f2
docs: reflect the change in caddyfile
nanospearing Jul 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions examples/web-server/caddy/Caddyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
{
on_demand_tls {
ask http://example.com
}
}

coder.example.com, *.coder.example.com {
reverse_proxy localhost:3000
tls {
Expand Down
13 changes: 7 additions & 6 deletions examples/web-server/caddy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ This is an example configuration of how to use Coder with [caddy](https://caddys
- `coder.example.com`: Domain name you're using for Coder.
- `*.coder.example.com`: Domain name for wildcard apps, commonly used for [dashboard port forwarding](https://coder.com/docs/coder-oss/latest/networking/port-forwarding#dashboard). This is optional and can be removed.
- `localhost:3000`: Address Coder is running on. Modify this if you changed `CODER_HTTP_ADDRESS` in the Coder configuration.
- _DO NOT CHANGE the `ask http://example.com` line! Doing so will result in your certs potentially not being generated._

4. [Configure Coder](https://coder.com/docs/coder-oss/latest/admin/configure) and change the following values:

Expand Down Expand Up @@ -111,9 +112,9 @@ For production deployments, we recommend configuring Caddy to generate a wildcar
```diff
tls {
- on_demand
issuer acme {
email email@example.com
}
- issuer acme {
- email email@example.com
- }

+ dns route53 {
+ max_retries 10
Expand All @@ -137,9 +138,9 @@ For production deployments, we recommend configuring Caddy to generate a wildcar
```diff
tls {
- on_demand
issuer acme {
email email@example.com
}
- issuer acme {
- email email@example.com
- }

+ dns cloudflare CLOUDFLARE_API_TOKEN
}
Expand Down
Loading