Skip to content

Commit

Permalink
Merge pull request #176 from pjgg/doc/addSecurityDoc
Browse files Browse the repository at this point in the history
Add missing security documentation
  • Loading branch information
masini authored Jan 13, 2024
2 parents 52775a6 + 0b55c29 commit bde698d
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 14 deletions.
64 changes: 52 additions & 12 deletions docs/modules/ROOT/pages/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,6 @@ a|`reconnect-interval-seconds`
--
Set the reconnect interval in seconds.
--
|int
|`1`
| INCOMING_AND_OUTGOING

//@ConnectorAttribute(name = "ca-cart-file", direction = INCOMING_AND_OUTGOING, description = "File containing the self-signed CA for SSL connection", type = "string")

a|`ca-cart-file`

[.description]
--
File containing the self-signed CA for SSL connection.
--
|string
|
| INCOMING_AND_OUTGOING
Expand Down Expand Up @@ -88,4 +76,56 @@ Timeout to declare the MQTT Client not alive.
--|int
|`120000`
| INCOMING_AND_OUTGOING

a|`ssl.keystore.type`

[.description]
--
Set the keystore type
--|string
|`jks`
| INCOMING_AND_OUTGOING
a|`ssl.keystore.location`

[.description]
--
Set the keystore location. In case of pem type this is the cert path
--|string
|
| INCOMING_AND_OUTGOING

a|`ssl.keystore.password`

[.description]
--
"Set the keystore password. In case of pem type this is not necessary
--|string
|
| INCOMING_AND_OUTGOING

a|`ssl.truststore.type`

[.description]
--
Set the truststore type
--|string
|`jks`
| INCOMING_AND_OUTGOING
a|`ssl.truststore.location`

[.description]
--
Set the truststore location. In case of pem type this is the cert path
--|string
|
| INCOMING_AND_OUTGOING

a|`ssl.truststore.password`

[.description]
--
"Set the truststore password. In case of pem type this is not necessary
--|string
|
| INCOMING_AND_OUTGOING
|===
6 changes: 4 additions & 2 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ This adds some benefits to the original SmallRye MQTT:

|===
| Quarkus-hivemq-client version | Quarkus version | HiveMQ client version

| 1.1.0
| 2.16.12.Final
| 1.3.3
| 1.0.0
| 2.16.10.Final
| 1.3.2
Expand All @@ -33,7 +35,7 @@ Requirements:
Create a Quarkus application with the HiveMQ-SmallRye extension

```shell
mvn io.quarkus.platform:quarkus-maven-plugin:2.16.10.Final:create \
mvn io.quarkus.platform:quarkus-maven-plugin:2.16.12.Final:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=hivemq-quickstart \
-DclassName="org.acme.quickstart.GreetingResource" \
Expand Down

0 comments on commit bde698d

Please sign in to comment.