Skip to content

Commit 18f53e1

Browse files
committed
Document the configuration settings introduced for the Unix Domain Socket connector
1 parent 5fa926d commit 18f53e1

File tree

1 file changed

+135
-0
lines changed

1 file changed

+135
-0
lines changed

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1406,6 +1406,141 @@ a|A long that is minimum `1`.
14061406
m|+++950+++
14071407
|===
14081408

1409+
[role=label--new-2025.08]
1410+
[[config_server.bolt.unix_socket_auth]]
1411+
=== server.bolt.unix_socket_auth
1412+
1413+
.server.bolt.unix_socket_auth
1414+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1415+
|===
1416+
|Description
1417+
a|Enable or disable authentication via the Bolt Unix Domain Socket connector. If disabled, connected clients gain all permissions so long as they are able to access the Unix Domain Socket file.
1418+
|Valid values
1419+
a|A boolean.
1420+
|Default value
1421+
m|+++true+++
1422+
|===
1423+
1424+
[role=label--new-2025.08]
1425+
[[config_server.bolt.unix_socket_delete]]
1426+
=== server.bolt.unix_socket_delete
1427+
1428+
.server.bolt.unix_socket_delete
1429+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1430+
|===
1431+
|Description
1432+
a|Whether or not to delete an existing file for use with the Unix Domain Socket based interface. This improves the handling of the case where a previous hard shutdown was unable to delete the file.
1433+
|Valid values
1434+
a|A boolean.
1435+
|Default value
1436+
m|+++false+++
1437+
|===
1438+
1439+
[role=label--new-2025.08]
1440+
[[config_server.bolt.unix_socket_enabled]]
1441+
=== server.bolt.unix_socket_enabled
1442+
1443+
.server.bolt.unix_socket_enabled
1444+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1445+
|===
1446+
|Description
1447+
a|Enable or disable the Bolt Unix Domain Socket connector.Requests submitted via this connector will be placed within a dedicated thread pool which is isolated from all other Bolt connections.
1448+
|Valid values
1449+
a|A boolean.
1450+
|Default value
1451+
m|+++false+++
1452+
|===
1453+
1454+
[role=label--new-2025.08]
1455+
[[config_server.bolt.unix_socket_path]]
1456+
=== server.bolt.unix_socket_path
1457+
1458+
.server.bolt.unix_socket_path
1459+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1460+
|===
1461+
|Description
1462+
a|The absolute path of the file for use with the Unix Domain Socket interface. This file must be specified and will be created at runtime and deleted on shutdown.
1463+
|Valid values
1464+
a|A path.
1465+
|Default value
1466+
m|+++None+++
1467+
|===
1468+
1469+
[role=label--new-2025.08]
1470+
[[config_server.bolt.unix_socket_permission_mask]]
1471+
=== server.bolt.unix_socket_permission_mask
1472+
1473+
.server.bolt.unix_socket_permission_mask
1474+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1475+
|===
1476+
|Description
1477+
a|Sets the default permission mask applied to the Unix Domain Socket file. This mask should be set as restrictive as possible (especially when authentication is disabled on this connector).Note, however, that this permission may not be honored by Posix systems other than Linux.
1478+
|Valid values
1479+
a|A set of file permissions.
1480+
|Default value
1481+
m|+++rwx--x--x+++
1482+
|===
1483+
1484+
[role=label--new-2025.08]
1485+
[[config_server.bolt.unix_socket_thread_pool_keep_alive]]
1486+
=== server.bolt.unix_socket_thread_pool_keep_alive
1487+
1488+
.server.bolt.unix_socket_thread_pool_keep_alive
1489+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1490+
|===
1491+
|Description
1492+
a|The maximum time an idle thread in the thread pool bound to the Unix Domain Socket connector waits for new tasks.
1493+
|Valid values
1494+
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s).
1495+
|Default value
1496+
m|+++5m+++
1497+
|===
1498+
1499+
[role=label--new-2025.08]
1500+
[[config_server.bolt.unix_socket_thread_pool_max_size]]
1501+
=== server.bolt.unix_socket_thread_pool_max_size
1502+
1503+
.server.bolt.unix_socket_thread_pool_max_size
1504+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1505+
|===
1506+
|Description
1507+
a|The maximum number of threads allowed in the thread pool bound to the Unix Domain Socket connector.
1508+
|Valid values
1509+
a|An integer that is minimum 1.
1510+
|Default value
1511+
m|+++20+++
1512+
|===
1513+
1514+
[role=label--new-2025.08]
1515+
[[config_server.bolt.unix_socket_thread_pool_min_size]]
1516+
=== server.bolt.unix_socket_thread_pool_min_size
1517+
1518+
.server.bolt.unix_socket_thread_pool_min_size
1519+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1520+
|===
1521+
|Description
1522+
a|The number of threads, including idle, to keep in the thread pool bound to the Unix Domain Socket connector.
1523+
|Valid values
1524+
a|An integer that is minimum 0.
1525+
|Default value
1526+
m|+++0+++
1527+
|===
1528+
1529+
[role=label--new-2025.08]
1530+
[[config_server.bolt.unix_socket_use_dedicated_thread_pool]]
1531+
=== server.bolt.unix_socket_use_dedicated_thread_pool
1532+
1533+
.server.bolt.unix_socket_use_dedicated_thread_pool
1534+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
1535+
|===
1536+
|Description
1537+
a|Whether or not to allocate a dedicated thread pool for use with the Unix Domain Socket based interface. This permits the use of the Unix Domain Socket connector as an emergency access connector when the server is over capacity.
1538+
|Valid values
1539+
a|A boolean.
1540+
|Default value
1541+
m|+++true+++
1542+
|===
1543+
14091544
[[config_server.http.advertised_address]]
14101545
=== `server.http.advertised_address`
14111546

0 commit comments

Comments
 (0)