Skip to content

Commit b069b43

Browse files
update reference.json (#458)
Co-authored-by: ryepup <40441+ryepup@users.noreply.github.com>
1 parent 0ae98cc commit b069b43

File tree

3 files changed

+43
-11
lines changed

3 files changed

+43
-11
lines changed

reference-lib/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference-lib/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nginx/reference-lib",
3-
"version": "1.1.18",
3+
"version": "1.1.19",
44
"description": "",
55
"main": "dist/index.js",
66
"type": "module",

reference-lib/src/reference.json

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@
7777
"<p><em><code>uri</code></em></p>\n"
7878
],
7979
"isBlock": false,
80-
"description_md": "The\n[directory URL](https://www.rfc-editor.org/rfc/rfc8555#section-7.1.1)\nof the ACME server.\nThis directive is mandatory.",
81-
"description_html": "<p>The\n<a href=\"https://www.rfc-editor.org/rfc/rfc8555#section-7.1.1\" target=\"_blank\">directory URL</a>\nof the ACME server.\nThis directive is mandatory.</p>\n"
80+
"description_md": "The\n[directory URL](https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1)\nof the ACME server.\nThis directive is mandatory.",
81+
"description_html": "<p>The\n<a href=\"https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1\" target=\"_blank\">directory URL</a>\nof the ACME server.\nThis directive is mandatory.</p>\n"
8282
},
8383
{
8484
"name": "account_key",
@@ -96,6 +96,22 @@
9696
"description_md": "The account's private key used for request authentication.\n\nAccepted values:\n- `ecdsa`:*`256`*/*`384`*/*`521`*\n for ES256, ES384, or ES512 JSON Web Signature algorithms\n- `rsa`:*`2048`*/*`3072`*/*`4096`*\n for RS256.\n- File path for an existing key, using one of the algorithms above.\n\nThe generated account keys are preserved across reloads,\nbut will be lost on restart unless [`state_path`](https://nginx.org/en/docs/http/ngx_http_acme_module.html#state_path) is configured.",
9797
"description_html": "<p>The account&rsquo;s private key used for request authentication.</p>\n\n<p>Accepted values:</p>\n\n<ul>\n<li><code>ecdsa</code>:<em><code>256</code></em>/<em><code>384</code></em>/<em><code>521</code></em>\nfor ES256, ES384, or ES512 JSON Web Signature algorithms</li>\n<li><code>rsa</code>:<em><code>2048</code></em>/<em><code>3072</code></em>/<em><code>4096</code></em>\nfor RS256.</li>\n<li>File path for an existing key, using one of the algorithms above.</li>\n</ul>\n\n<p>The generated account keys are preserved across reloads,\nbut will be lost on restart unless <a href=\"https://nginx.org/en/docs/http/ngx_http_acme_module.html#state_path\" target=\"_blank\"><code>state_path</code></a> is configured.</p>\n"
9898
},
99+
{
100+
"name": "challenge",
101+
"default": "http-01",
102+
"contexts": [
103+
"acme_issuer"
104+
],
105+
"syntax_md": [
106+
"*`type`*"
107+
],
108+
"syntax_html": [
109+
"<p><em><code>type</code></em></p>\n"
110+
],
111+
"isBlock": false,
112+
"description_md": "Specifies the ACME challenge type to be used for the issuer.\n\nAccepted values:\n- `http-01` (`http`)\n- `tls-alpn-01` (`tls-alpn`)\n\n> ACME challenges are versioned.\n> If an unversioned name is specified,\n> the module automatically selects the latest implemented version.",
113+
"description_html": "<p>Specifies the ACME challenge type to be used for the issuer.</p>\n\n<p>Accepted values:</p>\n\n<ul>\n<li><code>http-01</code> (<code>http</code>)</li>\n<li><code>tls-alpn-01</code> (<code>tls-alpn</code>)</li>\n</ul>\n\n<blockquote>\n<p>ACME challenges are versioned.\nIf an unversioned name is specified,\nthe module automatically selects the latest implemented version.</p>\n</blockquote>\n"
114+
},
99115
{
100116
"name": "contact",
101117
"default": "",
@@ -112,6 +128,22 @@
112128
"description_md": "Sets an array of URLs that the ACME server can use\nto contact the client regarding account issues.\nThe `mailto:` scheme will be used\nunless specified explicitly.",
113129
"description_html": "<p>Sets an array of URLs that the ACME server can use\nto contact the client regarding account issues.\nThe <code>mailto:</code> scheme will be used\nunless specified explicitly.</p>\n"
114130
},
131+
{
132+
"name": "external_account_key",
133+
"default": "",
134+
"contexts": [
135+
"acme_issuer"
136+
],
137+
"syntax_md": [
138+
"*`kid`* *`file`*"
139+
],
140+
"syntax_html": [
141+
"<p><em><code>kid</code></em> <em><code>file</code></em></p>\n"
142+
],
143+
"isBlock": false,
144+
"description_md": "Specifies a key identifier *`kid`* and a *`file`*\nwith the MAC key for\n[ external account authorization](https://datatracker.ietf.org/doc/html/rfc8555#section-7.3.4).\n\nThe value `data`:*`key`* can be specified\ninstead of the *`file`*, which loads a key directly from\nthe configuration without using intermediate files.\n\nIn both cases, the key is expected to be encoded in\n[ base64url](https://datatracker.ietf.org/doc/html/rfc4648#section-5).",
145+
"description_html": "<p>Specifies a key identifier <em><code>kid</code></em> and a <em><code>file</code></em>\nwith the MAC key for\n<a href=\"https://datatracker.ietf.org/doc/html/rfc8555#section-7.3.4\" target=\"_blank\"> external account authorization</a>.</p>\n\n<p>The value <code>data</code>:<em><code>key</code></em> can be specified\ninstead of the <em><code>file</code></em>, which loads a key directly from\nthe configuration without using intermediate files.</p>\n\n<p>In both cases, the key is expected to be encoded in\n<a href=\"https://datatracker.ietf.org/doc/html/rfc4648#section-5\" target=\"_blank\"> base64url</a>.</p>\n"
146+
},
115147
{
116148
"name": "ssl_trusted_certificate",
117149
"default": "",
@@ -146,19 +178,19 @@
146178
},
147179
{
148180
"name": "state_path",
149-
"default": "",
181+
"default": "acme_<issuer>",
150182
"contexts": [
151183
"acme_issuer"
152184
],
153185
"syntax_md": [
154-
"*`path`*"
186+
"*`path`* | `off`"
155187
],
156188
"syntax_html": [
157-
"<p><em><code>path</code></em></p>\n"
189+
"<p><em><code>path</code></em> | <code>off</code></p>\n"
158190
],
159191
"isBlock": false,
160-
"description_md": "Defines a directory for storing the module data\nthat can be persisted across restarts.\nThis can improve the load time by skipping some requests on startup,\nand avoid hitting request rate limits on the ACME server.\n\nThe directory contains sensitive content, such as\nthe account key, issued certificates, and private keys.",
161-
"description_html": "<p>Defines a directory for storing the module data\nthat can be persisted across restarts.\nThis can improve the load time by skipping some requests on startup,\nand avoid hitting request rate limits on the ACME server.</p>\n\n<p>The directory contains sensitive content, such as\nthe account key, issued certificates, and private keys.</p>\n"
192+
"description_md": "Defines a directory for storing the module data\nthat can be persisted across restarts.\nThis can improve the load time by skipping some requests on startup,\nand avoid hitting request rate limits on the ACME server.\n\nThe directory contains sensitive content, such as\nthe account key, issued certificates, and private keys.\n\nThe `off` parameter (0.2.0) disables storing the account\ninformation and issued certificates on disk.\n\n> Prior to version 0.2.0, the state directory was not created by default.",
193+
"description_html": "<p>Defines a directory for storing the module data\nthat can be persisted across restarts.\nThis can improve the load time by skipping some requests on startup,\nand avoid hitting request rate limits on the ACME server.</p>\n\n<p>The directory contains sensitive content, such as\nthe account key, issued certificates, and private keys.</p>\n\n<p>The <code>off</code> parameter (0.2.0) disables storing the account\ninformation and issued certificates on disk.</p>\n\n<blockquote>\n<p>Prior to version 0.2.0, the state directory was not created by default.</p>\n</blockquote>\n"
162194
},
163195
{
164196
"name": "accept_terms_of_service",
@@ -17346,5 +17378,5 @@
1734617378
]
1734717379
}
1734817380
],
17349-
"version": "https://github.com/nginx/nginx.org/commit/8f7b354b3593482446c9ef7e24dc84686c5cba60"
17381+
"version": "https://github.com/nginx/nginx.org/commit/a42f51d66b765d47e9048b9d9646aaf1084a2b09"
1735017382
}

0 commit comments

Comments
 (0)