|
| 1 | +[[plugins]] |
| 2 | += Configure plugins |
| 3 | +:description: This page describes how to load plugins to a Neo4j deployment. |
| 4 | + |
| 5 | +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. |
| 6 | +The JAR files for these products are located in the _product_ and _labs_ folders and can be installed as plugins. |
| 7 | + |
| 8 | +If you want to use your own plugins, ensure that you add them to the designated _plugins_ directory. |
| 9 | +This directory serves as the central location where Neo4j looks for and loads the plugins at startup. |
| 10 | + |
| 11 | +[NOTE] |
| 12 | +==== |
| 13 | +Bloom and GDS Enterprise require a license activation key to become available to the user within Neo4j. |
| 14 | +Reach out to your Neo4j account representative or request a representative to link:https://neo4j.com/contact-us/#sales-inquiry[contact you]. |
| 15 | +==== |
| 16 | + |
| 17 | +The following plugins are supported: |
| 18 | + |
| 19 | +.Supported Neo4j plugins |
| 20 | +[options="header",cols="d,m,b,a"] |
| 21 | +|=== |
| 22 | +|Name |Key | License required | Further information |
| 23 | + |
| 24 | +| APOC |
| 25 | +| `apoc` |
| 26 | +| {cross-mark} |
| 27 | +| https://neo4j.com/docs/apoc/current/[APOC user guide] |
| 28 | + |
| 29 | +| Bloom |
| 30 | +| `bloom` |
| 31 | +| {check-mark} |
| 32 | +| link:{neo4j-docs-base-uri}/bloom-user-guide[Neo4j Bloom] |
| 33 | + |
| 34 | +| Streams |
| 35 | +| `streams` |
| 36 | +| {cross-mark} |
| 37 | +| link:{neo4j-docs-base-uri}/kafka-streams[Neo4j Streaming Data Integrations User Guide] |
| 38 | + |
| 39 | +| Graph Data Science |
| 40 | +| `graph-data-science` |
| 41 | +| {cross-mark} |
| 42 | +| link:{neo4j-docs-base-uri}/graph-data-science[Graph Data Science] |
| 43 | + |
| 44 | +| Neo Semantics |
| 45 | +| `n10s` |
| 46 | +| {cross-mark} |
| 47 | +| https://neo4j.com/labs/nsmtx-rdf/[Neo Semantics] |
| 48 | + |
| 49 | +| Ops Manager |
| 50 | +| `ops-manager` |
| 51 | +| {cross-mark} |
| 52 | +| link:{neo4j-docs-base-uri}/ops-manager/[Neo4j Ops Manager] |
| 53 | +|=== |
| 54 | + |
| 55 | + |
| 56 | +For more information on using plugins in a different Neo4j setup, see link:{neo4j-docs-base-uri}/desktop-manual/current/operations/install-plugin/[Neo4j Desktop -> Install a plugin], xref:docker/operations.adoc#docker-neo4j-plugins[Docker -> Configure Neo4j plugins], and link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/project-setup/#_build_dependencies[Java-Reference -> Setting up a plugin project]. |
| 57 | + |
| 58 | +== Install and configure plugins |
| 59 | + |
| 60 | +Here are the steps to enable the plugins: |
| 61 | + |
| 62 | +. Move or copy the plugins (_.jar files_) from _<NEO4J_HOME>/products_ and _<NEO4J_HOME>/labs_ to the _<NEO4J_HOME>/plugins_ directory. |
| 63 | +See the table in xref:configuration/file-locations/[File locations] for more information. |
| 64 | + |
| 65 | +. Add the following lines in _$NEO4J_HOME/conf/neo4j.conf_: |
| 66 | ++ |
| 67 | +[source, properties] |
| 68 | +---- |
| 69 | +# to enable GDS: |
| 70 | +
|
| 71 | +* dbms.security.procedures.unrestricted=gds.* |
| 72 | +* dbms.security.procedures.allowlist=gds.* |
| 73 | +* gds.enterprise.license_file=/path/to/my/license/keyfile |
| 74 | +
|
| 75 | +
|
| 76 | +# to enable Bloom: |
| 77 | +
|
| 78 | +* dbms.security.procedures.unrestricted=bloom.* |
| 79 | +* dbms.bloom.license_file=/path/to/my/license/keyfile |
| 80 | +
|
| 81 | +
|
| 82 | +# to enable both GDS and Bloom: |
| 83 | +
|
| 84 | +* dbms.security.procedures.unrestricted=gds.*,bloom.* |
| 85 | +* dbms.security.procedures.allowlist=gds.* |
| 86 | +* gds.enterprise.license_file=/path/to/my/license/keyfile |
| 87 | +* dbms.bloom.license_file=/path/to/my/license/keyfile |
| 88 | +---- |
| 89 | +. Install the plugins. |
| 90 | ++ |
| 91 | +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], and https://neo4j.com/docs/ops-manager/current[Neo4j Ops Manager documentation] for more details on how to install them. |
| 92 | + |
| 93 | +[NOTE] |
| 94 | +==== |
| 95 | +All installed plugins will automatically be loaded every time Neo4j is started. |
| 96 | +Because of that, the number of plugins may impact the startup time. |
| 97 | +Install only the necessary plugins to avoid performance issues. |
| 98 | +==== |
0 commit comments