Commit graph

179 commits

Author SHA1 Message Date
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
Francis Lavoie
d3013905cb
docs: Add map regexp capture groups (#145)
https://github.com/caddyserver/caddy/pull/3991

The `outputs` bit was getting a bit long so I split it up into multiple paragraphs.

The capture group explanation is copied from the `path_regexp` matcher docs.

Added bullets in front of the example cases, because the newlines get collapsed in markdown otherwise, unless we either add bullets or double newlines. I think bullets work better here.
2021-04-05 15:20:09 -06:00
Christian Rebischke
b3381f9f5c
docs: mention caddy on Arch Linux (#150) 2021-04-05 13:31:03 -06:00
Matthew Holt
caede64af5
docs: Minor improvements 2021-02-24 11:29:17 -07:00
Kyle Johnston
23e40421c0
docs: Update upgrade guide
* Update Caddy 2 plugin instructions

The website said there is no interactive download page, but there is
now. Updated documentation to reflect this.

* Fix broken link to main.go

* Change xcaddy link to current build docs
2021-02-22 14:42:05 -07:00
Francis Lavoie
3f3e0fb9f8
docs: Some cleanup, some v2.4.0 additions (#139)
* docs: Some cleanup, some v2.4.0 additions

- Add `abort` directive docs
- Add a note in `handle` to cross-link to `handle_path`
- Add another example in `handle_errors` that shows how an `expression` matcher can be used to pair with it
- Add a cat emoji to handle_errors because 😸
- Add `file_server` to one of the `php_fastcgi` examples, it's rare that you'll ever use it without `file_server` so might as well include it there
- Add a TOC to `reverse_proxy` cause it's such a long page. Maybe we'll add one to other pages as well, but TBD
- Clarify the upstream address stuff a bit after some discussion in https://caddy.community/t/reverse-proxy-with-multiple-different-upstreams-with-paths/11512/12 and mention `rewrite` as the alternative
- Use the `{re.*.*}` shortcut in the Caddyfile matcher docs, links to the placeholder mapping to let people trace where that comes from

* docs: Revise the `handle` cross-linking, add another example

* docs: Bump minimum Go version to 1.15

* docs: A bunch more additions since v2.3.0

I went through the whole list of commits here: https://github.com/caddyserver/caddy/compare/v2.3.0...ec3ac84

* docs: Review feedback

* docs: Link to https://golang.org/doc/install, better instructions
2021-02-22 13:11:21 -07:00
Francis Lavoie
0f4885e592
docs: Fix tee command for debian instructions
`tee -a` makes no sense here, we don't want to append, overwriting is just fine
2021-02-21 02:10:21 -05:00
Matthew Holt
57b3739a21
docs: Various updates for 2.3, 2.4 beta, and Go 1.16
Steps on #139 (sorry)
2021-02-17 11:34:28 -07:00
Francis Lavoie
2e255b1ee3
docs: Shorten cloudsmith URLs even more!
Thanks to @lskillen https://github.com/caddyserver/website/issues/134#issuecomment-775217805
2021-02-08 10:39:20 -05:00
Francis Lavoie
930109ec33
docs: Simplify the cloudsmith URL a bit more
https://github.com/caddyserver/website/issues/134#issuecomment-773271563
2021-02-04 07:36:02 -05:00
Francis Lavoie
dd3285e824
docs: Fix Cloudsmith paths (#135)
Fix #134 

I'm not sure why the old GPG path broke, but apparently it did... but the paths are shorter now, so that's nice.
2021-02-02 17:25:31 -07:00
Francis Lavoie
b33d40f15c
docs: Shorten the try_files expanded form too (#133) 2021-02-02 13:11:31 -07:00
Francis Lavoie
74db4350eb
docs: Shorten the php_fastcgi expanded form a bit (#131)
Just making use of the matcher shortcuts we have available to make it look a little less fluffy.
2021-01-27 11:32:30 -07:00
Luo Peng
a8700f7a04
docs: caddyfile: Minor grammar fix (closes #126) (#127) 2021-01-15 10:26:22 -07:00
Klooven
1019b7be50
docs: Escape < and > characters (#125) 2021-01-07 07:06:52 -07:00
Francis Lavoie
5d4674e57b
docs: Update .deb docs for Cloudsmith (#124) 2020-12-31 12:01:16 -07:00
Dave Henderson
54d309cc34
docs: metrics directive: Document disable_openmetrics (#123)
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
2020-12-30 11:01:37 -07:00
Matthew Holt
01140e3f75
docs: Minor tweaks 2020-12-30 09:33:31 -07:00
Matthew Holt
4827cff659
docs: Update for v2.3; refactor install information
We now have only 1 download page, yay. Install docs are organized better. Less confusing.

Automatic HTTPS docs improved, and menu added.

Other minor updates to bring up to speed for v2.3.
2020-12-30 07:37:15 -07:00
Matthew Holt
9dd9309a9b
docs: Add map directive 2020-12-14 18:25:35 -07:00
Matthew Holt
e63739891c docs: Update remote_ip matcher 2020-12-12 12:28:15 -07:00
Matthew Holt
bc7f8553c3 docs: Add chocolatey package
Closes https://github.com/caddyserver/dist/issues/51
2020-12-12 12:28:15 -07:00
Jordi Masip
4ca7b193d1
docs: --config flag supports - to read from stdin (#120) 2020-12-03 11:18:59 -07:00
Francis Lavoie
a05f559c12
docs: Update reverse_proxy examples (#119)
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-12-02 13:38:23 -05:00
Francis Lavoie
e2a6e4e212
docs: Mention the auth placeholder in basicauth docs (#117) 2020-11-26 12:20:14 -07:00
Matthew Holt
bb0693bb7d
docs: Clarify debian package behavior (closes #115) 2020-11-25 10:51:19 -07:00
Matthew Holt
94a7c5f1cd docs: Minor improvements/clarifications 2020-11-25 10:47:01 -07:00
Gilbert Gilb's
8084cba78b
docs: header default values (#98)
see https://github.com/caddyserver/caddy/pull/3807
2020-11-24 15:32:42 -07:00
Francis Lavoie
b95745040b
docs: Update adapters list, directive order note in caddyfile concepts (#97) 2020-11-24 15:28:31 -07:00
Francis Lavoie
bc64f3acc0
docs: Add missing proxy and fastcgi options (#108)
* docs: Add missing proxy and fastcgi options

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

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

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

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

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

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-11-24 15:19:46 -07:00
Francis Lavoie
e20ab56bf2
docs: Add caddyfile server options, reorganize the page a bit (#107)
* docs: Add caddyfile server options, reorganize the page a bit

* 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>
2020-11-24 15:18:57 -07:00
Francis Lavoie
3045d99f94
docs: Clarify behaviour of multiple matchers of the same type (#102)
* docs: Clarify behaviour of multiple matchers of the same type

* Apply suggestions from code review

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

* docs: Change matcher boolean wording

* 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>
2020-11-24 14:44:21 -07:00