mirror of
https://github.com/caddyserver/website.git
synced 2025-04-23 13:36:16 -04:00
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>
This commit is contained in:
parent
c734cc3e64
commit
a1ddadf798
19 changed files with 575 additions and 157 deletions
|
@ -42,6 +42,12 @@ To get started with the API, try our [API tutorial](/docs/api-tutorial) or, if y
|
|||
- **[Using `@id` in JSON](#using-id-in-json)**
|
||||
Easily traverse into the config structure
|
||||
|
||||
- **[GET /pki/ca/<id>](#get-pkicaid)**
|
||||
Returns information about a particular [PKI app](/docs/json/apps/pki/) CA
|
||||
|
||||
- **[GET /pki/ca/<id>/certificates](#get-pkicaidcertificates)**
|
||||
Returns the certificate chain of a particular [PKI app](/docs/json/apps/pki/) CA
|
||||
|
||||
- **[GET /reverse_proxy/upstreams](#get-reverse-proxyupstreams)**
|
||||
Returns the current status of the configured proxy upstreams
|
||||
|
||||
|
@ -232,6 +238,40 @@ but with an ID, the path becomes
|
|||
which is much easier to remember and write by hand.
|
||||
|
||||
|
||||
## GET /pki/ca/<id>
|
||||
|
||||
Returns information about a particular [PKI app](/docs/json/apps/pki/) CA by its ID. If the requested CA ID is the default (`local`), then the CA will be provisioned if it has not already been. Other CA IDs will return an error if they have not been previously provisioned.
|
||||
|
||||
<pre><code class="cmd"><span class="bash">curl "http://localhost:2019/pki/ca/local" | jq</span>
|
||||
{
|
||||
"id": "local",
|
||||
"name": "Caddy Local Authority",
|
||||
"root_common_name": "Caddy Local Authority - 2022 ECC Root",
|
||||
"intermediate_common_name": "Caddy Local Authority - ECC Intermediate",
|
||||
"root_certificate": "-----BEGIN CERTIFICATE-----\nMIIB ... gRw==\n-----END CERTIFICATE-----\n",
|
||||
"intermediate_certificate": "-----BEGIN CERTIFICATE-----\nMIIB ... FzQ==\n-----END CERTIFICATE-----\n"
|
||||
}</code></pre>
|
||||
|
||||
|
||||
## GET /pki/ca/<id>/certificates
|
||||
|
||||
Returns the certificate chain of a particular [PKI app](/docs/json/apps/pki/) CA by its ID. If the requested CA ID is the default (`local`), then the CA will be provisioned if it has not already been. Other CA IDs will return an error if they have not been previously provisioned.
|
||||
|
||||
This endpoint is used internally by the [`caddy trust`](/docs/command-line#caddy-trust) command to allow installing the CA's root certificate to your system's trust store.
|
||||
|
||||
<pre><code class="cmd"><span class="bash">curl "http://localhost:2019/pki/ca/local/certificates"</span>
|
||||
-----BEGIN CERTIFICATE-----
|
||||
MIIByDCCAW2gAwIBAgIQViS12trTXBS/nyxy7Zg9JDAKBggqhkjOPQQDAjAwMS4w
|
||||
...
|
||||
By75JkP6C14OfU733oElfDUMa5ctbMY53rWFzQ==
|
||||
-----END CERTIFICATE-----
|
||||
-----BEGIN CERTIFICATE-----
|
||||
MIIBpDCCAUmgAwIBAgIQTS5a+3LUKNxC6qN3ZDR8bDAKBggqhkjOPQQDAjAwMS4w
|
||||
...
|
||||
9M9t0FwCIQCAlUr4ZlFzHE/3K6dARYKusR1ck4A3MtucSSyar6lgRw==
|
||||
-----END CERTIFICATE-----</code></pre>
|
||||
|
||||
|
||||
## GET /reverse_proxy/upstreams
|
||||
|
||||
Returns the current status of the configured reverse proxy upstreams (backends) as a JSON document.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue