Install and configure Neo4j v5

Install Neo4j v5

For the initial installation, refer to the Neo4j v5 Operations Manual for methods of installing Neo4j.

Note that:

  • You should remove the default database if you will be migrating a database with the same name.

  • Neo4j v5.x runs on Java 17.

    If you have other Java applications running on the machine hosting Neo4j, ensure those applications are compatible with the Java version that your Neo4j is running on. Alternatively, you should configure it to run multiple JDKs on the same machine.

Migrate your configuration

Neo4j v5 changes many configuration settings - here’s a complete list of changes.

Neo4j Admin has a utility that can convert most of your v4.4 settings to v5 equivalents. For more information, see the Operations Manual → Migrate the Neo4j configuration file. The changes to clustering are such that it is recommended to configure those from scratch.

Steps for migrating v4.4 configuration files

  1. Copy the Neo4j v4.4 configuration file(s) to the new Neo4j v5 configuration directory.

    The default location that Neo4j looks for configuration files will depend on how Neo4j was installed:

  2. Use the neo4j-admin server migrate-configuration command in Neo4j v5 to migrate the configuration file to a v5.x-compatible format:

    $NEO4J_5_HOME/bin/neo4j-admin server migrate-configuration
  3. Check the report written to the console for messages related to settings that could not be converted.

Performance metrics

  • All metric names now include dbms or database namespaces, and the setting metrics.namespaces.enabled is removed.

    A complete list of metrics is available in Operations Manual → Metrics reference

  • All settings to enable and disable a metric type (metrics.*.enabled) are removed. They are replaced by server.metrics.filter, which takes a regex of what metrics to enable.

Autonomous cluster vs Causal cluster

Neo4j’s clustering has been significantly improved in v5, and the old causal clusters are no longer supported. If you are configuring a cluster, please read the clustering chapter in the Operations Manual to familiarise yourself with the new concepts: Operations Manual → Clustering.

The Migrate your configuration section above discusses how to move configuration settings from a v4.4 installation, to a new v5 installation. However, not all causal cluster settings can be automatically transferred to Neo4j v5.

Given the scope of the changes, it is recommended that you configure your new cluster from scratch.

Certificates

Copy all the files used for encryption, such as private key, public certificate, and the contents of the trusted and revoked directories over to Neo4j v5.

Plugins

  • If you are using custom plugins, make sure they are updated and compatible with Java 17, and place them in the /plugins directory.

  • Take note of the plugins you are using and make sure they are compatible with Neo4j v5.

  • If you are using Neo4j Bloom or Graph Data Science Library (GDSL), you can find the most recent versions for these products in the Neo4j Download Center.