Skip to content

Commit

Permalink
[#88] Fix typos/formatting in web site pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kai Hudalla committed Jan 31, 2017
1 parent 06d20ab commit b9337a3
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion site/content/component/hono-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following table provides an overview of the configuration options the adapte
| `HONO_SERVER_BINDADDRESS`<br>`--hono.server.bindaddress` | yes | `127.0.0.1` | The IP address the Hono server should bind to. By default the adapter binds to the *loopback device* address, i.e. the adapter will **not** be accessible from other hosts. |
| `HONO_SERVER_PORT`<br>`--hono.server.port` | yes | `5672` | The port the server should listen on. |
| `HONO_DOWNSTREAM_HOST`<br>`--hono.downstream.host` | yes | `localhost` | The IP address or name of the downstream *Dispatch Router* host. NB: This needs to be set to an address that can be resolved within the network the adapter runs on. When running as a Docker container, use Docker's `--link` command line option to link the Hono server container to the host of the *Dispatch Router* container on the Docker network.
| `HONO_DOWNSTREAM_PORT`<br>`--hono.downstream.port` | yes | `5672` | The port that the Dispatch Router is listening on. |
| `HONO_DOWNSTREAM_PORT`<br>`--hono.downstream.port` | yes | `5672` | The port that the Dispatch Router is listening on for connection from the Hono server.<br>**NB** When using the Dispatch Router image with the example configuration then this property needs to be set to `5673`. This is because in the example configuration the Dispatch Router's *internal* listener used for accepting connections from the Hono server is configured to attach to port 5673. |
| `HONO_DOWNSTREAM_USERNAME`<br>`--hono.downstream.username` | no | - | The username to use for authenticating to the Dispatch Router. This property (and the corresponding password) needs to be set only if the Dispatch Router component is configured to use `SASL PLAIN` instead of `SASL EXTERNAL` for authenticating the Hono server. |
| `HONO_DOWNSTREAM_PASSWORD`<br>`--hono.downstream.password` | no | - | The password to use for authenticating to the Hono server. This property (and the corresponding username) needs to be set only if the Dispatch Router component is configured to use `SASL PLAIN` instead of `SASL EXTERNAL` for authenticating the Hono server. |
| `HONO_DOWNSTREAM_TRUST_STORE_PATH`<br>`--hono.downstream.trustStorePath` | no | - | The absolute path to the Java key store containing the CA certificates the Hono server uses for authenticating the Dispatch Router. This property **must** be set if the Dispatch Router has been configured to support TLS. The key store format can be either `JKS`, `PKCS12` or `PEM` indicated by a `.jks`, `.p12` or `.pem` file suffix. |
Expand Down
7 changes: 4 additions & 3 deletions site/content/component/mqtt-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ $ docker run -d --name mqtt-adapter --network hono-net -e 'HONO_CLIENT_HOST=hono
> -e 'HONO_CLIENT_TRUST_STORE_PATH=/etc/hono/certs/trustStore.jks' \
> -e 'HONO_CLIENT_TRUST_STORE_PASSWORD=honotrust' \
> -p1883:1883 --volumes-from=hono-config eclipsehono/hono-adapter-mqtt-vertx:latest
~~~

{{% note %}}
The *--network* command line switch is used to specify the *user defined* Docker network that the MQTT adapter container should attach to. It is important that the MQTT adapter container is attached to the same network that the Hono server is attached to so that the MQTT adapter can use the Hono server's host name to connect to it via the Docker network.
Expand All @@ -64,11 +65,11 @@ The corresponding command to start up the adapter with the configuration used in
~~~

{{% note %}}
In the example above the `--hono.client.host=hono` command line option indicates that the Hono server is running on a host
with name `hono`. However, if the Hono server has been started as a Docker container then the `hono` host name will most
In the example above the *--hono.client.host=hono* command line option indicates that the Hono server is running on a host
with name *hono*. However, if the Hono server has been started as a Docker container then the *hono* host name will most
likely only be resolvable on the network that Docker has created for running the container on, i.e. when you run the REST adapter
from the Spring Boot application and want it to connect to a Hono server run as a Docker container then you need to set the
value of the `--hono.client.host` option to the IP address (or name) of the Docker host running the Hono server container.
value of the *--hono.client.host* option to the IP address (or name) of the Docker host running the Hono server container.
{{% /note %}}

## Using the Telemetry Topic Hierarchy
Expand Down
6 changes: 3 additions & 3 deletions site/content/component/rest-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ The corresponding command to start up the adapter with the configuration used in
~~~

{{% note %}}
In the example above the `--hono.client.host=hono` command line option indicates that the Hono server is running on a host
with name `hono`. However, if the Hono server has been started as a Docker container then the `hono` host name will most
In the example above the *--hono.client.host=hono* command line option indicates that the Hono server is running on a host
with name *hono*. However, if the Hono server has been started as a Docker container then the *hono* host name will most
likely only be resolvable on the network that Docker has created for running the container on, i.e. when you run the REST adapter
from the Spring Boot application and want it to connect to a Hono server run as a Docker container then you need to set the
value of the `--hono.client.host` option to the IP address (or name) of the Docker host running the Hono server container.
value of the *--hono.client.host* option to the IP address (or name) of the Docker host running the Hono server container.
{{% /note %}}

## Using the Registration API
Expand Down

0 comments on commit b9337a3

Please sign in to comment.