From 5aaa7306360a403e2f1754572ea4b3a828092408 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 30 Sep 2025 11:10:45 +0100 Subject: [PATCH 1/4] Improve the Configure plugins page and document Fleet management --- modules/ROOT/pages/configuration/plugins.adoc | 101 +++++++++++++----- 1 file changed, 74 insertions(+), 27 deletions(-) diff --git a/modules/ROOT/pages/configuration/plugins.adoc b/modules/ROOT/pages/configuration/plugins.adoc index 695ba5fb0..2efc6fd61 100644 --- a/modules/ROOT/pages/configuration/plugins.adoc +++ b/modules/ROOT/pages/configuration/plugins.adoc @@ -2,20 +2,28 @@ = Configure plugins :description: This page describes how to load plugins to a Neo4j deployment. -Neo4j Enterprise Edition comes bundled with a range of pre-installed products, such as Graph Data Science library and Bloom, which can be used to extend the Neo4j capabilities. -The JAR files for these products are located in the _products_ folder and can be installed as plugins. +== Overview -Neo4j Community Edition comes with the APOC plugin only in the _labs_ directory. +Plugins are Java Archive (_.jar_) files that extend the functionality of Neo4j by adding new features and capabilities, such as graph algorithms, data integration, and visualization tools. -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. +Neo4j Community Edition (CE) comes with a range of pre-installed products, such as Gen AI, Graph Data Science, and Fleet management in the _products_ directory and the APOC Core jar file in the _labs_ directory. [NOTE] ==== -Bloom Enterprise and GDS Enterprise require a license activation key. -Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you]. +Using the Fleet management plugin in Neo4j CE deployments is subject to some limitations due to the limited set of features, such as no metrics being available. +Also, it is offered on a best-effort basis. +Neo4j does not offer any technical support for it. ==== +Neo4j Enterprise Edition (EE) comes with Graph Data Science Enterprise, Bloom, Gen AI, and Fleet management, located in the _products_ directory, and the APOC Core jar file in the _labs_ directory. +Some of these plugins, Bloom and GDS Enterprise require a license activation key. +Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you]. + +If you want to use your own plugins or other supported 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. + +== Supported plugins + The following plugins are supported: .Supported Neo4j plugins @@ -28,16 +36,21 @@ The following plugins are supported: | | link:https://neo4j.com/labs/apoc/5/[APOC Extended user guide (Labs project)] -| APOC +| APOC Core | `apoc` | -| link:https://neo4j.com/docs/apoc/current/[APOC user guide] +| link:https://neo4j.com/docs/apoc/current/[APOC Core documentation] -| Bloom Enterprise footnote:[You can also get basic access to Bloom via Graph Apps in Neo4j Desktop without a license key. See link:{neo4j-docs-base-uri}/bloom-user-guide/current/bloom-installation/bloom-deployment-modes/[Bloom deployment modes] for more details.] +| Bloom Enterprise footnote:[You can also get basic access to Bloom via Graph Apps in Neo4j Desktop or the link:http://console-preview.neo4j.io/self-managed[Neo4j Aura console] without a license key. See link:{neo4j-docs-base-uri}/bloom-user-guide/current/bloom-installation/bloom-deployment-modes/[Bloom deployment modes] and for more details.] | `bloom` | {check-mark} | link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom] +| Fleet management +| `fleet-management` +| +| link:{neo4j-docs-base-uri}/aura/fleet-management/setup/[Fleet management] + | GenAI | `genai` | @@ -67,6 +80,7 @@ The following plugins are supported: | `n10s` | | link:https://neo4j.com/labs/neosemantics/[Neo Semantics] + |=== For more information on using plugins in a different Neo4j setup, see: @@ -78,43 +92,76 @@ For more information on using plugins in a different Neo4j setup, see: == Install and configure plugins -Here are the steps to enable the plugins: +To install and configure plugins in a Neo4j deployment, follow these steps: . Move or copy the plugins (_.jar files_) from _/products_ and _/labs_ to the _/plugins_ directory. See xref:configuration/file-locations.adoc[Default file locations] for more information. -. Add the following lines in _/conf/neo4j.conf_: +. Configure the plugins that you want to enable by adding and uncommenting the following settings in the _neo4j.conf_ file: + [source, properties] ---- -# to enable GDS: +# Add the plugin that you want to enable to the unrestricted procedures setting. +# If the plugin requires a license key, add the path to the license key file as well. +# If dbms.security.procedures.allowlist is set in your configuration, also add the plugin to this setting, otherwise no change is needed. By default, all procedures are loaded. -* dbms.security.procedures.unrestricted=gds.* -* dbms.security.procedures.allowlist=gds.* -* gds.enterprise.license_file=/path/to/my/license/keyfile +# to enable APOC: +# * dbms.security.procedures.unrestricted=apoc.* +# * dbms.security.procedures.allowlist=apoc.* +# to enable APOC Extended: +# * dbms.security.procedures.unrestricted=apoc.*,apoc.extended.* +# * dbms.security.procedures.allowlist=apoc.*,apoc.extended.* # to enable Bloom: +# * dbms.security.procedures.unrestricted=bloom.* +# * dbms.security.procedures.allowlist=bloom.* +# * dbms.bloom.license_file=/path/to/my/license/keyfile -* dbms.security.procedures.unrestricted=bloom.* -* dbms.bloom.license_file=/path/to/my/license/keyfile +# to enable Fleet management: +# * dbms.security.procedures.unrestricted=fleetManagement.* +# * dbms.security.procedures.allowlist=fleetManagement.* +# to enable GDS: +# * dbms.security.procedures.unrestricted=gds.* +# * dbms.security.procedures.allowlist=gds.* +# * gds.enterprise.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 +# * dbms.security.procedures.unrestricted=gds.*,bloom.* +# * dbms.security.procedures.allowlist=gds.*,bloom.* +# * gds.enterprise.license_file=/path/to/my/license/keyfile +# * dbms.bloom.license_file=/path/to/my/license/keyfile + +# to enable GenAI: +# * dbms.security.procedures.unrestricted=genai.* +# * dbms.security.procedures.allowlist=genai.* + +# to enable GraphQL: +# * dbms.security.procedures.unrestricted=graphql.* +# * dbms.security.procedures.allowlist=graphql.* + +# to enable Neo Semantics: +# * dbms.security.procedures.unrestricted=n10s.* +# * dbms.security.procedures.allowlist=n10s.* ---- -. Install the plugins. + -Refer to link:https://neo4j.com/docs/bloom-user-guide/current/bloom-installation/[Bloom documentation], link:https://neo4j.com/docs/graph-data-science/current/installation/[GDS documentation] for more details on how to install them. - +For more information on configuring the plugins, see the respective documentation: ++ +* link:https://neo4j.com/docs/bloom-user-guide/current/bloom-installation/[Bloom documentation] +* link:https://neo4j.com/docs/graph-data-science/current/installation/[GDS documentation] +* link:https://neo4j.com/docs/aura/fleet-management/setup/[Fleet management documentation] +* link:https://neo4j.com/docs/cypher-manual/current/genai-integrations/[GenAI documentation] +* link:https://neo4j.com/docs/apoc/current/installation/[APOC documentation] +* link:https://neo4j.com/labs/apoc/5/installation/[APOC extended documentation] +* link:https://neo4j.com/docs/graphql/current/[GraphQL documentation] +* link:https://neo4j.com/labs/neosemantics/[Neo Semantics documentation] + +. Restart Neo4j for the plugins to be loaded and available for use. ++ [NOTE] ==== 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. ==== - From 5c8ef80c11d8b2e35f0372ac9e1c7e50c102987b Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 30 Sep 2025 11:20:39 +0100 Subject: [PATCH 2/4] fix the footnote --- modules/ROOT/pages/configuration/plugins.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/configuration/plugins.adoc b/modules/ROOT/pages/configuration/plugins.adoc index 2efc6fd61..6b2bb76b4 100644 --- a/modules/ROOT/pages/configuration/plugins.adoc +++ b/modules/ROOT/pages/configuration/plugins.adoc @@ -41,7 +41,7 @@ The following plugins are supported: | | link:https://neo4j.com/docs/apoc/current/[APOC Core documentation] -| Bloom Enterprise footnote:[You can also get basic access to Bloom via Graph Apps in Neo4j Desktop or the link:http://console-preview.neo4j.io/self-managed[Neo4j Aura console] without a license key. See link:{neo4j-docs-base-uri}/bloom-user-guide/current/bloom-installation/bloom-deployment-modes/[Bloom deployment modes] and for more details.] +| Bloom Enterprise footnote:[You can also get basic access, without a license key, to link:{neo4j-docs-base-uri}/bloom-user-guide/current/bloom-installation/bloom-deployment-modes/[Bloom via Graph Apps] in Neo4j Desktop or the link:http://console-preview.neo4j.io/self-managed[Neo4j Aura console].] | `bloom` | {check-mark} | link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom] From 6b98968d352eed12d61a69504b638d2d9e852c3e Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Wed, 1 Oct 2025 08:50:11 +0100 Subject: [PATCH 3/4] apply suggestions from review --- modules/ROOT/pages/configuration/plugins.adoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/configuration/plugins.adoc b/modules/ROOT/pages/configuration/plugins.adoc index 6b2bb76b4..5f15a6c5f 100644 --- a/modules/ROOT/pages/configuration/plugins.adoc +++ b/modules/ROOT/pages/configuration/plugins.adoc @@ -4,9 +4,12 @@ == Overview -Plugins are Java Archive (_.jar_) files that extend the functionality of Neo4j by adding new features and capabilities, such as graph algorithms, data integration, and visualization tools. +Plugins are Java Archive (_.jar_) files that extend the functionality of Neo4j by adding new features and capabilities, such as graph algorithms, data integration, visualization, and monitoring tools. -Neo4j Community Edition (CE) comes with a range of pre-installed products, such as Gen AI, Graph Data Science, and Fleet management in the _products_ directory and the APOC Core jar file in the _labs_ directory. +Both Neo4j Community Edition (CE) and Enterprise Edition (EE) come with a range of pre-installed products, such as Gen AI, Graph Data Science, and Fleet management in the _products_ directory and the APOC Core jar file in the _labs_ directory. +The Fleet management jar file is bundled with the Neo4j server starting with Neo4j 5.26.10 and 2025.07.0 onwards. +If you are using an earlier version of Neo4j, you can get the matching version of the Fleet management plugin by following the download link that matches your server version in the *Monitor Deployment* wizard in the Aura console. +See link:{neo4j-docs-base-uri}/aura/fleet-management/setup/[Aura documentation -> Fleet Management -> Add a deployment] for more information. [NOTE] ==== @@ -15,12 +18,11 @@ Also, it is offered on a best-effort basis. Neo4j does not offer any technical support for it. ==== -Neo4j Enterprise Edition (EE) comes with Graph Data Science Enterprise, Bloom, Gen AI, and Fleet management, located in the _products_ directory, and the APOC Core jar file in the _labs_ directory. -Some of these plugins, Bloom and GDS Enterprise require a license activation key. +Some of these plugins, such as Bloom and GDS Enterprise require a license activation key. Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you]. -If you want to use your own plugins or other supported 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. +If you want to use your own plugins or any of the other supported plugins, such as GraphQL, Neo4j Semantics, and Apoc Extended, ensure that you download and add them to the _plugins_ directory. +See their respective documentation for more information. == Supported plugins @@ -29,7 +31,7 @@ The following plugins are supported: .Supported Neo4j plugins [options="header",cols="d,m,b,a"] |=== -|Name |Key | License activation key required | Further information +|Name |Key | License activation key required | Documentation | APOC Extended | `apoc-extended` @@ -149,7 +151,7 @@ See xref:configuration/file-locations.adoc[Default file locations] for more info For more information on configuring the plugins, see the respective documentation: + * link:https://neo4j.com/docs/bloom-user-guide/current/bloom-installation/[Bloom documentation] -* link:https://neo4j.com/docs/graph-data-science/current/installation/[GDS documentation] +* link:https://neo4j.com/docs/graph-data-science/current/installation/neo4j-server/[GDS documentation] * link:https://neo4j.com/docs/aura/fleet-management/setup/[Fleet management documentation] * link:https://neo4j.com/docs/cypher-manual/current/genai-integrations/[GenAI documentation] * link:https://neo4j.com/docs/apoc/current/installation/[APOC documentation] From e6f08a10a816fe112134853ea94a3cc5b0b1127f Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Wed, 1 Oct 2025 09:15:46 +0100 Subject: [PATCH 4/4] further improvements --- modules/ROOT/pages/configuration/plugins.adoc | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/configuration/plugins.adoc b/modules/ROOT/pages/configuration/plugins.adoc index 5f15a6c5f..067aec39f 100644 --- a/modules/ROOT/pages/configuration/plugins.adoc +++ b/modules/ROOT/pages/configuration/plugins.adoc @@ -98,14 +98,23 @@ To install and configure plugins in a Neo4j deployment, follow these steps: . Move or copy the plugins (_.jar files_) from _/products_ and _/labs_ to the _/plugins_ directory. See xref:configuration/file-locations.adoc[Default file locations] for more information. ++ +[NOTE] +==== +Some plugins are not bundled with Neo4j and need to be downloaded separately, such as the APOC Extended, GraphQL, and Neo Semantics plugins. +See their respective documentation for more information. +==== + +. Configure the plugins that you want to enable by modifying the following setting to the _neo4j.conf_ file: -. Configure the plugins that you want to enable by adding and uncommenting the following settings in the _neo4j.conf_ file: +* Add the plugin that you want to enable to the xref:configuration/configuration-settings.adoc#config_dbms.security.procedures.unrestricted[`dbms.security.procedures.unrestricted`] setting. +* If the plugin requires a license key, add the path to the license key file as well. +* If xref:configuration/configuration-settings.adoc#config_dbms.security.procedures.allowlist[`dbms.security.procedures.allowlist`] is set in your configuration, also add the plugin to this setting, otherwise no change is needed. +By default, all procedures are loaded. +For more information, see xref:security/securing-extensions.adoc[Securing extensions]. + [source, properties] ---- -# Add the plugin that you want to enable to the unrestricted procedures setting. -# If the plugin requires a license key, add the path to the license key file as well. -# If dbms.security.procedures.allowlist is set in your configuration, also add the plugin to this setting, otherwise no change is needed. By default, all procedures are loaded. # to enable APOC: # * dbms.security.procedures.unrestricted=apoc.*