Skip to content

Strip Tools section out and put the pages in the relevant places (#2213) #2227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,11 @@
** xref:configuration/ports.adoc[]
** xref:configuration/connectors.adoc[]
** xref:configuration/set-initial-password.adoc[]
** xref:configuration/neo4j-admin-memrec.adoc[]
** xref:configuration/plugins.adoc[Plugins]
** xref:configuration/dynamic-settings.adoc[]
** xref:configuration/migrate-configuration.adoc[]
** xref:configuration/validate-config.adoc[]
** xref:configuration/configuration-settings.adoc[]
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
*** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings]
Expand All @@ -103,6 +106,8 @@
*** xref:configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]
*** xref:configuration/configuration-settings.adoc#_transaction_log_settings[Transaction log settings]

* xref:import.adoc[]

* xref:database-administration/index.adoc[]
** xref:database-administration/syntax.adoc[]
** Standard databases
Expand All @@ -112,6 +117,8 @@
*** xref:database-administration/standard-databases/listing-databases.adoc[]
*** xref:database-administration/standard-databases/alter-databases.adoc[]
*** xref:database-administration/standard-databases/delete-databases.adoc[]
*** xref:database-administration/standard-databases/migrate-database.adoc[]
*** xref:database-administration/standard-databases/upload-to-aura.adoc[]
*** xref:database-administration/standard-databases/wait-options.adoc[]
*** xref:database-administration/standard-databases/configuration-parameters.adoc[]
*** xref:database-administration/standard-databases/errors.adoc[]
Expand All @@ -135,6 +142,7 @@
** xref:database-internals/transaction-logs.adoc[]
** xref:database-internals/checkpointing.adoc[]
** xref:database-internals/store-formats.adoc[]
** xref:database-internals/neo4j-admin-store-info.adoc[]

* xref:clustering/index.adoc[]
** xref:clustering/introduction.adoc[]
Expand All @@ -158,6 +166,7 @@
** xref:clustering/server-syntax.adoc[]
** xref:clustering/clustering-advanced/index.adoc[]
*** xref:clustering/clustering-advanced/default-database.adoc[]
*** xref:clustering/clustering-advanced/unbind.adoc[]
*** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[]
*** xref:clustering/clustering-advanced/reconciler.adoc[]
** xref:clustering/glossary.adoc[]
Expand All @@ -168,6 +177,7 @@
** xref:backup-restore/online-backup.adoc[]
** xref:backup-restore/aggregate.adoc[]
** xref:backup-restore/inspect.adoc[]
** xref:backup-restore/consistency-checker.adoc[]
** xref:backup-restore/restore-backup.adoc[]
** xref:backup-restore/offline-backup.adoc[]
** xref:backup-restore/restore-dump.adoc[]
Expand Down Expand Up @@ -221,23 +231,13 @@
** xref:monitoring/query-management.adoc[]
** xref:monitoring/connection-management.adoc[]
** xref:monitoring/background-jobs.adoc[]
** xref:monitoring/neo4j-admin-report.adoc[]
// ** xref:monitoring/cluster/index.adoc[]
// *** xref:monitoring/cluster/procedures.adoc[]
// *** xref:monitoring/cluster/http-endpoints.adoc[]

* xref:tools/index.adoc[]
** xref:tools/neo4j-admin/index.adoc[]
*** xref:tools/neo4j-admin/consistency-checker.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-report.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-import.adoc[]
*** xref:tools/neo4j-admin/unbind.adoc[]
*** xref:tools/neo4j-admin/upload-to-aura.adoc[]
*** xref:tools/neo4j-admin/migrate-database.adoc[]
*** xref:tools/neo4j-admin/migrate-configuration.adoc[]
*** xref:tools/neo4j-admin/validate-config.adoc[]
** xref:tools/cypher-shell.adoc[]
* xref:neo4j-admin-neo4j-cli.adoc[]
* xref:cypher-shell.adoc[]

* xref:procedures.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ server.default_listen_address=127.0.0.1
+
[NOTE]
====
Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`.
Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`.
====
+
. Start Neo4j:
Expand Down Expand Up @@ -86,7 +86,7 @@ bin/neo4j start
[[password-recovery-for-admin]]
== Recover a lost password

You can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user.
You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user.

