Update configuration settings for 2025.01 (#2056)

Update configuration settings across all pages

Author: NataliaIvakina

modules/ROOT/pages/backup-restore/online-backup.adoc

@@ -231,7 +231,7 @@ When a full backup is requested, it always triggers a checkpoint.
 The backup cannot proceed until the checkpoint finishes.
 
 While the server is checkpointing, the backup job receives no data, which may lead to the backup timeout.
-To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts the network inactivity.
+To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.network.client_inactivity_timeout[`dbms.cluster.network.client_inactivity_timeout`] setting, which restricts the network inactivity.
 It controls the timeout duration of the catchup protocol, which is the underlying protocol of multiple catchup processes, including backups.
 
 You can also tune up xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings] or check that your disks are performant enough to handle the load.

modules/ROOT/pages/clustering/databases.adoc

@@ -117,15 +117,6 @@ If the `ALTER DATABASE` command decreases the number of allocations of a databas
 ALTER DATABASE nonExisting IF EXISTS SET TOPOLOGY 1 PRIMARY 0 SECONDARY
 ----
 
-[role="statsonlyqueryresult"]
-0 rows
-// This part can be added back once it has been implemented.
-// The allocation approach can be specified with the setting `initial.dbms.database_allocator`.
-// The available options are:
-//
-// * `EQUAL_NUMBERS`
-// * `OPTIMAL_DISC_USAGE`
-// * `ALL`
 
 [[alter-access]]
 === Alter database access

modules/ROOT/pages/clustering/setup/discovery.adoc

@@ -103,6 +103,7 @@ The configured server uses all the addresses from the SRV record to join or form
 
 [[clustering-discovery-k8s]]
 === Discovery in Kubernetes
+
 A special case is when a cluster is running in https://kubernetes.io/[Kubernetes^] and each server is running as a Kubernetes service.
 Then, the addresses of the other servers can be obtained using the List Service API, as described in the https://kubernetes.io/docs/reference/kubernetes-api/[Kubernetes API documentation^].
 
@@ -120,7 +121,7 @@ With this configuration, `dbms.cluster.endpoints` is not used and any value assi
 ====
 * The pod running Neo4j must use a service account that has permission to list services.
 For further information, see the Kubernetes documentation on https://kubernetes.io/docs/reference/access-authn-authz/rbac/[RBAC authorization^] or https://kubernetes.io/docs/reference/access-authn-authz/abac/[ABAC authorization^].
-* The configured `server.discovery.advertised_address` must exactly match the Kubernetes-internal DNS name, which is of the form `<service-name>.<namespace>.svc.cluster.local`.
+* The configured `server.cluster.advertised_address` must exactly match the Kubernetes-internal DNS name, which is of the form `<service-name>.<namespace>.svc.cluster.local`.
 ====
 
 The discovery configuration is used for initial discovery and to continuously exchange information about changes to the topology of the cluster.

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

@@ -310,21 +310,6 @@ m|+++1024+++
 |===
 
 
-[role=label--enterprise-edition label--deprecated-5.26]
-[[config_dbms.cluster.catchup.client_inactivity_timeout]]
-=== `dbms.cluster.catchup.client_inactivity_timeout`
-
-.dbms.cluster.catchup.client_inactivity_timeout
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|The catch-up protocol times out if the given duration elapses with no network activity. Every message received by the client from the server extends the timeout duration.
-|Valid values
-a|A duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default unit is `s`).
-|Default value
-m|+++10m+++
-|===
-
 [role=label--enterprise-edition]
 [[config_dbms.cluster.network.client_inactivity_timeout]]
 === `dbms.cluster.network.client_inactivity_timeout`
