Neo4j Server

On a self-managed Neo4j Server you need to install and configure GDS manually.

  • If you have the Neo4j Enterprise Edition, you will find the GDS plugin bundled within the Neo4j Server distribution. The GDS plugin is located in the products directory. This is the Bundled installation option.

  • If you are using the Neo4j Community Edition, you must download GDS manually from the Neo4j Deployment Center. This is the Custom installation option.

Bundled installation

The GDS plugin is always compatible with the version of the Neo4j Server distribution with which it is bundled. To install the GDS plugin in a Neo4j Enterprise Edition installation, follow these steps:

All paths in the following instructions are relative to the Neo4j installation directory.

  1. Copy or move the file neo4j-graph-data-science-[version].jar from the products directory to the plugins directory.

  2. Add the following to your conf/neo4j.conf file:

    dbms.security.procedures.unrestricted=gds.*

    This configuration entry is necessary because the GDS library accesses low-level components of Neo4j to maximise performance.

  3. Check if the procedure allowlist is enabled in the conf/neo4j.conf file, namely if the dbms.security.procedures.allowlist option is not commented out with a leading # sign. In this case, add the GDS library to the allowlist:

    dbms.security.procedures.allowlist=gds.*

    You can find more information on allow listing in the Operations Manual.

  4. Restart the Neo4j Server, using for example bin/neo4j restart.

Custom installation

To install the GDS plugin in a Neo4j Community Edition installation, follow these steps:

All paths in the following instructions are relative to the Neo4j installation directory.

  1. Open the Neo4j Deployment Center and head to the Graph Data Science Self-Managed section.

  2. Check that the version of the Neo4j Graph Data Science Library is compatible with your Neo4j Server and download the compressed file.

  3. Decompress the file and move the neo4j-graph-data-science-[version].jar file into the plugins directory.

  4. Add the following to your conf/neo4j.conf file:

    dbms.security.procedures.unrestricted=gds.*

    This configuration entry is necessary because the GDS library accesses low-level components of Neo4j to maximise performance.

  5. Check if the procedure allowlist is enabled in the conf/neo4j.conf file, namely if the dbms.security.procedures.allowlist option is not commented out with a leading # sign. In this case, add the GDS library to the allowlist:

    dbms.security.procedures.allowlist=gds.*

    You can find more information on allow listing in the Operations Manual.

  6. Restart the Neo4j Server, using for example bin/neo4j restart.