Skip to content

Commit

Permalink
Apply review
Browse files Browse the repository at this point in the history
  • Loading branch information
@LukasBrand
LukasBrand committed Oct 4, 2023
1 parent 3447eaa commit c719a0d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Additionally, every broker updates its own file on a regular basis to prevent th
## Installation

* Download the extension from
the [HiveMQ Website](https://www.hivemq.com/releases/extensions/hivemq-azure-cluster-discovery-extension-1.0.0.zip) or
the [HiveMQ Website](https://www.hivemq.com/releases/extensions/hivemq-azure-cluster-discovery-extension-1.1.0.zip) or
from the [GitHub Releases Page](https://github.com/hivemq/hivemq-azure-cluster-discovery-extension/releases/latest).
* Copy the content of the zip file to the `extensions` folder of your HiveMQ nodes.
* Modify the `azDiscovery.properties` file for your needs.
Expand All @@ -38,13 +38,13 @@ The `azDiscovery.properties` can be reloaded during runtime.

### General Configuration

| Config Name | Default Value | Description |
|--------------------------|:----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| connection‑string | | The required connection string of your Azure Storage Account. See the [Azure Documentation](https://docs.microsoft.com/de-de/com.hivemq.extensions.azure/storage/common/storage-configure-connection-string) for more information. |
| container‑name | hivemq-discovery | The name of the Azure Storage Container in which the Blob for the discovery will be created in. If the Container does not exist yet, it will be created by the extension. |
| file‑prefix | hivemq-node- | An optional file-prefix for the Blob to create, which holds the cluster node information for the discovery. Do not omit this value if you reuse the specified container for other files. |
| file‑expiration | 360 | Timeout in seconds after which the created Blob will be deleted by other nodes, if it was not updated in time. |
| update‑interval | 180 | Interval in seconds in which the Blob will be updated. Must be less than file-expiration. |
| Config Name | Default Value | Description |
|--------------------------|:----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| connection‑string | | The required connection string of your Azure Storage Account. See the [Azure Documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string) for more information. |
| container‑name | hivemq-discovery | The name of the Azure Storage Container in which the Blob for the discovery will be created in. If the Container does not exist yet, it will be created by the extension. |
| file‑prefix | hivemq-node- | An optional file-prefix for the Blob to create, which holds the cluster node information for the discovery. Do not omit this value if you reuse the specified container for other files. |
| file‑expiration | 360 | Timeout in seconds after which the created Blob will be deleted by other nodes, if it was not updated in time. |
| update‑interval | 180 | Interval in seconds in which the Blob will be updated. Must be less than file-expiration. |

### Example Configuration

Expand Down

0 comments on commit c719a0d

Please sign in to comment.