Skip to content

Commit 13d3f9b

Browse files
committed
Updated configuration entry descriptions
1 parent 52f38ca commit 13d3f9b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/references/configurations.mdx

+10-4
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,11 @@ time_zone = "utc-8"
6363
# The number of worker threads. Defaults to the number of CPU cores.
6464
# Range: [1, 16384]
6565
cpu_limit = 8
66-
# Server mode, indicates Infinity start up mode, either "standalone" or "admin". Defaults to "standalone"
66+
# The mode in which the server starts. Available options:
67+
# - `"standalone"`: Start Infinity as a standalone server.
68+
# - `"admin"`:
69+
# - Start Infinity either as a standalone server in `ADMIN` mode (when `storage_type` is set to `"local"`)
70+
# - Start Infinity as a cluster node in `ADMIN` mode (when `storage_type` is set to `"minio"`)
6771
server_mode = "standalone"
6872

6973
# Network configuration
@@ -80,9 +84,9 @@ client_port = 23817
8084
# The maximum number of connections. Defaults to 256.
8185
# Range: [1, 65536]
8286
connection_pool_size = 128
83-
# The IP address of the Infinity peer server to be accessed by a peer node
87+
# The IP address on which the current node listens. Used for registration and inter-node communication
8488
peer_ip = "0.0.0.0"
85-
# The port of the Infinity peer server to be accessed by a peer node
89+
# The port number on which the current node listens. Used for registration and inter-node communication
8690
peer_port = 23850
8791

8892
# The delay time for reconnecting to the Infinity peer server after a failed connection
@@ -143,7 +147,9 @@ compact_interval = "120s"
143147
# the system performs a flush operation on that index.
144148
# Range: [8192, 8388608]
145149
mem_index_capacity = 1048576
146-
# Storage type. Defaults to "local".
150+
# The type of storage to use. Available options:
151+
# - `"local"`: (default)
152+
# - `"minio"`: If you set `server_mode` to `"admin"` and `storage_type` to `"minio"`, the node will start as a cluster node in `ADMIN` mode.
147153
# Range: {"local"|"minio"}
148154
storage_type = "local"
149155

0 commit comments

Comments
 (0)