Commit graph

538 commits

Author SHA1 Message Date
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
Matthew Holt
5c3a67692e
New download page, better JSON/module docs 2021-05-25 17:26:54 -06:00
Matthew Holt
09c3a73299
docs: dial_timeout for log net writer
And minor fix for reverse proxy example
2021-05-25 17:26:54 -06:00
Cassiano Aquino
64990cf8c4
add custom binary support files docs (#141)
* add custom binary support files docs

rephrase

* Update src/docs/markdown/build.md

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

* add link to build on package docs

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2021-05-19 23:25:45 -06:00
Mohammed Al Sahaf
2827d46774
Fix example of rewrite in handle_response (#166) 2021-05-14 07:52:53 -04:00
Francis Lavoie
e30f3f8330
docs: Fixup handle_response for fixes landing in 2.4.1 (#165) 2021-05-13 11:11:10 -06:00
Francis Lavoie
9b4599eec9
docs: A few fixes, one more example (#164)
- Change wildcard certs patterns from h3 to h2 header
- Clean up `encode.md` a bit
- Add TOC entry for `handle_response`
- Add response matcher docs for `handle_response` (copied from `encode.md`)
- Add example for `handle_response` for handling by status code
2021-05-12 13:21:32 -06:00
Arthur T
25742214dc
docs: Import arguments (#162)
* Added documentation for snippet arguments

Added documentation, the only resource available for this feature, a post on the forum and the PR : https://github.com/caddyserver/caddy/pull/3423

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

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

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

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

* Change for more generic example

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

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2021-05-11 15:58:38 -06:00
Mohammed Al Sahaf
a1bc26c553
docs: Remove accidental backtick (#163)
"We don't make mistakes -- we just have happy accidents." ~ Bob Ross
2021-05-10 15:59:39 -04:00
Matthew Holt
10f700ad19
docs: A few more updates for v2.4.0 2021-05-10 13:43:20 -06:00
Francis Lavoie
a223b5ed55
docs: Warn about the behaviour of ? in multi-line header handlers (#155)
* docs: Warn about the behaviour of `?` in multi-line `header` handlers

* 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-05-02 12:51:11 -06:00
Francis Lavoie
c1383e7981
docs: status option for file_server, health_uri for reverse_proxy (#156) 2021-05-02 12:19:48 -06:00
Francis Lavoie
452537adea
docs: Add stoage_clean_interval global option (#158)
Docs for https://github.com/caddyserver/caddy/pull/4134
2021-05-02 12:19:05 -06:00
Francis Lavoie
fb2a712dbe
docs: Add /reverse_proxy/upstreams API docs (#157)
* docs: Add /reverse_proxy/upstreams API docs

* Update src/docs/markdown/api.md

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

* Apply suggestions from code review

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

* typo: upsteam -> upstream

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2021-05-02 12:18:35 -06:00
xpetit
332282e548
docs: Fix global timeouts labels (#161) 2021-04-28 11:32:39 -04:00
Francis Lavoie
975e06ee99
docs: Add php_fastcgi's index off option (#160)
I somehow forgot to add this to the docs when I implemented it a while back. Someone asked a question on the forums where this was the solution, and I noticed it wasn't documented.
2021-04-27 18:53:13 -06:00
Francis Lavoie
6d648596ee
docs: Clarify file_server behaviour inside handle_errors (#159)
This was part of https://github.com/caddyserver/website/pull/154 which was incorrect, but I realized I had this part in it which is still relevant to keep.
2021-04-26 16:07:04 -04:00
Francis Lavoie
6518711538
docs: Add wildcard certificates common pattern (#142)
We did recently add a similar example to the `abort` directive docs, but I feel this is a good fit in this page as well since it's a commonly repeated pattern we respond with when answering forum questions.
2021-04-16 11:39:03 -06:00
Francis Lavoie
9dc0156ceb
docs: Add error caddyfile directive (#143)
Docs for the new directive in https://github.com/caddyserver/caddy/pull/4034.

Also adding a bit in `handle_errors` mentioning that `reverse_proxy` doesn't trigger errors when a response has an "error" HTTP status; not sure how to word this clearly, cause `reverse_proxy` still can trigger errors if there's no upstream or whatever. We should probably add examples for that later, and augment this paragraph to mention `handle_response` once that's merged (https://github.com/caddyserver/caddy/pull/4021)
2021-04-16 11:37:53 -06:00
Francis Lavoie
b0324a9470
docs: Add path_regexp option for uri directive (#144)
ad8d01cb66
2021-04-16 11:36:54 -06:00
Kévin Dunglas
371993227e
docs: explain how to disabl FLoC (#152) 2021-04-16 11:36:28 -06:00
Aaron Taylor
bd9d8eaf71
docs: add replace log format directive, global log option (#147)
* caddyfile/directives/log: add docs for new replace directive

This commit corresponds with the functionality added in this PR:
https://github.com/caddyserver/caddy/pull/4029

* caddyfile: add documentation for new global log option

This corresponds with the changes in this PR:
https://github.com/caddyserver/caddy/pull/4028
2021-04-08 12:29:15 -06:00
Steffen Brüheim
f01036964f
docs: encode and file_server enhancements (content negotiation) (#148)
* docs: encode: add new subdirectives

* minimum_length
* prefer
* match

* docs: file_server: add precompressed subdirectives
2021-04-05 15:24:54 -06:00