Skip to content

Commit 9579f19

Browse files
matthew1001matthew1001
committed
Update docs
Signed-off-by: Matthew Whitehead <[email protected]>
1 parent d9a32c4 commit 9579f19

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

‎config.md

+39
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,14 @@
3131

3232
|Key|Description|Type|Default Value|
3333
|---|-----------|----|-------------|
34+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
3435
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
36+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
3537
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
3638
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
3739
|enabled|Enables or disables TLS on this API|`boolean`|`false`
3840
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
41+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
3942
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
4043
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
4144

@@ -98,11 +101,14 @@
98101

99102
|Key|Description|Type|Default Value|
100103
|---|-----------|----|-------------|
104+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
101105
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
106+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
102107
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
103108
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
104109
|enabled|Enables or disables TLS on this API|`boolean`|`false`
105110
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
111+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
106112
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
107113
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
108114

@@ -193,11 +199,14 @@
193199

194200
|Key|Description|Type|Default Value|
195201
|---|-----------|----|-------------|
202+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
196203
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
204+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
197205
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
198206
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
199207
|enabled|Enables or disables TLS on this API|`boolean`|`false`
200208
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
209+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
201210
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
202211
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
203212

@@ -298,15 +307,25 @@
298307
|initWaitTime|The initial retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`<nil>`
299308
|maxWaitTime|The maximum retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`<nil>`
300309

310+
## policyengine.simple.gasOracle.throttle
311+
312+
|Key|Description|Type|Default Value|
313+
|---|-----------|----|-------------|
314+
|burst|The maximum number of requests that can be made in a short period of time before the throttling kicks in.|`int`|`<nil>`
315+
|requestsPerSecond|The average rate at which requests are allowed to pass through over time.|`int`|`<nil>`
316+
301317
## policyengine.simple.gasOracle.tls
302318

303319
|Key|Description|Type|Default Value|
304320
|---|-----------|----|-------------|
321+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
305322
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
323+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
306324
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
307325
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
308326
|enabled|Enables or disables TLS on this API|`boolean`|`<nil>`
309327
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
328+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
310329
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
311330
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
312331

@@ -389,15 +408,25 @@
389408
|initWaitTime|The initial retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`<nil>`
390409
|maxWaitTime|The maximum retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`<nil>`
391410

411+
## transactions.handler.simple.gasOracle.throttle
412+
413+
|Key|Description|Type|Default Value|
414+
|---|-----------|----|-------------|
415+
|burst|The maximum number of requests that can be made in a short period of time before the throttling kicks in.|`int`|`<nil>`
416+
|requestsPerSecond|The average rate at which requests are allowed to pass through over time.|`int`|`<nil>`
417+
392418
## transactions.handler.simple.gasOracle.tls
393419

394420
|Key|Description|Type|Default Value|
395421
|---|-----------|----|-------------|
422+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
396423
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
424+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
397425
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
398426
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
399427
|enabled|Enables or disables TLS on this API|`boolean`|`<nil>`
400428
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
429+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
401430
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
402431
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
403432

@@ -447,14 +476,24 @@
447476
|initWaitTime|The initial retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`250ms`
448477
|maxWaitTime|The maximum retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
449478

479+
## webhooks.throttle
480+
481+
|Key|Description|Type|Default Value|
482+
|---|-----------|----|-------------|
483+
|burst|The maximum number of requests that can be made in a short period of time before the throttling kicks in.|`int`|`<nil>`
484+
|requestsPerSecond|The average rate at which requests are allowed to pass through over time.|`int`|`<nil>`
485+
450486
## webhooks.tls
451487

452488
|Key|Description|Type|Default Value|
453489
|---|-----------|----|-------------|
490+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
454491
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
492+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
455493
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
456494
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
457495
|enabled|Enables or disables TLS on this API|`boolean`|`false`
458496
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
497+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
459498
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
460499
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`

0 commit comments

Comments
 (0)