插件
本页面介绍了如何将插件安装到运行于 Docker 容器内的 Neo4j 实例中。有关插件的一般说明,请参阅 配置 → 插件。
安装插件
要安装插件(包括用户自定义过程),请将包含插件 JAR 文件的文件夹或卷挂载到 /plugins 目录,例如:
docker run \
--publish=7474:7474 --publish=7687:7687 \
--volume=$HOME/neo4j/plugins:/plugins \
neo4j:2026.03.1
Neo4j 在启动时会自动加载 /plugins 文件夹中找到的所有插件。
NEO4J_PLUGINS 工具
Neo4j Docker 镜像包含一个启动脚本,可以在运行时自动下载并配置特定的 Neo4j 插件。
|
此功能旨在方便在开发环境中使用 Neo4j 插件,但不建议在生产环境中使用。 若要在生产环境的 Neo4j Docker 容器中使用插件,请参阅安装用户自定义过程。 |
可以使用 NEO4J_PLUGINS 环境变量来指定通过此方法安装的插件。该变量应设置为一个 JSON 格式的受支持插件列表。
|
在 Docker 容器中运行 Bloom 需要 Neo4j Docker 镜像 4.2.3-enterprise 或更高版本。 |
如果传递了无效的 NEO4J_PLUGINS 值,Neo4j 会返回一个插件未知的通知。例如,--env NEO4J_PLUGINS='["gds"]' 会返回以下通知:
"gds" is not a known Neo4j plugin. Options are:
apoc
apoc-extended
bloom
genai
graph-data-science
n10s
apoc)您可以使用 Docker 参数 --env NEO4J_PLUGINS='["apoc"]' 并运行以下命令:
docker run -it --rm \
--publish=7474:7474 --publish=7687:7687 \
--env NEO4J_AUTH=none \
--env NEO4J_PLUGINS='["apoc"]' \
neo4j:2026.03.1
apoc) 和 Graph Data Science 插件 (graph-data-science)您可以使用 Docker 参数 --env NEO4J_PLUGINS='["apoc", "graph-data-science"]' 并运行以下命令:
docker run -it --rm \
--publish=7474:7474 --publish=7687:7687 \
--env NEO4J_AUTH=none \
--env NEO4J_PLUGINS='["apoc", "graph-data-science"]' \
neo4j:2026.03.1
存储下载的插件
在带宽受限或需要频繁重启 Neo4j 的情况下,建议将插件下载一次并重复使用,而不是每次都重新下载。
通过结合使用 NEO4J_PLUGINS 工具和挂载存储到 /plugins,插件 JAR 包会被下载到 /plugins 文件夹中。随后,无需再次设置 NEO4J_PLUGINS,即可直接将这些已下载的插件提供给 Neo4j 使用。
$HOME/neo4j/pluginsdocker run -it --rm \
--publish=7474:7474 --publish=7687:7687 \
--env NEO4J_AUTH=none \
--env NEO4J_PLUGINS='["apoc"]' \
--volume=$HOME/neo4j/plugins:/plugins \ (1)
neo4j:2026.03.1
| 1 | 将主机文件夹 $HOME/neo4j/plugins 挂载到 /plugins。 |
apoc 插件是否已下载。docker kill <containerID/name>
ls $HOME/neo4j/plugins
apoc.jar
apoc 是否已安装。docker run -it --rm \
--publish=7474:7474 --publish=7687:7687 \
--env NEO4J_AUTH=none \
--volume=$HOME/neo4j/plugins:/plugins \
neo4j:2026.03.1
cypher-shell "RETURN apoc.version();"
安装插件许可证
如果插件需要许可证,可以通过将包含许可证文件的文件夹或卷挂载到 /licenses 来为容器提供许可证文件。
|
要检查插件是否需要许可证,请参阅通用插件文档。 |
docker run \
--publish=7474:7474 --publish=7687:7687 \
--volume=$HOME/neo4j/plugins:/plugins \ (1)
--volume=$HOME/neo4j/licenses:/licenses \ (2)
neo4j:2026.03.1
| 1 | 包含插件 JAR 包的文件夹。 |
| 2 | 包含许可证文件的文件夹。 |
如果使用 NEO4J_PLUGINS 工具安装插件,也必须提供许可证。
NEO4J_PLUGINS 工具通过挂载文件夹到容器来安装插件和许可证docker run \
--publish=7474:7474 --publish=7687:7687 \
--env NEO4J_PLUGINS='["bloom"]' \
--volume=$HOME/neo4j/licenses:/licenses \ (1)
neo4j:2026.03.1
| 1 | 包含许可证文件的文件夹。 |