Skip to content

Commit 2a5564b

Browse files
renetapopovarenetapopova
authored
Improve the Configure plugins page and document Fleet management (#2627) (#2644)
1 parent 26ad9d3 commit 2a5564b

File tree

1 file changed

+94
-55
lines changed

1 file changed

+94
-55
lines changed

‎modules/ROOT/pages/configuration/plugins.adoc‎

Lines changed: 94 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,119 +2,158 @@
22
= Configure plugins
33
:description: This page describes how to load plugins to a Neo4j deployment.
44

5-
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.
6-
The JAR files for these products are located in the _products_ folder and can be installed as plugins.
5+
== Overview
76

8-
Neo4j Community Edition comes with the APOC plugin only in the _labs_ directory.
7+
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.
98

10-
If you want to use your own plugins, ensure that you add them to the designated _plugins_ directory.
11-
This directory serves as the central location where Neo4j looks for and loads the plugins at startup.
9+
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. +
10+
The Fleet management jar file is bundled with the Neo4j server starting with Neo4j 5.26.10 and 2025.07.0 onwards.
11+
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.
12+
See link:{neo4j-docs-base-uri}/aura/fleet-management/setup/[Aura documentation -> Fleet Management -> Add a deployment] for more information.
1213

1314
[NOTE]
1415
====
15-
Bloom Enterprise and GDS Enterprise require a license activation key.
16-
Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you].
16+
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.
17+
Also, it is offered on a best-effort basis.
18+
Neo4j does not offer any technical support for it.
1719
====
1820

21+
Some of these plugins, such as Bloom and GDS Enterprise require a license activation key.
22+
Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you].
23+
24+
If you want to use your own plugins or any of the other supported plugins, such as APOC Extended and Neo4jsemantics, ensure that you download and add them to the _plugins_ directory.
25+
See their respective documentation for more information.
26+
27+
[[supported-plugins]]
28+
== Supported plugins and documentation
29+
1930
The following plugins are supported:
2031

21-
.Supported Neo4j plugins
32+
.Supported Neo4j plugins and documentation
2233
[options="header",cols="d,m,b,a"]
2334
|===
24-
|Name |Key | License activation key required | Further information
35+
|Name |Key | License activation key required | Documentation
36+
37+
| APOC Core
38+
| `apoc`
39+
|
40+
| link:https://neo4j.com/docs/apoc/5/[APOC Core documentation]
2541

2642
| APOC Extended
2743
| `apoc-extended`
2844
|
2945
| link:https://neo4j.com/labs/apoc/5/[APOC Extended user guide (Labs project)]
3046

31-
| APOC
32-
| `apoc`
33-
|
34-
| link:https://neo4j.com/docs/apoc/current/[APOC user guide]
35-
36-
| 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.]
47+
| Bloom
3748
| `bloom`
38-
| {check-mark}
39-
| link:{neo4j-docs-base-uri}/bloom-user-guide/current/[Neo4j Bloom]
40-
41-
| GenAI footnote:[Introduced in 5.17 in Enterprise Edition only. From Neo4j 5.23, the GenAI plugin is also available in Neo4j Community Edition.]
42-
| `genai`
43-
|
44-
| link:{neo4j-docs-base-uri}/cypher-manual/5/genai-integrations/[Cypher Manual -> GenAI integrations].
49+
| {check-mark} 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].]
50+
| link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom]
4551

46-
| GraphQL
47-
| `graphql`
52+
| Fleet management
53+
| `fleet-management`
4854
|
49-
| link:{neo4j-docs-base-uri}/graphql/current/[Neo4j GraphQL Library]
55+
| link:{neo4j-docs-base-uri}/aura/fleet-management/setup/[Fleet management]
5056

51-
| Graph Algorithms
52-
| `graph-algorithms`
57+
| GenAI
58+
| `genai`
5359
|
54-
| link:{neo4j-docs-base-uri}/graph-data-science/current/installation/installation-enterprise-edition/[The Neo4j Graph Data Science Library Manual]
60+
| link:{neo4j-docs-base-uri}/cypher-manual/5/genai-integrations/[Cypher Manual -> GenAI integrations].
5561

5662
| Graph Data Science
5763
| `graph-data-science`
58-
|
59-
| link:{neo4j-docs-base-uri}/graph-data-science/current/installation/#_installation_methods[Graph Data Science]
60-
61-
| Graph Data Science Enterprise
62-
| `graph-data-science`
63-
| {check-mark}
64-
| link:{neo4j-docs-base-uri}/graph-data-science/current/[GDS Enterprise Edition]
64+
| {check-mark} footnote:[Graph Data Science is available in both Neo4j CE and EE editions. The Enterprise Edition includes additional features and requires a license key.]
65+
| link:{neo4j-docs-base-uri}/graph-data-science/2.13/installation/#_installation_methods[Graph Data Science]
6566

66-
| Neo Semantics
67+
| Neosemantics
6768
| `n10s`
6869
|
69-
| link:https://neo4j.com/labs/neosemantics/[Neo Semantics]
70+
| link:https://neo4j.com/labs/neosemantics/[Neosemantics]
71+
7072
|===
7173

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