@@ -348,8 +333,9 @@ m|+++10m+++
 [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
 |===
 |Description
-a|A comma-separated list of endpoints that a server should contact in order to discover other cluster members.
-Typically, all cluster members, including the current server, must be specified in this list.
+a|A comma-separated list of endpoints which a server should contact in order to discover other cluster members.
+All cluster members hosting a `system` database primary must be specified in this list.
+However, it is typical that all cluster members, including the current server, are specified in this list.
 |Valid values
 a|A comma-separated list where each element is a socket address in the format of `hostname:port`, `hostname`, or `:port`.
 |Default value
@@ -659,22 +645,6 @@ m|+++false+++
 |===
 
 
-[role=label--enterprise-edition label--deprecated-5.23]
-[[config_initial.dbms.database_allocator]]
-=== `initial.dbms.database_allocator`
-
-.initial.dbms.database_allocator
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Name of the initial database allocator. After the creation of the DBMS, it can be set by running the `CALL dbms.setDatabaseAllocator()` procedure.
-|Valid values
-a|A string.
-|Default value
-m|+++EQUAL_NUMBERS+++
-|===
-
-
 [role=label--enterprise-edition]
 [[config_initial.dbms.default_primaries_count]]
 === `initial.dbms.default_primaries_count`
@@ -915,21 +885,6 @@ m|+++PRIMARY+++
 |===
 
 
-[role=label--enterprise-edition label--deprecated-5.23]
-[[config_server.discovery.listen_address]]
-=== `server.discovery.listen_address`
-
-.server.discovery.listen_address
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Host and port to bind the cluster member discovery management communication.
-|Valid values
-a|A socket address in the format of `hostname:port`, `hostname`, or `:port`. If missing, it is acquired from server.default_listen_address.
-|Default value
-m|+++:5000+++
-|===
-
 == Connection settings
 
 Connection settings control the communication between servers and between a server and a client.
@@ -1463,22 +1418,6 @@ m|+++localhost+++
 |===
 
 
-[role=label--enterprise-edition label--deprecated-5.23]
-[[config_server.discovery.advertised_address]]
-=== `server.discovery.advertised_address`
-
-.server.discovery.advertised_address
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Advertised cluster member discovery management communication.
-|Valid values
-a|A socket address in the format of `hostname:port`, `hostname`, or `:port` that is an accessible address. If missing, it is acquired from `server.default_advertised_address`.
-|Default value
-m|+++:5000+++
-|===
-
-
 [role=label--enterprise-edition]
 [[config_server.routing.advertised_address]]
 === `server.routing.advertised_address`
@@ -1816,7 +1755,7 @@ If more than one label can be inferred for a given node, the planner keeps the m
 |Valid values
 a|One of [MOST_SELECTIVE_LABEL, OFF].
 |Default value
-m|+++OFF+++
+m|+++MOST_SELECTIVE_LABEL+++ label:changed[Changed in 2025.01]
 |===
 
 For some queries, the planner can infer predicates such as labels or types from the graph structure that can improve estimating the number of rows that each operator produces.
@@ -2086,12 +2025,13 @@ m|+++UTC+++
 a|Databases can be created from an existing _seed_ (a database backup or dump) stored at a specific source URI.
 Different implementations of `com.neo4j.dbms.seeding.SeedProvider` support various types of seed sources.
 
-The following values are available: `S3SeedProvider`, `CloudSeedProvider`, `URLConnectionSeedProvider`, and `FileSeedProvider`.
+The following values are available: `CloudSeedProvider`, `FileSeedProvider`, `S3SeedProvider`, and `URLConnectionSeedProvider`.
 
-* `S3SeedProvider` supports seeds addressed with  `s3`.
 * `CloudSeedProvider` supports seeds addressed with  `s3`, `azb`, `gs`.
-* `URLConnectionSeedProvider` supports seeds addressed with `ftp`,`http`, and `https`.
 * `FileSeedProvider` supports seeds addressed with `file`.
+* `S3SeedProvider` supports seeds addressed with  `s3` but is deprecated and only usable in Cypher 5.
+* `URLConnectionSeedProvider` supports seeds addressed with `ftp`,`http`, and `https`.
+
 
 This list specifies enabled seed providers.
 If a seed source (URI scheme) is supported by multiple providers in the list, the first matching provider will be used.
@@ -2100,7 +2040,7 @@ See xref:/clustering/databases.adoc#cluster-seed-uri[Seed from URI] for more inf
 |Valid values
 a|A comma-separated list where each element is a string.
 |Default value
-m|+++S3SeedProvider,CloudSeedProvider+++
+m|+++CloudSeedProvider+++ label:changed[Changed in 2025.01]
 |===
 
 
@@ -2317,25 +2257,6 @@ Neo4j has two different configuration files for logging, one for the _neo4j.log_
 For more information, see xref:/monitoring/logging.adoc[Logging].
 
 
-[role=label--deprecated-5.12 label--dynamic]
-[[config_db.logs.query.annotation_data_as_json_enabled]]
-=== `db.logs.query.annotation_data_as_json_enabled`
-
-.db.logs.query.annotation_data_as_json_enabled
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Log the annotation data as JSON strings instead of a Cypher map. This configuration has an effect only when the query log is in JSON format.
-If `true`, it collapses the nested JSON objects in the query logger.
-|Valid values
-a|A boolean.
-|Default value
-m|+++false+++
-|Replaced by
-a|<<config_db.logs.query.annotation_data_format,`db.logs.query.annotation_data_format`>>
-|===
-
-
 [role=label--dynamic]
 [[config_db.logs.query.annotation_data_format]]
 === `db.logs.query.annotation_data_format`
@@ -2354,7 +2275,7 @@ This only have effect when the query log is in JSON format.
 |Valid values
 a|One of [CYPHER, JSON, FLAT_JSON].
 |Default value
-m|+++CYPHER+++
+m|+++JSON+++ label:changed[Changed in 2025.01]
 |===
 
 
@@ -2529,6 +2450,7 @@ m|+++false+++
 |===
 
 
+[role=label--changed-2025.01]
 [[config_server.logs.config]]
 === `server.logs.config`
 
@@ -2538,9 +2460,9 @@ m|+++false+++
 |Description
 a|Path to the logging configuration for debug, query, http and security logs.
 |Valid values
-a|A path. If relative, it is resolved from server.directories.neo4j_home.
+a|A path. If relative, it is resolved from server.directories.configuration.
 |Default value
-m|+++conf/server-logs.xml+++
+m|+++server-logs.xml+++
 |===
 
 
@@ -2619,6 +2541,7 @@ m|+++20.00MiB+++
 |===
 
 
+[role=label--changed-2025.01]
 [[config_server.logs.user.config]]
 === `server.logs.user.config`
 
@@ -2628,9 +2551,9 @@ m|+++20.00MiB+++
 |Description
 a|Path to the logging configuration of user logs.
 |Valid values
-a|A path. If relative, it is resolved from `server.directories.neo4j_home`.
+a|A path. If relative, it is resolved from server.directories.configuration.
 |Default value
-m|+++conf/user-logs.xml+++
+m|+++user-logs.xml+++
 |===
 
 
@@ -2735,21 +2658,6 @@ m|+++0B+++
 |===
 
 
-[role=label--deprecated-5.8]
-[[config_db.tx_state.memory_allocation]]
-=== `db.tx_state.memory_allocation`
-
-.db.tx_state.memory_allocation
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Defines whether memory for transaction state should be allocated on- or off-heap. Note that for small transactions you can gain up to 25% write speed by setting it to `ON_HEAP`.
-|Valid values
-a|One of [ON_HEAP, OFF_HEAP].
-|Default value
-m|+++ON_HEAP+++
-|===
-
 
 [role=label--deprecated-5.7]
 [[config_server.db.query_cache_size]]
@@ -2830,54 +2738,6 @@ m|
 |===
 
 
-[role=label--deprecated-5.26]
-[[config_server.memory.off_heap.block_cache_size]]
-=== `server.memory.off_heap.block_cache_size`
-
-.server.memory.off_heap.block_cache_size
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Defines the size of the off-heap memory blocks cache. The cache will contain this number of blocks for each block size that is power of two. Thus, maximum amount of memory used by blocks cache can be calculated as 2 * <<config_server.memory.off_heap.max_cacheable_block_size,server.memory.off_heap.max_cacheable_block_size>> * `server.memory.off_heap.block_cache_size`
-|Valid values
-a|An integer that is minimum `16`.
-|Default value
-m|+++128+++
-|===
-
-
-[role=label--deprecated-5.26]
-[[config_server.memory.off_heap.max_cacheable_block_size]]
-=== `server.memory.off_heap.max_cacheable_block_size`
-
-.server.memory.off_heap.max_cacheable_block_size
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|Defines the maximum size of an off-heap memory block that can be cached to speed up allocations. The value must be a power of 2.
-|Valid values
-a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `4.00KiB` and is power of 2.
-|Default value
-m|+++512.00KiB+++
-|===
-
-
-[role=label--deprecated-5.8]
-[[config_server.memory.off_heap.transaction_max_size]]
-=== `server.memory.off_heap.transaction_max_size`
-
-.server.memory.off_heap.transaction_max_size
-[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
-|===
-|Description
-a|The maximum amount of off-heap memory that can be used to store transaction state data; it's a total amount of memory shared across all active transactions. Zero means 'unlimited'. Used when <<config_db.tx_state.memory_allocation,db.tx_state.memory_allocation>> is set to 'OFF_HEAP'.
-|Valid values
-a|A byte size (valid multipliers are `B`, `KiB`, `KB`, `K`, `kB`, `kb`, `k`, `MiB`, `MB`, `M`, `mB`, `mb`, `m`, `GiB`, `GB`, `G`, `gB`, `gb`, `g`, `TiB`, `TB`, `PiB`, `PB`, `EiB`, `EB`) that is minimum `0B`.
-|Default value
-m|+++2.00GiB+++
-|===
-
-
 [[config_server.memory.pagecache.directio]]
 === `server.memory.pagecache.directio`
 
@@ -3065,7 +2925,7 @@ a|Decides what compression to use for the csv history files.
 |Valid values
 a|One of [NONE, ZIP, GZ].
 |Default value
-m|+++NONE+++
+m|+++ZIP+++ label:changed[Changed in 2025.01]
 |===
 
 
@@ -4544,6 +4404,22 @@ m|+++cluster-state+++
 |===
 
 
+[role=label--enterprise-edition label--new-2025.01]
+[[config_server.directories.configuration]]
+=== `server.directories.configuration`
+
+.server.directories.configuration
+[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
+|===
+|Description
+a|Root location of the configuration directory.
+|Valid values
+a|A path. If relative, it is resolved from server.directories.neo4j_home.
+|Default value
+m|+++conf+++
+|===
+
+
 [[config_server.directories.data]]
 === `server.directories.data`
 
@@ -4909,7 +4785,7 @@ m|
 |===
 
 
-[role=label--enterprise-edition label--changed-2025.01]
+[role=label--enterprise-edition]
 [[config_server.panic.shutdown_on_panic]]
 === `server.panic.shutdown_on_panic`
 
@@ -4921,7 +4797,7 @@ a|Controls whether the Neo4j process will shut down, if there is a server panic
 |Valid values
 a|A boolean.
 |Default value
-m|true
+m|true label:changed[Changed in 2025.01]
 |===
 
 

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

@@ -38,7 +38,6 @@ RETURN name
 | "db.checkpoint.iops.limit"                                     |
 | "db.format"                                                    |
 | "db.lock.acquisition.timeout"                                  |
-| "db.logs.query.annotation_data_as_json_enabled"                |
 | "db.logs.query.annotation_data_format"                         |
 | "db.logs.query.early_raw_logging_enabled"                      |
 | "db.logs.query.enabled"                                        |