Skip to content

Commit

Permalink
Updated configuration entry descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
writinwaters committed Dec 9, 2024
1 parent 52f38ca commit 13d3f9b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/references/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ time_zone = "utc-8"
# The number of worker threads. Defaults to the number of CPU cores.
# Range: [1, 16384]
cpu_limit = 8
# Server mode, indicates Infinity start up mode, either "standalone" or "admin". Defaults to "standalone"
# The mode in which the server starts. Available options:
# - `"standalone"`: Start Infinity as a standalone server.
# - `"admin"`:
# - Start Infinity either as a standalone server in `ADMIN` mode (when `storage_type` is set to `"local"`)
# - Start Infinity as a cluster node in `ADMIN` mode (when `storage_type` is set to `"minio"`)
server_mode = "standalone"

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

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

Expand Down

0 comments on commit 13d3f9b

Please sign in to comment.