Commit graph

46 commits

Author SHA1 Message Date
Francis Lavoie
d931345756
Docs for v2.7.2 2023-08-03 00:57:37 -04:00
Francis Lavoie
194beebc7c
Docs for v2.7.0 (#322)
* Docs for v2.7.0

* Document named-routes & invoke, polish reverse_proxy

* Storage import/export CLI docs

* Header replacement defer

* Proxy stream closing options, weighted round robin LB policy
2023-07-17 01:20:40 -04:00
Matthew Holt
863c53c95e
Remind about --address flag 2023-05-08 16:28:00 -06:00
Francis Lavoie
6062f09000
global: Fix mistake with grace_period, default is eternal #319 2023-05-08 12:20:32 -04:00
Francis Lavoie
0a651be3d5
global: Clarify grace_period #319 2023-05-08 12:08:27 -04:00
Duncan Ogilvie
4fdc7ccf2f
caddyfile: Add clarification to acme_ca about .local TLDs (#317)
* Add clarification to `acme_ca` about `.local` TLDs

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

---------

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2023-05-03 10:00:04 -06:00
Francis Lavoie
6c6d933163
typo: Remove extra word 2023-03-07 10:59:22 -05:00
Francis Lavoie
ba15222b97
typo: Fix trailing slash on JSON docs link 2023-02-25 19:52:03 -05:00
Daniel Santos
3bc711fd62
options: Add note about server listener_address matching (#297)
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2023-02-10 04:16:58 -05:00
Francis Lavoie
7c99a9ab17
Docs for v2.6.3 (#296) 2023-02-08 17:10:09 -05:00
Daniel Santos
24d9769d61
globalopts: Add servers name (#292)
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2023-02-08 02:22:25 -05:00
Francis Lavoie
af9bd2e5c3
Add workaround note for default_bind 2023-01-21 21:38:24 -05:00
Kyle McCullough
a2742d8d8d
pki: document certificate lifetime options (#283)
Signed-off-by: Kyle McCullough <kylemcc@gmail.com>

Signed-off-by: Kyle McCullough <kylemcc@gmail.com>
2022-12-06 18:53:42 -07:00
Jiehong
fed989d550
caddyfile: Add info about include/exclude logs (#260) (#262) 2022-12-05 14:38:53 -07:00
Francis Lavoie
af47d0574b
docs: Various updates since 2.5.2 that got missed (#274)
* docs: Various updates since 2.5.2 that got missed

* Cleanup protocols global options

* Sort caddyfile placeholder shortcuts alphabetically for now
2022-10-17 11:23:48 -06:00
Matthew Holt
685dfc83c1
docs: Update info about metrics for 2.6
Also add events.handlers namespace and fix dhall link.
2022-09-20 13:27:27 -06:00
Matthew Holt
2ab3061111
Update docs for 2.6 2022-09-06 13:57:07 -06:00
Ben Burkert
c90c151730
caddyfile: document ocsp interval global option (#254) 2022-08-24 11:33:02 -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
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
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
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
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
1765c8a85e
docs: Fix broken link for logging docs 2021-09-03 22:13:37 -04: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
639c76b54c
docs: Add skip_install_trust global option (#171) 2021-06-15 14:10:28 -06:00
Klooven
1957b7f536
docs: caddyfile: preferred_chains issuer and global config (#169) 2021-06-09 09:53:50 -06:00
Matthew Holt
10f700ad19
docs: A few more updates for v2.4.0 2021-05-10 13:43:20 -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
xpetit
332282e548
docs: Fix global timeouts labels (#161) 2021-04-28 11:32:39 -04: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
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
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
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
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
6b4998a5dc
docs: Use headers for individual global options, anchor linkable (#100) 2020-11-12 15:54:37 -05:00
Matthew Holt
af3676862b
docs: Update for v2.2 2020-09-25 12:53:11 -06:00
Flavio Stutz
1de532a465
docs: Add link from auto_https option to Auto HTTPS doc (#76)
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2020-08-16 02:44:21 -04:00
Matthew Holt
db18a5d4c8
docs: Numerous various updates for v2.1 2020-06-08 14:56:20 -06:00
Francis Lavoie
e0f5ee1bb9
docs: Add Caddyfile syntax highlighting (#41) 2020-05-17 14:32:12 -06:00
Matthew Holt
8e7b3b81d0
docs: Update for rc2 2020-04-09 17:32:50 -06:00
Matthew Holt
1ff0134570
docs: Clarifications about admin endpoint and reload command
See https://github.com/caddyserver/caddy/issues/3234
2020-04-07 07:46:08 -06:00
Matthew Holt
6f712d4ee4
docs: General updates for beta 18 2020-03-21 21:03:55 -06:00
Matthew Holt
5cf7dc8c93
Update for beta 17 2020-03-14 10:38:42 -06:00
Matthew Holt
aea9c986d1
docs: Update for beta 15 2020-02-28 11:16:45 -07:00
Matthew Holt
03b6fddeb0
Initial commit 2020-01-24 12:47:52 -07:00