Merge pull request #572 from Permify/557-docs

add: new config fields add to docs
Permify · Jul 4, 2023 · 7b75496 · 7b75496
2 parents 556aa4b + 96ded45
commit 7b75496
Showing 1 changed file with 16 additions and 9 deletions.
diff --git a/docs/documentation/docs/reference/configuration.md b/docs/documentation/docs/reference/configuration.md
@@ -427,22 +427,29 @@ A consistent hashing ring ensures data distribution that minimizes reorganizatio
 ```
 ├── distributed
 |   ├── enabled
-|   ├── nodes
+|   ├── node
+|   ├── node-name
+|   ├── protocol
 ```
 
 #### Glossary
 
-| Required | Argument | Default | Description                    |
-|----------|----------|---------|--------------------------------|
-| [ ]      | enabled  | true    | switch option for distributed. |
-| [x]      | nodes    | -       | node list                      |
+| Required | Argument  | Default | Description                                                              |
+|----------|-----------|---------|--------------------------------------------------------------------------|
+| [x]      | enabled   | false   | switch option for distributed.                                           |
+| [x]      | node      | -       | endpoint definition for distributed                                      |
+| [x]      | node-name | -       | node name definition for  protocol agent (for example serf node name)    |
+| [x]      | protocol  | -       | a field where you specify which gossip protocol to use, for example serf |
+
 
 #### ENV
 
-| Argument            | ENV                         | Type         |
-|---------------------|-----------------------------|--------------|
-| distributed-enabled | PERMIFY_DISTRIBUTED_ENABLED | boolean      |
-| distributed-nodes   | PERMIFY_DISTRIBUTED_NODES   | string array |
+| Argument               | ENV                           | Type    |
+|------------------------|-------------------------------|---------|
+| distributed-enabled    | PERMIFY_DISTRIBUTED_ENABLED   | boolean |
+| distributed-node       | PERMIFY_DISTRIBUTED_NODE      | string  |
+| distributed-node-name  | PERMIFY_DISTRIBUTED_NODE_NAME | string  |
+| distributed-protocol   | PERMIFY_DISTRIBUTED_PROTOCOL  | string  |
 
 </p>
 </details>