Configure plugins

Neo4j distributions come bundled with a range of pre-installed products, such as Graph Data Science library, Bloom, and Ops Manager, which can be used to extend the Neo4j capabilities. The JAR files for these products are located in the product and labs folders and can be installed as plugins.

If you want to use your own plugins, ensure that you add them to the designated plugins directory. This directory serves as the central location where Neo4j looks for and loads the plugins at startup.

Bloom and GDS Enterprise require a license activation key to become available to the user within Neo4j. Reach out to your Neo4j account representative or request a representative to contact you.

The following plugins are supported:

Table 1. Supported Neo4j plugins
Name Key License required Further information

APOC Extended

apoc-extended

APOC

apoc

Bloom

bloom

GenAI

genai

GraphQL

graphql

Graph Algorithms

graph-algorithms

Graph Data Science

graph-data-science

Neo Semantics

n10s

For more information on using plugins in a different Neo4j setup, see:

Install and configure plugins

Here are the steps to enable the plugins:

  1. Move or copy the plugins (.jar files) from <NEO4J_HOME>/products and <NEO4J_HOME>/labs to the <NEO4J_HOME>/plugins directory. See the table in File locations for more information.

  2. Add the following lines in $NEO4J_HOME/conf/neo4j.conf:

    # to enable GDS:
    
    * dbms.security.procedures.unrestricted=gds.*
    * dbms.security.procedures.allowlist=gds.*
    * gds.enterprise.license_file=/path/to/my/license/keyfile
    
    
    #  to enable Bloom:
    
    * dbms.security.procedures.unrestricted=bloom.*
    * dbms.bloom.license_file=/path/to/my/license/keyfile
    
    
    #  to enable both GDS and Bloom:
    
    * dbms.security.procedures.unrestricted=gds.*,bloom.*
    * dbms.security.procedures.allowlist=gds.*
    * gds.enterprise.license_file=/path/to/my/license/keyfile
    * dbms.bloom.license_file=/path/to/my/license/keyfile
  3. Install the plugins.

    Refer to Bloom documentation, GDS documentation, and Neo4j Ops Manager documentation for more details on how to install them.

All installed plugins will automatically be loaded every time Neo4j is started. Because of that, the number of plugins may impact the startup time. Install only the necessary plugins to avoid performance issues.