Skip to content

Commit 87ddc9d

Browse files
committed
Add more info about -additional-config
1 parent 6e77473 commit 87ddc9d

16 files changed

+24
-20
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Aggregates a chain of backup artifacts into a single artifact.
5959
| Description
6060
| Default
6161

62-
|--additional-config=<file>
62+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
6363
|Configuration file with additional configuration.
6464
|
6565

@@ -98,6 +98,8 @@ Consult Neo4j support before use.
9898
|
9999
|===
100100

101+
102+
101103
[NOTE]
102104
====
103105
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).
@@ -106,7 +108,7 @@ For more information, see <<aggregate-backup-cloud-storage>>.
106108

107109
[NOTE]
108110
====
109-
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
111+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
110112
111113
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
112114

modules/ROOT/pages/backup-restore/copy-database.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The `neo4j-admin database copy` command has the following options:
8080
| Description
8181
| Default
8282

83-
|--additional-config=<file>
83+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
8484
|Configuration file with additional configuration.
8585
|
8686

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets
6666
| Description
6767
| Default
6868

69-
|--additional-config=<file>
69+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
7070
|Configuration file with additional configuration.
7171
|
7272

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The `neo4j-admin database dump` command has the following options:
6464
| Description
6565
| Default
6666

67-
|--additional-config=<file>
67+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
6868
|Configuration file with additional configuration.
6969
|
7070

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
116116
| Description
117117
| Default
118118

119-
|--additional-config=<file>
119+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
120120
|Configuration file with additional configuration.
121121
|
122122

@@ -196,7 +196,7 @@ For more information, see <<online-backup-cloud-storage>>.
196196

197197
[NOTE]
198198
====
199-
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
199+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
200200
201201
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--path` option.
202202

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ neo4j-admin database restore [-h] [--expand-commands]
6868
| Description
6969
| Default
7070

71-
|--additional-config=<file>
71+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
7272
|Configuration file with additional configuration.
7373
|
7474

@@ -131,7 +131,7 @@ For more information, see <<restore-cloud-storage>>.
131131

132132
[NOTE]
133133
====
134-
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
134+
Neo4j 5.24 introduces the `--temp-path` option to address potential issues related to disk space when performing backup-related commands, especially when cloud storage is involved.
135135
136136
If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option.
137137

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
5757
| Description
5858
| Default
5959

60-
|--additional-config=<file>
60+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
6161
|Configuration file with additional configuration.
6262
|
6363

modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options:
6868
|Allow command expansion in config value evaluation.
6969
|
7070

71-
|--additional-config=<file>
71+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
7272
| Configuration file with additional configuration.
7373
|
7474

modules/ROOT/pages/tools/neo4j-admin/index.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,9 @@ For instance, if the page cache of your DBMS is configured to a very high value
223223

224224
There are several options for overriding settings specified in the _neo4j.conf_ file using administration tasks:
225225

226-
* `--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.
226+
* `--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.
227+
The file format should be the same as _neo4j.conf_ (or _neo4j-admin.conf_).
228+
The file must be readable by the user running the admin command.
227229
* _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.
228230
* Some commands also support a command-specific configuration file. Such files are also looked for in the same directory as the _neo4j.conf_ file.
229231
The following table lists command-specific configuration files:

modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The `neo4j-admin database migrate` command has the following options:
5151
| Option
5252
| Description
5353

54-
|--additional-config=<file>
54+
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
5555
|Configuration file with additional configuration.
5656

5757
|--expand-commands

0 commit comments

Comments
 (0)