You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/configuration/plugins.adoc
+74-27Lines changed: 74 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,28 @@
2
2
= Configure plugins
3
3
:description: This page describes how to load plugins to a Neo4j deployment.
4
4
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
7
6
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.
9
8
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.
12
10
13
11
[NOTE]
14
12
====
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.
17
16
====
18
17
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
+
19
27
The following plugins are supported:
20
28
21
29
.Supported Neo4j plugins
@@ -28,16 +36,21 @@ The following plugins are supported:
28
36
|
29
37
| link:https://neo4j.com/labs/apoc/5/[APOC Extended user guide (Labs project)]
30
38
31
-
| APOC
39
+
| APOC Core
32
40
| `apoc`
33
41
|
34
-
| link:https://neo4j.com/docs/apoc/current/[APOC user guide]
| 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.]
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:
78
92
79
93
== Install and configure plugins
80
94
81
-
Here are the steps to enable the plugins:
95
+
To install and configure plugins in a Neo4j deployment, follow these steps:
82
96
83
97
. Move or copy the plugins (_.jar files_) from _<NEO4J_HOME>/products_ and _<NEO4J_HOME>/labs_ to the _<NEO4J_HOME>/plugins_ directory.
84
98
See xref:configuration/file-locations.adoc[Default file locations] for more information.
85
99
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:
87
101
+
88
102
[source, properties]
89
103
----
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.
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:
0 commit comments