Add more info about -additional-config (#1945) (#1957)

renetapopova · web-flow · commit 9bf39cd7476e · 2024-11-12T11:41:44.000Z
diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc
@@ -59,7 +59,7 @@ Aggregates a chain of backup artifacts into a single artifact.
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
@@ -98,6 +98,8 @@ Consult Neo4j support before use.
 |
 |===
 
+
+
 [NOTE]
 ====
 The `--from-path=<path>` option can also load backup artifacts from AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
diff --git a/modules/ROOT/pages/backup-restore/copy-database.adoc b/modules/ROOT/pages/backup-restore/copy-database.adoc
@@ -80,7 +80,7 @@ The `neo4j-admin database copy` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/backup-restore/inspect.adoc b/modules/ROOT/pages/backup-restore/inspect.adoc
@@ -66,7 +66,7 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/backup-restore/offline-backup.adoc b/modules/ROOT/pages/backup-restore/offline-backup.adoc
@@ -64,7 +64,7 @@ The `neo4j-admin database dump` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc
@@ -116,7 +116,7 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc
@@ -68,7 +68,7 @@ neo4j-admin database restore [-h] [--expand-commands]
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/backup-restore/restore-dump.adoc b/modules/ROOT/pages/backup-restore/restore-dump.adoc
@@ -57,7 +57,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc
@@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options:
 |Allow command expansion in config value evaluation.
 |
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 | Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/index.adoc b/modules/ROOT/pages/tools/neo4j-admin/index.adoc
@@ -223,7 +223,9 @@ For instance, if the page cache of your DBMS is configured to a very high value
 
 There are several options for overriding settings specified in the _neo4j.conf_ file using administration tasks:
 
-* `--additional-config` option -- almost all administration commands support the `--additional-config` option, which you can use to provide a path to a file with additional configuration.
+* `--additional-config` option -- almost all administration commands support the `--additional-config` option, which you can use to provide a path (full path, local path, or symlinks) to a file with additional configuration.
+The file format should be the same as _neo4j.conf_ (or _neo4j-admin.conf_).
+The file must be readable by the user running the admin command.
 * _neo4j-admin.conf_ -- a configuration file located in the same directory as the `neo4j.conf` file, which you can use to provide administration-task-specific settings.
 * Some commands also support a command-specific configuration file. Such files are also looked for in the same directory as the _neo4j.conf_ file.
 The following table lists command-specific configuration files:
diff --git a/modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc b/modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc
@@ -51,7 +51,7 @@ The `neo4j-admin database migrate` command has the following options:
 | Option
 | Description
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 
 |--expand-commands
diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
@@ -130,7 +130,7 @@ For more information, please contact Neo4j Professional Services.
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
@@ -648,7 +648,7 @@ If the database into which you import does not exist prior to importing, you mus
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc
@@ -36,7 +36,7 @@ The `neo4j-admin server memory-recommendation` command has the following options
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-report.adoc b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-report.adoc
@@ -134,7 +134,7 @@ The `neo4j-admin server report` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc
@@ -53,7 +53,7 @@ The `neo4j-admin database info` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/unbind.adoc b/modules/ROOT/pages/tools/neo4j-admin/unbind.adoc
@@ -29,7 +29,7 @@ The `neo4j-admin server unbind` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/upload-to-aura.adoc b/modules/ROOT/pages/tools/neo4j-admin/upload-to-aura.adoc
@@ -73,7 +73,7 @@ The `neo4j-admin database upload` command has the following options:
 | Description
 | Default
 
-|--additional-config=<file>
+|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
 |Configuration file with additional configuration.
 |
 

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ Aggregates a chain of backup artifacts into a single artifact.`
`59`	`59`	`\| Description`
`60`	`60`	`\| Default`
`61`	`61`
`62`		`-\|--additional-config=<file>`
	`62`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`63`	`63`	`\|Configuration file with additional configuration.`
`64`	`64`	`\|`
`65`	`65`
`@@ -98,6 +98,8 @@ Consult Neo4j support before use.`
`98`	`98`	`\|`
`99`	`99`	`\|===`
`100`	`100`
	`101`	`+`
	`102`	`+`
`101`	`103`	`[NOTE]`
`102`	`104`	`====`
`103`	`105`	The `--from-path=<path>` option can also load backup artifacts from AWS S3 buckets (from Neo4j 5.19), Google Cloud storage buckets (from Neo4j 5.21), and Azure buckets (from Neo4j 5.24).
Original file line number	Diff line number	Diff line change
@@ -80,7 +80,7 @@ The `neo4j-admin database copy` command has the following options:
`80`	`80`	`\| Description`
`81`	`81`	`\| Default`
`82`	`82`
`83`		`-\|--additional-config=<file>`
	`83`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`84`	`84`	`\|Configuration file with additional configuration.`
`85`	`85`	`\|`
`86`	`86`
Original file line number	Diff line number	Diff line change
@@ -66,7 +66,7 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets
`66`	`66`	`\| Description`
`67`	`67`	`\| Default`
`68`	`68`
`69`		`-\|--additional-config=<file>`
	`69`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`70`	`70`	`\|Configuration file with additional configuration.`
`71`	`71`	`\|`
`72`	`72`
Original file line number	Diff line number	Diff line change
@@ -64,7 +64,7 @@ The `neo4j-admin database dump` command has the following options:
`64`	`64`	`\| Description`
`65`	`65`	`\| Default`
`66`	`66`
`67`		`-\|--additional-config=<file>`
	`67`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`68`	`68`	`\|Configuration file with additional configuration.`
`69`	`69`	`\|`
`70`	`70`
Original file line number	Diff line number	Diff line change
@@ -116,7 +116,7 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
`116`	`116`	`\| Description`
`117`	`117`	`\| Default`
`118`	`118`
`119`		`-\|--additional-config=<file>`
	`119`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`120`	`120`	`\|Configuration file with additional configuration.`
`121`	`121`	`\|`
`122`	`122`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ neo4j-admin database restore [-h] [--expand-commands]`
`68`	`68`	`\| Description`
`69`	`69`	`\| Default`
`70`	`70`
`71`		`-\|--additional-config=<file>`
	`71`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`72`	`72`	`\|Configuration file with additional configuration.`
`73`	`73`	`\|`
`74`	`74`
Original file line number	Diff line number	Diff line change
@@ -57,7 +57,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
`57`	`57`	`\| Description`
`58`	`58`	`\| Default`
`59`	`59`
`60`		`-\|--additional-config=<file>`
	`60`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`61`	`61`	`\|Configuration file with additional configuration.`
`62`	`62`	`\|`
`63`	`63`
Original file line number	Diff line number	Diff line change
@@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options:
`68`	`68`	`\|Allow command expansion in config value evaluation.`
`69`	`69`	`\|`
`70`	`70`
`71`		`-\|--additional-config=<file>`
	`71`	`+\|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]`
`72`	`72`	`\| Configuration file with additional configuration.`
`73`	`73`	`\|`
`74`	`74`