[NOTE]
====
Expand Down Expand Up @@ -124,7 +124,7 @@ ALTER USER neo4j SET PASSWORD 'mynewpassword'
[[recover-unassigned-admin-role]]
== Recover an unassigned admin role

You can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user.
You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user.

[NOTE]
====
Expand Down Expand Up @@ -162,7 +162,7 @@ GRANT ROLE admin TO neo4j
[[recover-admin-role]]
== Recover the admin role

If you have removed the admin role from your system entirely, you can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities.
If you have removed the admin role from your system entirely, you can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/aggregate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Aggregates a chain of backup artifacts into a single artifact.
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:description: Describes the Neo4j consistency checker.
[[consistency-checker]]
= Consistency checker
= Check database consistency

You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a backup.
The `neo4j-admin` tool is located in the _/bin_ directory.
Expand Down Expand Up @@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options:
|Allow command expansion in config value evaluation.
|

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
| Configuration file with additional configuration.
|

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/copy-database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The `neo4j-admin database copy` command has the following options:
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/backup-restore/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This chapter describes the following:
* xref:backup-restore/online-backup.adoc[Back up an online database] -- How to back up an online database.
* xref:backup-restore/aggregate.adoc[Aggregate a database backup chain] - How to aggregate a backup chain into a single backup.
* xref:backup-restore/inspect.adoc[Inspect the metadata of a database backup file] -- How to inspect the metadata of a database backup file.
* xref:backup-restore/consistency-checker.adoc[Check database consistency] -- How to check the consistency of a database, backup, or a dump.
* xref:backup-restore/restore-backup.adoc[Restore a database backup] -- How to restore a database backup in a live Neo4j deployment.
* xref:backup-restore/offline-backup.adoc[Back up an offline database] -- How to back up an offline database.
* xref:backup-restore/restore-dump.adoc[Restore a database dump] -- How to restore a database dump in a live Neo4j deployment.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/inspect.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets,
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/offline-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The `neo4j-admin database dump` command has the following options:
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/planning.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This ensures that if for some reason your Neo4j DBMS crashes, you will be able t
== Backup and restore options

