Skip to content

Commit 5aaa730

Browse files
committed
Improve the Configure plugins page and document Fleet management
1 parent 9437522 commit 5aaa730

File tree

1 file changed

+74
-27
lines changed

1 file changed

+74
-27
lines changed

modules/ROOT/pages/configuration/plugins.adoc

Lines changed: 74 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,28 @@
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, and visualization 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+
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.
1210

1311
[NOTE]
1412
====
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].
13+
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.
14+
Also, it is offered on a best-effort basis.
15+
Neo4j does not offer any technical support for it.
1716
====
1817

18+
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.
19+
Some of these plugins, Bloom and GDS Enterprise require a license activation key.
20+
Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you].
21+
22+
If you want to use your own plugins or other supported plugins, ensure that you add them to the designated _plugins_ directory.
23+
This directory serves as the central location where Neo4j looks for and loads the plugins at startup.
24+
25+
== Supported plugins
26+
1927
The following plugins are supported:
2028

2129
.Supported Neo4j plugins
@@ -28,16 +36,21 @@ The following plugins are supported:
2836
|
2937
| link:https://neo4j.com/labs/apoc/5/[APOC Extended user guide (Labs project)]
3038

31-
| APOC
39+
| APOC Core
3240
| `apoc`
3341
|
34-
| link:https://neo4j.com/docs/apoc/current/[APOC user guide]
42+
| link:https://neo4j.com/docs/apoc/current/[APOC Core documentation]
3543

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.]
44+
| 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.]
3745
| `bloom`
3846
| {check-mark}
3947
| link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom]
4048

49+
| Fleet management
50+
| `fleet-management`
51+
|
52+
| link:{neo4j-docs-base-uri}/aura/fleet-management/setup/[Fleet management]
53+
4154
| GenAI
4255
| `genai`
4356
|
@@ -67,6 +80,7 @@ The following plugins are supported:
6780
| `n10s`
6881
|
6982
| link:https://neo4j.com/labs/neosemantics/[Neo Semantics]
83+
7084
|===
7185

7286
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:
7892

7993
== Install and configure plugins
8094

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

8397
. Move or copy the plugins (_.jar files_) from _<NEO4J_HOME>/products_ and _<NEO4J_HOME>/labs_ to the _<NEO4J_HOME>/plugins_ directory.
8498
See xref:configuration/file-locations.adoc[Default file locations] for more information.
8599

86-
. Add the following lines in _<NEO4J_HOME>/conf/neo4j.conf_:
100+
. Configure the plugins that you want to enable by adding and uncommenting the following settings in the _neo4j.conf_ file:
87101
+
88102
[source, properties]
89103
----
90-
# to enable GDS:
104+
# Add the plugin that you want to enable to the unrestricted procedures setting.
105+
# If the plugin requires a license key, add the path to the license key file as well.
106+
# 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.
91107
92-
* dbms.security.procedures.unrestricted=gds.*
93-
* dbms.security.procedures.allowlist=gds.*
94-
* gds.enterprise.license_file=/path/to/my/license/keyfile
108+
# to enable APOC:
109+
# * dbms.security.procedures.unrestricted=apoc.*
110+
# * dbms.security.procedures.allowlist=apoc.*
95111
112+
# to enable APOC Extended:
113+
# * dbms.security.procedures.unrestricted=apoc.*,apoc.extended.*
114+
# * dbms.security.procedures.allowlist=apoc.*,apoc.extended.*
96115
97116
# to enable Bloom:
117+
# * dbms.security.procedures.unrestricted=bloom.*
118+
# * dbms.security.procedures.allowlist=bloom.*
119+
# * dbms.bloom.license_file=/path/to/my/license/keyfile
98120
99-
* dbms.security.procedures.unrestricted=bloom.*
100-
* dbms.bloom.license_file=/path/to/my/license/keyfile
121+
# to enable Fleet management:
122+
# * dbms.security.procedures.unrestricted=fleetManagement.*
123+
# * dbms.security.procedures.allowlist=fleetManagement.*
101124
125+
# to enable GDS:
126+
# * dbms.security.procedures.unrestricted=gds.*
127+
# * dbms.security.procedures.allowlist=gds.*
128+
# * gds.enterprise.license_file=/path/to/my/license/keyfile
102129
103130
# 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
131+
# * dbms.security.procedures.unrestricted=gds.*,bloom.*
132+
# * dbms.security.procedures.allowlist=gds.*,bloom.*
133+
# * gds.enterprise.license_file=/path/to/my/license/keyfile
134+
# * dbms.bloom.license_file=/path/to/my/license/keyfile
135+
136+
# to enable GenAI:
137+
# * dbms.security.procedures.unrestricted=genai.*
138+
# * dbms.security.procedures.allowlist=genai.*
139+
140+
# to enable GraphQL:
141+
# * dbms.security.procedures.unrestricted=graphql.*
142+
# * dbms.security.procedures.allowlist=graphql.*
143+
144+
# to enable Neo Semantics:
145+
# * dbms.security.procedures.unrestricted=n10s.*
146+
# * dbms.security.procedures.allowlist=n10s.*
109147
----
110-
. Install the plugins.
111148
+
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-
149+
For more information on configuring the plugins, see the respective documentation:
150+
+
151+
* link:https://neo4j.com/docs/bloom-user-guide/current/bloom-installation/[Bloom documentation]
152+
* link:https://neo4j.com/docs/graph-data-science/current/installation/[GDS documentation]
153+
* link:https://neo4j.com/docs/aura/fleet-management/setup/[Fleet management documentation]
154+
* link:https://neo4j.com/docs/cypher-manual/current/genai-integrations/[GenAI documentation]
155+
* link:https://neo4j.com/docs/apoc/current/installation/[APOC documentation]
156+
* link:https://neo4j.com/labs/apoc/5/installation/[APOC extended documentation]
157+
* link:https://neo4j.com/docs/graphql/current/[GraphQL documentation]
158+
* link:https://neo4j.com/labs/neosemantics/[Neo Semantics documentation]
159+
160+
. Restart Neo4j for the plugins to be loaded and available for use.
161+
+
114162
[NOTE]
115163
====
116164
All installed plugins will automatically be loaded every time Neo4j is started.
117165
Because of that, the number of plugins may impact the startup time.
118166
Install only the necessary plugins to avoid performance issues.
119167
====
120-

0 commit comments

Comments
 (0)