Skip to content

Commit

Permalink
Fix environment variable names
Browse files Browse the repository at this point in the history 
The environment variable names for setting configuration of the health
server did not work with Spring Boot's relaxed binding.

Signed-off-by: Kai Hudalla <[email protected]>
  • Loading branch information
@sophokles73
sophokles73 committed Feb 3, 2020
1 parent 41d2857 commit 7cd109b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions site/documentation/content/admin-guide/monitoring-tracing-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ The health check server can be configured by means of the following environment

| Environment Variable<br>Command Line Option | Default Value | Description |
| :------------------------------------------ | :------------ | :------------|
| `HONO_HEALTH_CHECK_BIND_ADDRESS`<br>`--hono.healthCheck.bindAddress` | `127.0.0.1` | The IP address of the network interface that the health check server's secure port should be bound to. The server will only be started if this property is set to some other than the default value and corresponding key material has been configured using the `HONO_HEALTH_CHECK_KEY_PATH` and `HONO_HEALTH_CHECK_CERT_PATH` variables. |
| `HONO_HEALTH_CHECK_CERT_PATH`<br>`--hono.healthCheck.certPath` | - | The absolute path to the PEM file containing the certificate that the secure server should use for authenticating to clients. This option must be used in conjunction with `HONO_HEALTH_CHECK_KEY_PATH`.<br>Alternatively, the `HONO_HEALTH_CHECK_KEY_STORE_PATH` option can be used to configure a key store containing both the key as well as the certificate. |
| `HONO_HEALTH_CHECK_INSECURE_PORT_BIND_ADDRESS`<br>`--hono.healthCheck.insecurePortBindAddress` | `127.0.0.1` | The IP address of the network interface that the health check server's insecure port should be bound to. The server will only be started if this property is set to some other than the default value. |
| `HONO_HEALTH_CHECK_INSECURE_PORT`<br>`--hono.healthCheck.insecurePort` | `8088` | The port that the insecure server should listen on. |
| `HONO_HEALTH_CHECK_KEY_PATH`<br>`--hono.healthCheck.keyPath` | - | The absolute path to the (PKCS8) PEM file containing the private key that the secure server should use for authenticating to clients. This option must be used in conjunction with `HONO_HEALTH_CHECK_CERT_PATH`. Alternatively, the `HONO_HEALTH_CHECK_KEY_STORE_PATH` option can be used to configure a key store containing both the key as well as the certificate. |
| `HONO_HEALTH_CHECK_PORT`<br>`--hono.healthCheck.port` | `8088` | The port that the secure server should listen on. |
| `HONO_HEALTH_CHECK_KEY_STORE_PASSWORD`<br>`--hono.healthCheck.keyStorePassword` | - | The password required to read the contents of the key store. |
| `HONO_HEALTH_CHECK_KEY_STORE_PATH`<br>`--hono.healthCheck.keyStorePath` | - | The absolute path to the Java key store containing the private key and certificate that the secure server should use for authenticating to clients. Either this option or the `HONO_HEALTH_CHECK_KEY_PATH` and `HONO_HEALTH_CHECK_CERT_PATH` options need to be set in order to enable TLS secured connections with clients. The key store format can be either `JKS` or `PKCS12` indicated by a `.jks` or `.p12` file suffix respectively. The `HONO_HEALTH_CHECK_KEY_STORE_PASSWORD` variable can be used to set the password required for reading the key store. |
| `HONO_HEALTHCHECK_BINDADDRESS`<br>`--hono.healthCheck.bindAddress` | `127.0.0.1` | The IP address of the network interface that the health check server's secure port should be bound to. The server will only be started if this property is set to some other than the default value and corresponding key material has been configured using the `HONO_HEALTHCHECK_KEYPATH` and `HONO_HEALTHCHECK_CERTPATH` variables. |
| `HONO_HEALTHCHECK_CERTPATH`<br>`--hono.healthCheck.certPath` | - | The absolute path to the PEM file containing the certificate that the secure server should use for authenticating to clients. This option must be used in conjunction with `HONO_HEALTHCHECK_KEYPATH`.<br>Alternatively, the `HONO_HEALTHCHECK_KEYSTOREPATH` option can be used to configure a key store containing both the key as well as the certificate. |
| `HONO_HEALTHCHECK_INSECUREPORTBINDADDRESS`<br>`--hono.healthCheck.insecurePortBindAddress` | `127.0.0.1` | The IP address of the network interface that the health check server's insecure port should be bound to. The server will only be started if this property is set to some other than the default value. |
| `HONO_HEALTHCHECK_INSECUREPORT`<br>`--hono.healthCheck.insecurePort` | `8088` | The port that the insecure server should listen on. |
| `HONO_HEALTHCHECK_KEYPATH`<br>`--hono.healthCheck.keyPath` | - | The absolute path to the (PKCS8) PEM file containing the private key that the secure server should use for authenticating to clients. This option must be used in conjunction with `HONO_HEALTHCHECK_CERTPATH`. Alternatively, the `HONO_HEALTHCHECK_KEYSTOREPATH` option can be used to configure a key store containing both the key as well as the certificate. |
| `HONO_HEALTHCHECK_PORT`<br>`--hono.healthCheck.port` | `8088` | The port that the secure server should listen on. |
| `HONO_HEALTHCHECK_KEYSTOREPASSWORD`<br>`--hono.healthCheck.keyStorePassword` | - | The password required to read the contents of the key store. |
| `HONO_HEALTHCHECK_KEYSTOREPATH`<br>`--hono.healthCheck.keyStorePath` | - | The absolute path to the Java key store containing the private key and certificate that the secure server should use for authenticating to clients. Either this option or the `HONO_HEALTHCHECK_KEYPATH` and `HONO_HEALTHCHECK_CERTPATH` options need to be set in order to enable TLS secured connections with clients. The key store format can be either `JKS` or `PKCS12` indicated by a `.jks` or `.p12` file suffix respectively. The `HONO_HEALTHCHECK_KEYSTOREPASSWORD` variable can be used to set the password required for reading the key store. |


{{% warning title="Failure to start" %}}
Expand Down

0 comments on commit 7cd109b

Please sign in to comment.