diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index c8469cbd4..53a9575da 100644 --- 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= +|--additional-config=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=` 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 index 04c25383a..61395e09d 100644 --- 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= +|--additional-config=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 index 205240ecf..055086383 100644 --- a/modules/ROOT/pages/backup-restore/inspect.adoc +++ b/modules/ROOT/pages/backup-restore/inspect.adoc @@ -66,7 +66,7 @@ The `` parameter can also inspect backups stored in AWS S3 buckets | Description | Default -|--additional-config= +|--additional-config=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 index 89bfb78b1..bba1f992a 100644 --- 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= +|--additional-config=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 index 90f3518f6..74280be36 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -116,7 +116,7 @@ If is "*", `neo4j-admin` will attempt to back up all databases of the | Description | Default -|--additional-config= +|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] |Configuration file with additional configuration. | @@ -196,7 +196,7 @@ For more information, see <>. [NOTE] ==== -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. +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. If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--path` option. diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc index 45317342f..64889d941 100644 --- 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= +|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] |Configuration file with additional configuration. | @@ -131,7 +131,7 @@ For more information, see <>. [NOTE] ==== -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. +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. If `--temp-path` is not set, a temporary directory is created inside the directory specified by the `--from-path` option. diff --git a/modules/ROOT/pages/backup-restore/restore-dump.adoc b/modules/ROOT/pages/backup-restore/restore-dump.adoc index 402c99542..dfede9d0c 100644 --- 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= +|--additional-config=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 index 1f446eb4e..a9d9fdb91 100644 --- 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= +|--additional-config=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 index 4b3826f88..b29f4756a 100644 --- 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 index 3c5390db4..aab61ff02 100644 --- 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= +|--additional-config=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 index 43fbd7299..f24e9ed1b 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc +++ b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc @@ -131,7 +131,7 @@ For more information, please contact Neo4j Professional Services. | Description | Default -|--additional-config= +|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] |Configuration file with additional configuration. | @@ -652,7 +652,7 @@ If the database into which you import does not exist prior to importing, you mus | Description | Default -|--additional-config= +|--additional-config=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 index 3ddbc3d24..4e6f6b4af 100644 --- 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= +|--additional-config=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 index ed60b7636..96b5b56aa 100644 --- 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= +|--additional-config=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 index 9495a0dbe..4e6f89db0 100644 --- 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= +|--additional-config=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 index 980399075..9fa51860d 100644 --- 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= +|--additional-config=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 index 0df7e2887..c423a0f51 100644 --- 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= +|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] |Configuration file with additional configuration. |