docs: factorize (#5411)

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
pull/5232/head
James Elliott 2023-05-08 16:02:59 +10:00 committed by GitHub
parent 998ffe5255
commit 83cd09db79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 63 additions and 18 deletions

View File

@ -121,8 +121,8 @@ This section describes the individual configuration options.
{{< confkey type="string" required="yes" >}} {{< confkey type="string" required="yes" >}}
*__Reference Note:__ This configuration option uses the [Address](../prologue/common.md#address) format. Please see the *__Reference Note:__ This configuration option uses the [address common syntax](../prologue/common.md#address). Please
[documentation](../prologue/common.md#address) on this format for more information.* see the [documentation](../prologue/common.md#address) on this format for more information.*
The LDAP URL which consists of a scheme, hostname, and port. Format is `[<scheme>://]<hostname>[:<port>]`. The default The LDAP URL which consists of a scheme, hostname, and port. Format is `[<scheme>://]<hostname>[:<port>]`. The default
scheme is `ldapi` if the path is absolute otherwise it's `ldaps`, and the permitted schemes are `ldap`, `ldaps`, or scheme is `ldapi` if the path is absolute otherwise it's `ldaps`, and the permitted schemes are `ldap`, `ldaps`, or
@ -173,8 +173,11 @@ URL's are slightly more secure.
### tls ### tls
Controls the TLS connection validation process. You can see how to configure the tls *__Reference Note:__ This configuration option uses the
section [here](../prologue/common.md#tls-configuration). [TLS configuration common structure](../prologue/common.md#tls-configuration). Please see the
[documentation](../prologue/common.md#tls-configuration) on this structure for more information.*
Controls the TLS connection validation parameters for either StartTLS or the TLS socket.
### base_dn ### base_dn

View File

@ -190,13 +190,19 @@ research about how browsers utilize and understand this header before attempting
### buffers ### buffers
Configures the server buffers. See the [Server Buffers](../prologue/common.md#server-buffers) documentation for more *__Reference Note:__ This configuration option uses the
information. [Server buffers common structure](../prologue/common.md#server-buffers). Please see the
[documentation](../prologue/common.md#server-buffers) on this structure for more information.*
Configures the server buffers.
### timeouts ### timeouts
Configures the server timeouts. See the [Server Timeouts](../prologue/common.md#server-timeouts) documentation for more *__Reference Note:__ This configuration option uses the
information. [Server timeouts common structure](../prologue/common.md#server-timeouts). Please see the
[documentation](../prologue/common.md#server-timeouts) on this structure for more information.*
Configures the server timeouts.
### endpoints ### endpoints

View File

@ -232,8 +232,11 @@ mixed emails which contain both HTML and text so this option is rarely necessary
### tls ### tls
Controls the TLS connection validation process. You can see how to configure the tls section *__Reference Note:__ This configuration option uses the
[here](../prologue/common.md#tls-configuration). [TLS configuration common structure](../prologue/common.md#tls-configuration). Please see the
[documentation](../prologue/common.md#tls-configuration) on this structure for more information.*
Controls the TLS connection validation parameters for either StartTLS or the TLS socket.
## Using Gmail ## Using Gmail

View File

@ -205,6 +205,11 @@ guide on configuring any particular instance.
Various sections of the configuration use a uniform configuration section called TLS. Notably LDAP and SMTP. Various sections of the configuration use a uniform configuration section called TLS. Notably LDAP and SMTP.
This section documents the usage. This section documents the usage.
Various sections of the configuration use a uniform configuration section called `tls` which configure TLS socket and
TLS verification parameters. Notably the [LDAP](../first-factor/ldap.md#tls), [SMTP](../notifications/smtp.md#tls),
[PostgreSQL](../storage/postgres.md#tls), [MySQL](../storage/mysql.md#tls), and [Redis](../session/redis.md#tls)
sections. This section documents the common parts of this structure.
#### server_name #### server_name
{{< confkey type="string" required="no" >}} {{< confkey type="string" required="no" >}}
@ -263,6 +268,11 @@ is provided, in top down order, each certificate must be signed by the next cert
### Server Buffers ### Server Buffers
Various sections of the configuration use a uniform configuration section called `buffers` which configure HTTP server
buffers. Notably the [server](../miscellaneous/server.md#buffers) and
[metrics telemetry](../telemetry/metrics.md#buffers) sections. This section documents the common parts of this
structure.
#### read #### read
{{< confkey type="integer" default="4096" required="no" >}} {{< confkey type="integer" default="4096" required="no" >}}
@ -277,6 +287,11 @@ Configures the maximum response size. The default of 4096 is generally sufficien
### Server Timeouts ### Server Timeouts
Various sections of the configuration use a uniform configuration section called `timeouts` which configure HTTP server
timeouts. Notably the [server](../miscellaneous/server.md#timeouts) and
[metrics telemetry](../telemetry/metrics.md#timeouts) sections. This section documents the common parts of this
structure.
#### read #### read
{{< confkey type="duration" default="6s" required="no" >}} {{< confkey type="duration" default="6s" required="no" >}}

View File

@ -182,8 +182,12 @@ is useful if there are long delays in establishing connections.
### tls ### tls
If defined enables [redis] over TLS, and additionally controls the TLS connection validation process. You can see how to *__Reference Note:__ This configuration option uses the
configure the tls section [here](../prologue/common.md#tls-configuration). [TLS configuration common structure](../prologue/common.md#tls-configuration). Please see the
[documentation](../prologue/common.md#tls-configuration) on this structure for more information.*
If defined enables connecting to [redis] over a TLS socket, and additionally controls the TLS connection
validation parameters.
### high_availability ### high_availability

View File

@ -182,8 +182,12 @@ The SQL connection timeout.
### tls ### tls
*__Reference Note:__ This configuration option uses the
[TLS configuration common structure](../prologue/common.md#tls-configuration). Please see the
[documentation](../prologue/common.md#tls-configuration) on this structure for more information.*
If defined enables connecting to [MySQL] or [MariaDB] over a TLS socket, and additionally controls the TLS connection If defined enables connecting to [MySQL] or [MariaDB] over a TLS socket, and additionally controls the TLS connection
validation process. You can see how to configure the tls section [here](../prologue/common.md#tls-configuration). validation parameters.
[MySQL]: https://www.mysql.com/ [MySQL]: https://www.mysql.com/
[MariaDB]: https://mariadb.org/ [MariaDB]: https://mariadb.org/

View File

@ -188,7 +188,11 @@ The SQL connection timeout.
### tls ### tls
*__Reference Note:__ This configuration option uses the
[TLS configuration common structure](../prologue/common.md#tls-configuration). Please see the
[documentation](../prologue/common.md#tls-configuration) on this structure for more information.*
If defined enables connecting to [PostgreSQL] over a TLS socket, and additionally controls the TLS connection If defined enables connecting to [PostgreSQL] over a TLS socket, and additionally controls the TLS connection
validation process. You can see how to configure the tls section [here](../prologue/common.md#tls-configuration). validation parameters.
[PostgreSQL]: https://www.postgresql.org/ [PostgreSQL]: https://www.postgresql.org/

View File

@ -69,13 +69,19 @@ This value should typically be prefixed with a `0` to ensure the relevant parser
### buffers ### buffers
Configures the server buffers. See the [Server Buffers](../prologue/common.md#server-buffers) documentation for more *__Reference Note:__ This configuration option uses the
information. [Server buffers common structure](../prologue/common.md#server-buffers). Please see the
[documentation](../prologue/common.md#server-buffers) on this structure for more information.*
Configures the server buffers.
### timeouts ### timeouts
Configures the server timeouts. See the [Server Timeouts](../prologue/common.md#server-timeouts) documentation for more *__Reference Note:__ This configuration option uses the
information. [Server timeouts common structure](../prologue/common.md#server-timeouts). Please see the
[documentation](../prologue/common.md#server-timeouts) on this structure for more information.*
Configures the server timeouts.
## See More ## See More