From 79f3b900795f6fe0222032922f69c985d86e5ea4 Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Mon, 26 Apr 2021 22:23:40 +0000 Subject: [PATCH] autogen(docs): generate and format documentation --- docs/docs/reference/api.mdx | 11 ++-- docs/docs/reference/configuration.md | 98 ++++++++++++++++++++++++++++ spec/api.json | 4 -- 3 files changed, 102 insertions(+), 11 deletions(-) diff --git a/docs/docs/reference/api.mdx b/docs/docs/reference/api.mdx index b50652b7eea..b215fae9606 100644 --- a/docs/docs/reference/api.mdx +++ b/docs/docs/reference/api.mdx @@ -8239,7 +8239,6 @@ _NullTime implements sql.NullTime functionality._ } ], "Interface": { - "ProtocolScheme": "string", "Socket": "string", "Types": [ { @@ -8347,7 +8346,6 @@ _PluginConfigArgs plugin config args_ ```json { - "ProtocolScheme": "string", "Socket": "string", "Types": [ { @@ -8363,11 +8361,10 @@ _PluginConfigInterface The interface between Docker and the plugin_ #### Properties -| Name | Type | Required | Restrictions | Description | -| -------------- | --------------------------------------------------- | -------- | ------------ | ----------------------------------------------------- | -| ProtocolScheme | string | false | none | Protocol to use for clients connecting to the plugin. | -| Socket | string | true | none | socket | -| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types | +| Name | Type | Required | Restrictions | Description | +| ------ | --------------------------------------------------- | -------- | ------------ | ----------- | +| Socket | string | true | none | socket | +| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types | diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md index 819f5fae563..16863b1f890 100644 --- a/docs/docs/reference/configuration.md +++ b/docs/docs/reference/configuration.md @@ -264,6 +264,56 @@ serve: # disable_for_health: false + ## tls ## + # + tls: + ## cert ## + # + cert: + ## path ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_ADMIN_TLS_CERT_PATH= + # - Windows Command Line (CMD): + # > set SERVE_ADMIN_TLS_CERT_PATH= + # + path: /path/to/file.pem + + ## allow_termination_from ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_ADMIN_TLS_ALLOW_TERMINATION_FROM= + # - Windows Command Line (CMD): + # > set SERVE_ADMIN_TLS_ALLOW_TERMINATION_FROM= + # + allow_termination_from: + - 127.0.0.1/32 + + ## enabled ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_ADMIN_TLS_ENABLED= + # - Windows Command Line (CMD): + # > set SERVE_ADMIN_TLS_ENABLED= + # + enabled: false + + ## key ## + # + key: + ## path ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_ADMIN_TLS_KEY_PATH= + # - Windows Command Line (CMD): + # > set SERVE_ADMIN_TLS_KEY_PATH= + # + path: /path/to/file.pem + ## port ## # # Default value: 4445 @@ -591,6 +641,54 @@ serve: # disable_for_health: false + ## tls ## + # + # Configures HTTPS (HTTP over TLS). If configured, the server automatically supports HTTP/2. + # + tls: + ## cert ## + # + # Configures the private key (pem encoded). + # + cert: + ## path ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_PUBLIC_TLS_CERT_PATH= + # - Windows Command Line (CMD): + # > set SERVE_PUBLIC_TLS_CERT_PATH= + # + path: /path/to/file.pem + + ## allow_termination_from ## + # + # Whitelist one or multiple CIDR address ranges and allow them to terminate TLS connections. Be aware that the X-Forwarded-Proto header must be set and must never be modifiable by anyone but your proxy / gateway / load balancer. Supports ipv4 and ipv6. Hydra serves http instead of https when this option is set. + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_PUBLIC_TLS_ALLOW_TERMINATION_FROM= + # - Windows Command Line (CMD): + # > set SERVE_PUBLIC_TLS_ALLOW_TERMINATION_FROM= + # + allow_termination_from: + - 127.0.0.1/32 + + ## key ## + # + # Configures the private key (pem encoded). + # + key: + ## path ## + # + # Set this value using environment variables on + # - Linux/macOS: + # $ export SERVE_PUBLIC_TLS_KEY_PATH= + # - Windows Command Line (CMD): + # > set SERVE_PUBLIC_TLS_KEY_PATH= + # + path: /path/to/file.pem + ## port ## # # Default value: 4444 diff --git a/spec/api.json b/spec/api.json index 87179342b4c..1363254208e 100755 --- a/spec/api.json +++ b/spec/api.json @@ -2159,10 +2159,6 @@ "Types" ], "properties": { - "ProtocolScheme": { - "description": "Protocol to use for clients connecting to the plugin.", - "type": "string" - }, "Socket": { "description": "socket", "type": "string"