From 56de8a7d8ecfb52c0aa8ccc137875dd091eee0ad Mon Sep 17 00:00:00 2001 From: nguyer Date: Thu, 11 Jan 2024 19:22:29 +0000 Subject: [PATCH] deploy: 6a1a97760c17f3e6218b7b57be4b706c726c8bd5 --- head/assets/js/search-data.json | 64 +++---- head/contributors/dev_environment_setup.html | 2 +- head/reference/config.html | 186 +++++++++++++++++++ 3 files changed, 219 insertions(+), 33 deletions(-) diff --git a/head/assets/js/search-data.json b/head/assets/js/search-data.json index 1d0a9b45d..1ef5d2506 100644 --- a/head/assets/js/search-data.json +++ b/head/assets/js/search-data.json @@ -967,13 +967,13 @@ },"161": { "doc": "Configuration Reference", "title": "events.webhooks.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#eventswebhooksretry", "relUrl": "/reference/config.html#eventswebhooksretry" },"162": { "doc": "Configuration Reference", "title": "events.webhooks.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#eventswebhookstls", "relUrl": "/reference/config.html#eventswebhookstls" },"163": { @@ -1009,7 +1009,7 @@ },"168": { "doc": "Configuration Reference", "title": "http.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#httptls", "relUrl": "/reference/config.html#httptls" },"169": { @@ -1057,7 +1057,7 @@ },"176": { "doc": "Configuration Reference", "title": "metrics.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#metricstls", "relUrl": "/reference/config.html#metricstls" },"177": { @@ -1111,7 +1111,7 @@ },"185": { "doc": "Configuration Reference", "title": "namespaces.predefined[].tlsConfigs[].tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#namespacespredefinedtlsconfigstls", "relUrl": "/reference/config.html#namespacespredefinedtlsconfigstls" },"186": { @@ -1195,13 +1195,13 @@ },"199": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.addressResolver.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumaddressresolverretry", "relUrl": "/reference/config.html#pluginsblockchainethereumaddressresolverretry" },"200": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.addressResolver.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumaddressresolvertls", "relUrl": "/reference/config.html#pluginsblockchainethereumaddressresolvertls" },"201": { @@ -1231,19 +1231,19 @@ },"205": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.ethconnect.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumethconnectretry", "relUrl": "/reference/config.html#pluginsblockchainethereumethconnectretry" },"206": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.ethconnect.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumethconnecttls", "relUrl": "/reference/config.html#pluginsblockchainethereumethconnecttls" },"207": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.ethconnect.ws", - "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", + "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | url | URL to use for WebSocket - overrides url one level up (in the HTTP config) | string | <nil> | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumethconnectws", "relUrl": "/reference/config.html#pluginsblockchainethereumethconnectws" },"208": { @@ -1267,13 +1267,13 @@ },"211": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.fftm.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumfftmretry", "relUrl": "/reference/config.html#pluginsblockchainethereumfftmretry" },"212": { "doc": "Configuration Reference", "title": "plugins.blockchain[].ethereum.fftm.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainethereumfftmtls", "relUrl": "/reference/config.html#pluginsblockchainethereumfftmtls" },"213": { @@ -1303,19 +1303,19 @@ },"217": { "doc": "Configuration Reference", "title": "plugins.blockchain[].fabric.fabconnect.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainfabricfabconnectretry", "relUrl": "/reference/config.html#pluginsblockchainfabricfabconnectretry" },"218": { "doc": "Configuration Reference", "title": "plugins.blockchain[].fabric.fabconnect.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainfabricfabconnecttls", "relUrl": "/reference/config.html#pluginsblockchainfabricfabconnecttls" },"219": { "doc": "Configuration Reference", "title": "plugins.blockchain[].fabric.fabconnect.ws", - "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", + "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | url | URL to use for WebSocket - overrides url one level up (in the HTTP config) | string | <nil> | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", "url": "/firefly/head/reference/config.html#pluginsblockchainfabricfabconnectws", "relUrl": "/reference/config.html#pluginsblockchainfabricfabconnectws" },"220": { @@ -1339,13 +1339,13 @@ },"223": { "doc": "Configuration Reference", "title": "plugins.blockchain[].tezos.addressResolver.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchaintezosaddressresolverretry", "relUrl": "/reference/config.html#pluginsblockchaintezosaddressresolverretry" },"224": { "doc": "Configuration Reference", "title": "plugins.blockchain[].tezos.addressResolver.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchaintezosaddressresolvertls", "relUrl": "/reference/config.html#pluginsblockchaintezosaddressresolvertls" },"225": { @@ -1375,19 +1375,19 @@ },"229": { "doc": "Configuration Reference", "title": "plugins.blockchain[].tezos.tezosconnect.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsblockchaintezostezosconnectretry", "relUrl": "/reference/config.html#pluginsblockchaintezostezosconnectretry" },"230": { "doc": "Configuration Reference", "title": "plugins.blockchain[].tezos.tezosconnect.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsblockchaintezostezosconnecttls", "relUrl": "/reference/config.html#pluginsblockchaintezostezosconnecttls" },"231": { "doc": "Configuration Reference", "title": "plugins.blockchain[].tezos.tezosconnect.ws", - "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", + "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | url | URL to use for WebSocket - overrides url one level up (in the HTTP config) | string | <nil> | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", "url": "/firefly/head/reference/config.html#pluginsblockchaintezostezosconnectws", "relUrl": "/reference/config.html#pluginsblockchaintezostezosconnectws" },"232": { @@ -1459,19 +1459,19 @@ },"243": { "doc": "Configuration Reference", "title": "plugins.dataexchange[].ffdx.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginsdataexchangeffdxretry", "relUrl": "/reference/config.html#pluginsdataexchangeffdxretry" },"244": { "doc": "Configuration Reference", "title": "plugins.dataexchange[].ffdx.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginsdataexchangeffdxtls", "relUrl": "/reference/config.html#pluginsdataexchangeffdxtls" },"245": { "doc": "Configuration Reference", "title": "plugins.dataexchange[].ffdx.ws", - "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", + "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | url | URL to use for WebSocket - overrides url one level up (in the HTTP config) | string | <nil> | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", "url": "/firefly/head/reference/config.html#pluginsdataexchangeffdxws", "relUrl": "/reference/config.html#pluginsdataexchangeffdxws" },"246": { @@ -1507,13 +1507,13 @@ },"251": { "doc": "Configuration Reference", "title": "plugins.sharedstorage[].ipfs.api.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginssharedstorageipfsapiretry", "relUrl": "/reference/config.html#pluginssharedstorageipfsapiretry" },"252": { "doc": "Configuration Reference", "title": "plugins.sharedstorage[].ipfs.api.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginssharedstorageipfsapitls", "relUrl": "/reference/config.html#pluginssharedstorageipfsapitls" },"253": { @@ -1537,13 +1537,13 @@ },"256": { "doc": "Configuration Reference", "title": "plugins.sharedstorage[].ipfs.gateway.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginssharedstorageipfsgatewayretry", "relUrl": "/reference/config.html#pluginssharedstorageipfsgatewayretry" },"257": { "doc": "Configuration Reference", "title": "plugins.sharedstorage[].ipfs.gateway.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginssharedstorageipfsgatewaytls", "relUrl": "/reference/config.html#pluginssharedstorageipfsgatewaytls" },"258": { @@ -1585,19 +1585,19 @@ },"264": { "doc": "Configuration Reference", "title": "plugins.tokens[].fftokens.retry", - "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", + "content": "| Key | Description | Type | Default Value | . | count | The maximum number of times to retry | int | 5 | . | enabled | Enables retries | boolean | false | . | errorStatusCodeRegex | The regex that the error response status code must match to trigger retry | string | <nil> | . | initWaitTime | The initial retry delay | time.Duration | 250ms | . | maxWaitTime | The maximum retry delay | time.Duration | 30s | . ", "url": "/firefly/head/reference/config.html#pluginstokensfftokensretry", "relUrl": "/reference/config.html#pluginstokensfftokensretry" },"265": { "doc": "Configuration Reference", "title": "plugins.tokens[].fftokens.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#pluginstokensfftokenstls", "relUrl": "/reference/config.html#pluginstokensfftokenstls" },"266": { "doc": "Configuration Reference", "title": "plugins.tokens[].fftokens.ws", - "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", + "content": "| Key | Description | Type | Default Value | . | connectionTimeout | The amount of time to wait while establishing a connection (or auto-reconnection) | time.Duration | 45s | . | heartbeatInterval | The amount of time to wait between heartbeat signals on the WebSocket connection | time.Duration | 30s | . | initialConnectAttempts | The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing | int | 5 | . | path | The WebSocket sever URL to which FireFly should connect | WebSocket URL string | <nil> | . | readBufferSize | The size in bytes of the read buffer for the WebSocket connection | BytesSize | 16Kb | . | url | URL to use for WebSocket - overrides url one level up (in the HTTP config) | string | <nil> | . | writeBufferSize | The size in bytes of the write buffer for the WebSocket connection | BytesSize | 16Kb | . ", "url": "/firefly/head/reference/config.html#pluginstokensfftokensws", "relUrl": "/reference/config.html#pluginstokensfftokensws" },"267": { @@ -1633,7 +1633,7 @@ },"272": { "doc": "Configuration Reference", "title": "spi.tls", - "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", + "content": "| Key | Description | Type | Default Value | . | caFile | The path to the CA file for TLS on this API | string | <nil> | . | certFile | The path to the certificate file for TLS on this API | string | <nil> | . | clientAuth | Enables or disables client auth for TLS on this API | string | <nil> | . | enabled | Enables or disables TLS on this API | boolean | false | . | insecureSkipHostVerify | When to true in unit test development environments to disable TLS verification. Use with extreme caution | boolean | <nil> | . | keyFile | The path to the private key file for TLS on this API | string | <nil> | . | 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> | . ", "url": "/firefly/head/reference/config.html#spitls", "relUrl": "/reference/config.html#spitls" },"273": { @@ -2029,7 +2029,7 @@ },"338": { "doc": "Setting up a FireFly Core Development Environment", "title": "Dependencies", - "content": "You will need a few prerequisites set up on your machine before you can build FireFly from source. We recommend doing development on macOS, Linux, or WSL 2.0. | Go 1.18 | make | GCC | openssl | . Install the FireFly CLI . The first step to setting up a local development environment is to install the FireFly CLI. Please section of the Getting Started Guide to install The FireFly CLI. Installing Go and setting up your GOPATH . We recommend following the instructions on golang.org to install Go, rather than installing Go from another package magager such as brew. Although it is possible to install Go any way you’d like, setting up your GOPATH may differ from the following instructions. After installing Go, you will need to add a few environment variables to your shell run commands file. This is usually a hidden file in your home directory called .bashrc or .zshrc, depending on which shell you’re using. Add the following lines to your .bashrc or .zshrc file: . export GOPATH=$HOME/go export GOROOT=\"/usr/local/go\" export PATH=\"$PATH:${GOPATH}/bin:${GOROOT}/bin\" . ", + "content": "You will need a few prerequisites set up on your machine before you can build FireFly from source. We recommend doing development on macOS, Linux, or WSL 2.0. | Go 1.21 | make | GCC | openssl | . Install the FireFly CLI . The first step to setting up a local development environment is to install the FireFly CLI. Please section of the Getting Started Guide to install The FireFly CLI. Installing Go and setting up your GOPATH . We recommend following the instructions on golang.org to install Go, rather than installing Go from another package magager such as brew. Although it is possible to install Go any way you’d like, setting up your GOPATH may differ from the following instructions. After installing Go, you will need to add a few environment variables to your shell run commands file. This is usually a hidden file in your home directory called .bashrc or .zshrc, depending on which shell you’re using. Add the following lines to your .bashrc or .zshrc file: . export GOPATH=$HOME/go export GOROOT=\"/usr/local/go\" export PATH=\"$PATH:${GOPATH}/bin:${GOROOT}/bin\" . ", "url": "/firefly/head/contributors/dev_environment_setup.html#dependencies", "relUrl": "/contributors/dev_environment_setup.html#dependencies" },"339": { diff --git a/head/contributors/dev_environment_setup.html b/head/contributors/dev_environment_setup.html index 2748fbad0..9fa2cc1c2 100644 --- a/head/contributors/dev_environment_setup.html +++ b/head/contributors/dev_environment_setup.html @@ -332,7 +332,7 @@

You will need a few prerequisites set up on your machine before you can build FireFly from source. We recommend doing development on macOS, Linux, or WSL 2.0.