Commit graph

260 commits

Author SHA1 Message Date
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
7c2519209c
Minor tweaks
Link to Twitter is needed for account verification
2022-03-08 15:05:57 -07:00
Matthew Holt
2fb9ef5f23
js: Fix nonstandard module box display
Dunno why show() stopped working, but oh well
2022-03-08 15:05:57 -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
Mikhail
ec2cf03fad
Use subdirs for includes (#212) 2022-02-09 12:30:58 -07: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
Matthew Holt
f3f21afac0 Improve docs hovercard and nonstandard notice 2021-10-12 14:51:49 -06:00
Francis Lavoie
773e99ec6e
docs: Minor updates to "Keep Caddy Running" page 2021-09-25 13:57:25 -04:00
Matthew Holt
28eac39c29
docs: Return 404 for bad paths
Requires Caddy compiled with Go 1.17 or newer.
2021-09-15 11:57:02 -06: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
a7861e98f7
js: Default to linux-amd64 and fix split() call on platform (#187)
In certain cases where the platform cannot be automatically determined, we should at least populate a default so that the download page doesn't break.
2021-08-13 14:59:45 -06: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
Tobias Gruetzmacher
8fded0b38e
docs: Remove usage of apt-key (#177) 2021-07-12 10:56:34 -06:00
Nya Meteor
5b216fea49
docs: Fix an incorrect URL (route) (#184) 2021-07-12 10:31:25 -04:00
Jon Cram
60bc4ee7c3
docs: reverse_proxy typo "tranport" -> "transport" (#182)
The reverse_proxy directive docs contained a TOC featuring the line "The fastcgi tranport". Changed "tranport" to "transport".
2021-07-07 10:20:59 -04:00
Francis Lavoie
56e1517c0f
docs: Move key_type to the correct place, minor adjustments 2021-07-01 19:10:05 -04:00
Daniel Abromeit aka Abro
e24691fe37
docs: Fix two little typos (header, metrics) (#179) 2021-07-01 12:39:27 -04:00
Basil Hendroff
10a4514785
docs: Update command-line.md TOC (#174)
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2021-06-30 01:49:23 -04:00
Francis Lavoie
1a8d8fbee6
docs: Add scoop to install TOC 2021-06-30 01:47:26 -04:00
YAKSH BARIYA
9930120849
docs: Caddy is also available on Termux (#170) 2021-06-30 01:46:05 -04:00
Francis Lavoie
1ff5103c73
docs: Clarify uri syntax, replacement variables (#173)
- The syntax definition was confusing because it was mixing one-of options and optional arguments which are only relevant for certain options.

- Add notes about replacement capture groups. Wording could probably be improved here. Point is, capture groups are supported, using Golang's syntax (doesn't use Caddy's placeholder syntax, which can be a gotcha)

- Add similar directives section, mainly to point out that `handle_path` can be used instead in many situations to save a line. The note about `rewrite` is kinda redundant with the small paragraph at the top though. Should we move that explanation down into `Similar directives`?
2021-06-21 11:50:32 -06:00
Matthew Holt
75869ca9f3
docs: Update welcome page 2021-06-17 16:08:18 -06:00
Matthew Holt
85dbc186c2
docs: Minor updates to file_server and reverse_proxy 2021-06-17 14:12:56 -06:00
Francis Lavoie
639c76b54c
docs: Add skip_install_trust global option (#171) 2021-06-15 14:10:28 -06:00
Francis Lavoie
fb298b3317
docs: Add propagation_timeout to tls issuer options (#172) 2021-06-15 14:10:08 -06:00
Klooven
1957b7f536
docs: caddyfile: preferred_chains issuer and global config (#169) 2021-06-09 09:53:50 -06:00
favonia
4491b9ef3b
docs: tls: revise doc of trusted_* directives (#168)
1. The *_file directives expects a regular PEM file, not a DER- or base64-encoded one.
2. The rejection condition was condensed.
2021-06-07 12:24:27 -06:00
Matthew Holt
e132c5c454
docs: Better support for module name collisions
In /docs/modules/, show both modules if module IDs are not globally unique.
Show both modules' docs on same page in expandable containers.

In /docs/json/, both modules appear in lists in the doc, but disambiguating them isn't implemented yet.
2021-06-02 15:16:15 -06:00