Commit graph

244 commits

Author SHA1 Message Date
Matthew Holt
cddded78a7
file_server: Add docs for virtual file system support. 2022-07-31 21:39:58 -06:00
Matthew Holt
cd102116b1
Various install/deploy updates and improvements
Install: Remove DigitalOcean
Running: Add sc.exe Windows service info

Also add caddy.fs namespace docs
2022-07-29 14:42:23 -06:00
Matthew Holt
b418c40043
namespaces: Mark caddy.fs as experimental 2022-07-24 22:32:38 -06:00
Matthew Holt
e14f50d148
Improve docs for file_server and add caddy.fs namespace 2022-07-24 22:29:33 -06:00
bt90
189e456a63
docs: expose 443/udp for HTTP3 support (#250) 2022-07-24 08:46:25 -04:00
Matthew Holt
bb37b39a0e
request_header: Link to proxy header manipulation
For some header fields, it matters that the header manipulation is aware
of the proxying context, for example with hop-by-hop headers.
2022-07-19 12:18:09 -06:00
Matthew Holt
1acf66dd74
docs: Add dhall config adapter 2022-07-14 18:28:59 -06:00
Francis Lavoie
0f35ad14b1
forward_auth: Typo fix, minor clarification callout 2022-07-14 00:25:47 -04:00
Matthew Holt
e8368d6769
caddyfile: Clarify bad query string match behavior 2022-07-13 12:16:54 -06:00
Matthew Holt
6ccb6fff21
cli: Add signal and exit code docs
Also minor tweak to config comparison table
2022-07-12 20:46:25 -06:00
Matt Holt
7819a84e59
2.5.2 docs (#247)
* docs: Changes for v2.5.2 release

* docs: Remove -X POST

Curl automatically uses POST for -d and --data-binary.

I intentionally left it in to be explicit to learners, but
maybe best practices are better.

* api: /adapt endpoint and Etag usage

* api: Minor tweaks

* Alright fine

* Clarify Etag usage

* CEL embedded matchers

* Oops

* Lots more adjustments

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2022-07-12 12:52:18 -06:00
Matthew Holt
52de5be0f8
M1 -> Apple
As there is now an M2 chip announced
2022-06-14 23:14:17 -06:00
Francis Lavoie
655786d85e
docs: Some random polish (#241)
* docs: Some random polish

Just a bunch of little things that I think would help users from frequently asked forum questions.

* Adjustments, fix `tls_server_name` docs

* Update src/docs/markdown/caddyfile/concepts.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-06-06 12:36:50 -06:00
otbutz
8f61c3c71f
reverse_proxy: Document header policy fallback (#237)
* reverse_proxy: Document header policy fallback

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-06-01 16:04:13 -06:00
Francis Lavoie
f6ac9b025e
docs: Changes for v2.5.1 release (#228)
* docs: Changes for v2.5.1 release

* Remove path from addresses doc

* Fix www redirect pattern
2022-05-17 12:32:11 -06:00
Max Truxa
23297691f1
docs: Fix Debian installation instructions (#219)
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2022-05-17 11:05:56 -04:00
Patrycja
2335afaee0
docs: Correct IPv6 syntax in bind directive (#227) 2022-04-25 21:58:27 -04:00
Francis Lavoie
eaf0aae816
docs: More changes for upcoming v2.5.0 release (#226) 2022-04-25 10:51:42 -06:00
Francis Lavoie
35a02d78d7
Bump minimum Go version 2022-04-19 20:59:41 -04:00
Francis Lavoie
0aa19eef44
Elaborate on log formats, proxy headers and examples (#225)
* Elaborate on log formats, proxy headers and examples

* Document HTTP transport resolvers
2022-04-07 11:43:39 -06:00
Bruce Johnson
60323a9e83
file_server: clarify precompressed (#224) 2022-04-01 20:36:24 -04:00
Matt Holt
d0317c0a1c
tls: get_certificates & manager modules (tailscale, http) (#207)
* docs: Add cert getters to tls (tailscale, http)

* Rename "getter" modules to "manager" modules

* Fix ID

* Add note on automatic-https page

* loopback -> local

* Minor tweaks

* Clarify that enabling tailscale is not necessary

* More clarifications
2022-03-17 11:59:08 -06:00
IndeedNotJames
8e6482173f
docs: fix dns_challenge_override_domain typo (#218) 2022-03-14 03:08:45 -04:00
Matthew Holt
31397e9781
caddyfile: Clarify default port 2022-03-12 20:48:47 -07:00
Francis Lavoie
a1ddadf798
Docs for upcoming v2.5.0 release (#216)
* docs: new `log` filters in Caddyfile

* docs: `renew_interval` global option

* docs: Update access log example

* docs: `log_credentials` global option

* docs: `vars`, `vars_regexp` matchers

* docs: `roll_uncompressed`, `roll_local_time`

* docs: `http_redirect` listener wrapper

* docs: `pki` app

* docs: `strict_sni_host` options

* docs: `default_bind` option

* docs: `method` directive

* docs: `tls internal` subdirectives

* Apply suggestions from code review

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* Matchers, options, file_server, reverse_proxy

* More clarifications / corrections

* Corrections from review

* Typo fix

* One more note about dynamic upstreams

* Tab -> space

* Update module namespaces

* Update some docs about logging

* `copy_response`, `copy_response_headers`, `replace_status`

* `dns_challenge_domain_override`

* `caddy trust`, API endpoints

* `trusted_proxies`

* Note about `pass_thru` being only useful inside `route`

* Improve logging docs to clarify the difference

* A bit of polish on patterns

* request_body: Clarify error behavior

* review

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-03-11 14:26:00 -07:00
Andrii Kushch
c734cc3e64
caddyfile: tracing directive (#205)
* Add documentation for tracing directive

* Update header in tracing.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* Update documentation in tracing.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* add link to the repository

* add link to gRPC repo and w3c specification

Co-authored-by: Andrii Kushch <>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-03-09 10:42:06 -07:00
Matthew Holt
55df7ad25d
docs: Add description to Caddyfile index 2022-03-07 23:44:51 -07:00
Francis Lavoie
daafd77ef1
Fix incorrect option name in load balancing 2022-03-07 12:39:19 -05:00
pyfisch
3f97d611b4
Correct inconsistency in ip masking example (#209) 2022-02-03 08:36:51 -05:00
Luo Peng
b01f645d7d
docs: Fix a broken markdown link (#204) 2022-01-17 19:33:13 -07:00
Simon Legner
a9a2bd3ae4
reverse_proxy: document how to strip a path prefix (#203) 2022-01-08 12:43:39 -05:00
Matthew Holt
f15d9b8530
docs: Add SPA common Caddyfile pattern 2022-01-05 13:21:24 -07:00
Francis Lavoie
d57f7319bb
docs: Fix broken markdown link in route directive 2021-12-09 15:43:04 -05:00
Francis Lavoie
ca9b5b0d46
docs: Mention the timeout/buffer defaults for the proxy transports (#199)
Pairs with https://github.com/caddyserver/caddy/pull/4436.

I could split these changes in two, some changes should only land in 2.5.0, but others are pure documentation that could be pushed live now. But 🤷‍♂️ I think it's fine for these to wait until 2.5.0, what's another month or whatever? 😅
2021-12-02 14:07:39 -07:00
Francis Lavoie
903701e154
docs: Adjustments to global options, for clarification (#198)
* docs: Adjustments to global options docs, for clarification

* Apply suggestions from code review

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2021-11-23 09:44:54 -07:00
Francis Lavoie
28e13597de
docs: Elaborate on how the php_fastcgi directive works (#197)
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2021-11-22 15:33:50 -05:00
Jeremy Lin
b4f2b47adc
docs: Update location of default browse template (#196)
Ref: caddyserver/caddy#4417
2021-11-22 12:33:10 -07:00
Francis Lavoie
79521041e8
docs: Emphasize the storage locations when running with systemd 2021-11-20 00:06:38 -05:00
Francis Lavoie
e253d8efc9
docs: Adjustments for v2.4.6 2021-11-08 20:39:44 -05:00
Francis Lavoie
773e99ec6e
docs: Minor updates to "Keep Caddy Running" page 2021-09-25 13:57:25 -04:00
Paulo Vieira
578394fc5f
docs: Mention compression header behaviour in reverse_proxy (#193)
* Update reverse_proxy.md

Documantion says: "By default, Caddy passes thru incoming headers [...], with two exceptions:". But technically there is another another header that is added (if not present): `Accept-Encoding`. 

When the client is a web browser this header should be already set. But for curl or similar tools, that might not be the case.

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Perfect!

Co-authored-by: Francis Lavoie <lavofr@gmail.com>

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2021-09-13 18:35:13 -06:00
Francis Lavoie
c60bf706a1
docs: Update minimum required Go version 2021-09-05 10:45:58 -04:00
Francis Lavoie
1765c8a85e
docs: Fix broken link for logging docs 2021-09-03 22:13:37 -04:00
Mišo Belica
54c1782640
docs: Use correct response header in CORS example (#185)
`Access-Control-Request-Method` is a request header
sent by the client (browser, ...) but we need to send
response header with all allowed methods.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
2021-08-31 13:37:56 -06:00
Francis Lavoie
c5e3aef0a2
docs: Dynamically turn subdirectives into links to anchors (#190)
* docs: Dynamically turn subdirectives into links to anchors

* Make entire rows clickable on directive page's table
2021-08-31 12:50:01 -06:00
Francis Lavoie
3dac36ebc8
docs: Updates for Caddy v2.4.4 (#189)
* docs: Updates for Caddy v2.4.4

* Adjust wording

* Clarify HTTPS proxy usage, reorder lb policies for clarity

* Reorder directives, add comments
2021-08-31 11:39:15 -06:00
Francis Lavoie
83fdd80db1
docs: Fix caddy fmt flag order
Reported in https://caddy.community/t/request-for-update-of-the-usage-of-caddy-fmt-on-the-site/12830
2021-08-25 03:25:57 -04:00
Francis Lavoie
5f09f05e08
docs: Add new "Keep Caddy Running" page, moved from install.md (#181)
* docs: Add new Linux Service page, moved from install.md

* Apply suggestions from code review

Co-authored-by: Carl George <carl@george.computer>

* Add note regarding resetting Exec*

* Updates to make the page more generalized


Docker

* Polish the Windows Service docs a bit

Co-authored-by: Carl George <carl@george.computer>
2021-08-11 17:08:47 -06:00
Matthew Holt
8a8b96dc86
docs: Enhance auto HTTPS page, esp. on-demand TLS 2021-07-28 16:56:35 -06:00
Tobias Gruetzmacher
275cce9403
docs: Add Windows service instructions (#176) 2021-07-19 08:07:20 -06:00