Neo4j supports backing up and restoring both online and offline databases.
It uses xref:tools/neo4j-admin/index.adoc[Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS.
It uses xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS.
All `neo4j-admin` commands must be invoked as the `neo4j` user to ensure the appropriate file permissions.

* `neo4j-admin database backup/restore` (Enterprise only) -– used for performing online backup (xref:backup-restore/modes.adoc#full-backup[full] and xref:backup-restore/modes.adoc#differential-backup[differential]) and restore operations.
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ neo4j-admin database restore [-h] [--expand-commands] [--verbose] [--overwrite-d
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down Expand Up @@ -100,7 +100,7 @@ The restore recovers transaction logs up to, but not including, the transaction
The restore recovers transactions that were committed before the provided timestamp.
|

| --source-database[=source-database-name]
| --source-database[=source-database-name]
|label:new[Introduced in 2025.02] A source database name. If the `--from-path` points to a folder containing backups for multiple databases, you must specify the database name to filter the artifacts.
|

Expand Down Expand Up @@ -299,7 +299,7 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Designated

If you have backed up a database with the option `--include-metadata`, you can manually restore the users and roles metadata.

From the _<NEO4J_HOME>_ directory, you run the Cypher script _data/scripts/databasename/restore_metadata.cypher_, which the `neo4j-admin database restore` command outputs, using xref:tools/cypher-shell.adoc[Cypher Shell]:
From the _<NEO4J_HOME>_ directory, you run the Cypher script _data/scripts/databasename/restore_metadata.cypher_, which the `neo4j-admin database restore` command outputs, using xref:cypher-shell.adoc[][Cypher Shell]:

*Using `cat` (UNIX)*
[source, shell, role=nocopy noplay]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/restore-dump.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e.
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
This section includes information about advanced deployments of a Neo4j Cluster.

* xref:clustering/clustering-advanced/default-database.adoc[Default database in a cluster] -- Details of the creation of the default database in a cluster.
* xref:clustering/clustering-advanced/unbind.adoc[Unbind a server] -- How to remove and archive the cluster state of a cluster server so that it can rebind to a cluster.
* xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Information about routing in multi-data center deployments.
* xref:clustering/clustering-advanced/reconciler.adoc[Reconciler] -- Details about the way database management operations are processed.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:description: How to remove cluster state data from a Neo4j server using `neo4j-admin server unbind`.
[role=enterprise-edition]
[[neo4j-admin-unbind]]
= Unbind a Neo4j cluster server
= Unbind a server

You can use the `neo4j-admin server unbind` command to remove and archive the cluster state of a cluster server so that it can rebind to a cluster.

Expand Down Expand Up @@ -39,7 +39,7 @@ The `neo4j-admin server unbind` command has the following options:
| Description
| Default

|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
|Configuration file with additional configuration.
|

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/clustering/disaster-recovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ It is important to get a `system` database that is as up-to-date as possible, so
[NOTE]
=====
This section of the disaster recovery guide uses `neo4j-admin` commands.
For more information about the used commands, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-commands[neo4j-admin commands].
For more information about the used commands, see xref:neo4j-admin-neo4j-cli.adoc#neo4j-admin-commands[neo4j-admin commands].
=====

. Shut down the Neo4j process on all servers.
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/clustering/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ This chapter describes the following:
* xref:clustering/server-syntax.adoc[Server commands reference] -- Reference of Cypher administrative commands to add and manage servers.
* xref:clustering/clustering-advanced/index.adoc[Advanced clustering] -- Some more advanced features of Neo4j clusters.
** xref:clustering/clustering-advanced/default-database.adoc[Default database in a cluster] -- The initial default database created when the DBMS starts for the first time.
** xref:clustering/clustering-advanced/unbind.adoc[Unbind a server] -- How to remove and archive the cluster state of a cluster server so that it can rebind to a cluster.
** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Clusters on mutli-data centers.
** xref:clustering/clustering-advanced/reconciler.adoc[Reconciler] -- An internal component that observes the requested state of a server and makes changes to the server to match that state.
* xref:clustering/glossary.adoc[Clustering glossary] -- A glossary of terms related to the Neo4j clustering.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/configuration/command-expansion.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ In this case, the execution stops and the server does not start.
* Errors for incorrect values -- The returned value is not the one expected for the setting.
In this case, the server does not start.

For more information, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-exit-codes[Exit codes].
For more information, see xref:neo4j-admin-neo4j-cli.adoc#neo4j-admin-exit-codes[Exit codes].
2 changes: 1 addition & 1 deletion modules/ROOT/pages/configuration/file-locations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For the Neo4j's uses of the Java Native Access (JNA) library, set `server.jvm.ad
[[neo4j-bin]]
=== Bin

The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:tools/cypher-shell.adoc[Cypher Shell] and xref:tools/neo4j-admin/index.adoc[Neo4j Admin].
The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:cypher-shell.adoc[][Cypher Shell] and xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin].

File permissions:: Read only and execute.

Expand Down
5 changes: 4 additions & 1 deletion modules/ROOT/pages/configuration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@ The topics described are:
* xref:configuration/ports.adoc[Ports] -- An overview of the ports relevant to a Neo4j installation.
* xref:configuration/connectors.adoc[Configure network connectors] -- How to configure network connectors for Neo4j.
* xref:configuration/set-initial-password.adoc[Set initial password] -- How to set an initial password.
* xref:configuration/plugins.adoc[Configure Neo4j plugins] -- How to load plugins to a Neo4j deployment.
* xref:configuration/neo4j-admin-memrec.adoc[Get initial memory recommendations] -- How to get initial memory recommendations for Neo4j.
* xref:configuration/plugins.adoc[Configure Neo4j plugins] -- How to load plugins into a Neo4j deployment.
* xref:configuration/dynamic-settings.adoc[Update dynamic settings] -- How to configure certain Neo4j parameters while Neo4j is running.
* xref:configuration/migrate-configuration.adoc[Migrate configurations] -- How to migrate configuration settings from a previous version of Neo4j to a new version.
* xref:configuration/validate-config.adoc[Validate configurations] -- How to validate Neo4j and Log4j configurations.
* xref:configuration/configuration-settings.adoc[Configuration settings] -- A complete reference of all configuration settings.

For a complete reference of Neo4j configuration settings, see xref:configuration/configuration-settings.adoc[All configuration settings].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[neo4j-admin-migrate-configuration]]
= Migrate the Neo4j configuration file
= Migrate configurations
:description: This chapter describes the `neo4j-admin server migrate-configuration` command.

You can use the `migrate-configuration` command to migrate a legacy Neo4j configuration file to the current format.
Expand Down
Loading