74-
* link:{neo4j-docs-base-uri}/desktop/current/operations/instance-management/#_install_plugins[Neo4j Desktop -> Install a plugin]
76+
* link:{neo4j-docs-base-uri}/desktop/1.6/operations/install-plugin/[Neo4j Desktop -> Install a plugin]
7577
* xref:docker/plugins.adoc[Docker -> Plugins]
7678
* xref:/kubernetes/plugins.adoc[Kubernetes -> Plugins]
7779
* link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/project-setup/#_build_dependencies[Java-Reference -> Setting up a plugin project].
7880

7981
== Install and configure plugins
8082

81-
Here are the steps to enable the plugins:
83+
To install and configure plugins in a Neo4j deployment, follow these steps:
8284

8385
. Move or copy the plugins (_.jar files_) from _<NEO4J_HOME>/products_ and _<NEO4J_HOME>/labs_ to the _<NEO4J_HOME>/plugins_ directory.
8486
See xref:configuration/file-locations.adoc[Default file locations] for more information.
87+
+
88+
[NOTE]
89+
====
90+
Some plugins are not bundled with Neo4j and need to be downloaded separately, such as APOC Extended and Neosemantics.
91+
See <<supported-plugins, Supported plugins and documentation>> for more information and links to the respective documentation.
92+
====
8593

86-
. Add the following lines in _<NEO4J_HOME>/conf/neo4j.conf_:
94+
. Configure the plugins that you want to enable by modifying the following setting to the _neo4j.conf_ file:
95+
96+
* 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.
97+
* If the plugin requires a license key, add the path to the license key file as well.
98+
* 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.
99+
By default, all procedures are loaded.
100+
For more information, see xref:security/securing-extensions.adoc[Securing extensions].
87101
+
88102
[source, properties]
89103
----
90-
# to enable GDS:
91104
92-
* dbms.security.procedures.unrestricted=gds.*
93-
* dbms.security.procedures.allowlist=gds.*
94-
* gds.enterprise.license_file=/path/to/my/license/keyfile
105+
# to enable APOC core:
106+
# * dbms.security.procedures.unrestricted=apoc.*
107+
# * dbms.security.procedures.allowlist=apoc.*
95108
109+
# to enable APOC Extended:
110+
# * dbms.security.procedures.unrestricted=apoc.*,apoc.extended.*
111+
# * dbms.security.procedures.allowlist=apoc.*,apoc.extended.*
96112
97113
# to enable Bloom:
114+
# * dbms.security.procedures.unrestricted=bloom.*
115+
# * dbms.security.procedures.allowlist=bloom.*
116+
# * dbms.bloom.license_file=/path/to/my/license/keyfile
98117
99-
* dbms.security.procedures.unrestricted=bloom.*
100-
* dbms.bloom.license_file=/path/to/my/license/keyfile
118+
# to enable Fleet management:
119+
# * dbms.security.procedures.unrestricted=fleetManagement.*
120+
# * dbms.security.procedures.allowlist=fleetManagement.*
101121
122+
# to enable GDS:
123+
# * dbms.security.procedures.unrestricted=gds.*
124+
# * dbms.security.procedures.allowlist=gds.*
125+
# * gds.enterprise.license_file=/path/to/my/license/keyfile
102126
103127
# to enable both GDS and Bloom:
104-
105-
* dbms.security.procedures.unrestricted=gds.*,bloom.*
106-
* dbms.security.procedures.allowlist=gds.*
107-
* gds.enterprise.license_file=/path/to/my/license/keyfile
108-
* dbms.bloom.license_file=/path/to/my/license/keyfile
128+
# * dbms.security.procedures.unrestricted=gds.*,bloom.*
129+
# * dbms.security.procedures.allowlist=gds.*,bloom.*
130+
# * gds.enterprise.license_file=/path/to/my/license/keyfile
131+
# * dbms.bloom.license_file=/path/to/my/license/keyfile
132+
133+
# to enable GenAI:
134+
# * dbms.security.procedures.unrestricted=genai.*
135+
# * dbms.security.procedures.allowlist=genai.*
136+
137+
# to enable Neosemantics:
138+
# * dbms.security.procedures.unrestricted=n10s.*
139+
# * dbms.security.procedures.allowlist=n10s.*
109140
----
110-
. Install the plugins.
111141
+
112-
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.
113-
142+
For more information on configuring the plugins, see the respective documentation:
143+
+
144+
* link:https://neo4j.com/docs/apoc/5/installation/[APOC Core documentation]
145+
* link:https://neo4j.com/labs/apoc/5/installation/[APOC Extended documentation]
146+
* link:https://neo4j.com/docs/bloom-user-guide/current/bloom-installation/[Bloom documentation]
147+
* link:https://neo4j.com/docs/aura/fleet-management/setup/[Fleet management documentation]
148+
* link:https://neo4j.com/docs/graph-data-science/2.13/installation/neo4j-server/[GDS documentation]
149+
* link:https://neo4j.com/docs/cypher-manual/5/genai-integrations/[GenAI documentation]
150+
* link:https://neo4j.com/labs/neosemantics/[Neosemantics documentation]
151+
152+
. Restart Neo4j for the plugins to be loaded and available for use.
153+
+
114154
[NOTE]
115155
====
116156
All installed plugins will automatically be loaded every time Neo4j is started.
117157
Because of that, the number of plugins may impact the startup time.
118158
Install only the necessary plugins to avoid performance issues.
119159
====
120-

0 commit comments

Comments
 (0)