安装与激活

Neo4j Desktop 托管的 Bloom 客户端

Neo4j Bloom 客户端已预装在所有版本的 Neo4j Desktop 中。但是,在 Desktop 2.0 中,Bloom 以 Explore(探索) 的形式提供;而在早期版本中,Bloom 则作为图应用(graph app)提供。Bloom 客户端在所有版本的 Desktop 中均为启用状态,可直接使用。

在 Desktop 2.0 中,您可以在侧边栏的 Tools(工具) 部分找到 Explore(探索)。有关如何在 Desktop 2.0 中使用 Explore 的详细信息,请参阅连接工具

在早期版本中,您可以从 Desktop 侧边栏的“Applications(应用程序)”抽屉中直接查找并运行 Bloom 应用。如果您在那里没有看到 Bloom 应用,请确保已禁用 offline mode(离线模式)并重启 Desktop。Desktop 将自动搜索最新版本的 Bloom,如果缺失或版本较旧,它将自动进行安装。

Bloom 客户端的可视化和探索功能适用于 Desktop 中任何本地安装的数据库。若要访问远程 Neo4j 数据库以及使用协作功能(如持久化存储和安全控制),则需要使用 Bloom server(Bloom 服务器)组件。

有关许可条款的更多信息,请参阅 Neo4j Desktop About(关于) 部分中的 Neo4j Desktop 许可协议。

Bloom 默认对所有 Neo4j 数据库用户开放。这可以通过 Neo4j 中的基于角色的访问控制 (RBAC) 进行管理。请参阅下文第 5 步 在数据库中设置用户/角色,更多有关用户和角色的信息,请参阅操作手册 → 身份验证与授权

Bloom 服务器

Bloom 服务器组件作为 Neo4j 数据库插件进行安装。您可以在 Neo4j 安装目录的 products 文件夹中找到 Bloom 插件。Bloom 服务器包也可以在此处下载。此外,请确保您拥有有效的 Bloom 服务器激活密钥。服务器激活密钥可从您的 Neo4j 代表处获得。

安装服务器插件

自 2025 年 1 月起,Neo4j 服务器采用日历版本控制 (CalVer)。早期版本(如 Neo4j 4 和 5)使用的是语义版本控制 (SemVer)。然而,Bloom 继续使用语义版本控制。与 Neo4j 2025.01 兼容的 Bloom 服务器插件命名为 bloom-plugin-6.x-<bloom-version>。其中 6.x 表示与当前最新版本的 Neo4j 兼容。

安装步骤
  1. 获取 Bloom 服务器插件:解压下载的 Bloom 服务器包。所使用的 Bloom 插件(.jar 文件)取决于您的 Neo4j 服务器版本。例如,如果您使用的是 Neo4j 2025.10 和 Bloom 2.28.0,请使用 bloom-plugin-6.x-2.28.0.jar

    或者,在 Neo4j 安装目录的 products 文件夹中找到该插件。

  2. 放置插件:首先,查看 操作手册 → 文件位置 中的表格,找出放置 Bloom 插件 .jar 文件的位置。请确保将文件复制到正确的 plugins 目录中。

  3. 放置激活密钥:将提供的激活密钥文件放置在 Neo4j 数据库服务器上。您可以将其放置在您选择的任何位置。为了避免文件被意外覆盖,您可以将其放置在 Neo4j 安装目录之外。

  4. 编辑配置文件:然后,您需要编辑数据库的 neo4j.conf 配置文件。阅读 操作手册 → neo4j.conf 文件 部分以了解有关 neo4j.conf 文件的更多信息。您可以在操作手册 → 文件位置中找到操作系统的默认路径。

    您需要添加一个包含 Bloom 许可证文件路径的配置设置。具体配置取决于您正在使用的 Neo4j 版本。

    对于 Neo4j 5 及最新 CalVer 版本

    对于 Neo4j 5 及最新 CalVer 版本
    dbms.bloom.license_file=<filepath>

    对于 Neo4j 4.x 版本

    对于 Neo4j 4.x 版本
    neo4j.bloom.license_file=<filepath>

    Bloom 服务器接受绝对路径(即从操作系统根目录开始的完整路径)以及相对路径(即相对于 Neo4j 数据库安装目录的路径)。

    例如:

    对于 Neo4j 5 及最新 CalVer 版本

    在 Linux 上使用 Neo4j 5
    dbms.bloom.license_file=/etc/neo4j/license/mybloomkey.license
    or
    dbms.bloom.license_file=mybloomkey.license
    在 Windows 上使用 Neo4j 5
    dbms.bloom.license_file=license/mybloomkey.license
    or
    dbms.bloom.license_file=license\\mybloomkey.license
    or
    dbms.bloom.license_file=mybloomkey.license

    对于 Neo4j 4.x 版本

    在 Linux 上使用 Neo4j 4.x
    neo4j.bloom.license_file=/etc/neo4j/license/mybloomkey.license
    or
    neo4j.bloom.license_file=mybloomkey.license
    在 Windows 上使用 Neo4j 4.x
    neo4j.bloom.license_file=license/mybloomkey.license
    or
    neo4j.bloom.license_file=license\\mybloomkey.license
    or
    neo4j.bloom.license_file=mybloomkey.license

    如果您是 Windows 用户,且需要将许可证文件放在与 Neo4j 数据库安装路径不同的驱动器上,请务必使用绝对路径。

    建议保持许可证文件名简洁,即不要使用任何特殊字符。

    添加不受限的过程(unrestricted procedures)设置,以允许 Bloom 服务器过程运行。

    dbms.security.procedures.unrestricted=bloom.*

    未能将 Bloom 添加到不受限过程列表中会导致错误,从而无法运行 Bloom。

    如果 neo4j.conf 中已存在此设置,请勿重复添加,只需将 bloom.* 追加到现有值即可。如果您正在使用过程允许列表(allowlist),请对该设置执行同样的操作。

    dbms.security.procedures.unrestricted=apoc.*,bloom.*
    dbms.security.procedures.allowlist=apoc.load.*,bloom.*

    如果 Bloom 服务器插件也托管了 Bloom 客户端,请将以下配置设置添加到托管该插件的 Neo4j 服务器或集群节点中

    对于 Neo4j 5 及最新 CalVer 版本
    server.unmanaged_extension_classes=com.neo4j.bloom.server=/bloom
    dbms.security.http_auth_allowlist=/,/browser.*,/bloom.*
    对于 Neo4j 4.3+
    dbms.unmanaged_extension_classes=com.neo4j.bloom.server=/bloom
    dbms.security.http_auth_allowlist=/,/browser.*,/bloom.*
  5. 在数据库中设置用户/角色:根据需要管理用户和角色对 Neo4j 数据库的访问权限。默认情况下,Bloom 对所有用户开放。限制拥有特定角色的用户访问的配置设置取决于您使用的 Neo4j 版本。对于 Neo4j 5,请在 neo4j.conf 中启用 dbms.bloom.authorization_role 属性并列出应被授权的角色。对于 Neo4j 4.x,请在 neo4j.conf 中启用 neo4j.bloom.authorization_role 属性并列出应被授权的角色。要允许拥有其他角色的用户通过服务器访问 Bloom,请按照下方示例 1 和 2 所示,将这些角色添加到 dbms.bloom.authorization_role / neo4j.bloom.authorization_role 属性中。

    示例 1:若要授予拥有 admin 或 architect 角色的用户访问权限,设置如下

    对于 Neo4j 5 及最新 CalVer 版本
    dbms.bloom.authorization_role=admin,architect
    对于 Neo4j 4.x 版本
    neo4j.bloom.authorization_role=admin,architect

    示例 2:若要授予拥有 admin、reader 以及自定义 bloom 角色的用户访问权限,设置如下

    对于 Neo4j 5 及最新 CalVer 版本
    dbms.bloom.authorization_role=admin,reader,bloom
    对于 Neo4j 4.x 版本
    neo4j.bloom.authorization_role=admin,reader,bloom

    添加插件或更改配置文件后,您需要重启 Neo4j 数据库,以便 Bloom 客户端能够使用这些更改。

  6. 与用户共享透视图(Perspectives):如果需要,为任何获准访问 Bloom 的非管理员用户创建并共享透视图。分配透视图的最佳实践是为每个透视图创建一个自定义角色,并将该角色分配给所有需要访问该透视图的用户。

    或者,如果用户自行创建透视图,请授予他们拥有在数据库中创建新数据权限的角色。有关 Neo4j 中角色的更多信息,请参阅 操作手册 → 身份验证与授权

    要了解关于共享透视图的更多信息,请参阅 存储与共享

更新服务器插件

更新 Bloom 服务器插件非常简单。只需按上述说明从相应的 plugins 目录中移除旧插件,并将提供的更新版插件放入该位置即可。

您需要重启 Neo4j 数据库,以便新插件能够被加载并供 Bloom 客户端使用。

访问 Neo4j 服务器托管的 Bloom

配置 Neo4j 并安装插件后,Bloom 将通过您配置的 HTTPHTTPS URL 之一提供服务。

http://<neo4j-server-host>:<http-port>/bloom/

https://<neo4j-server-host>:<https-port>/bloom/

在构建 URL 时,请注意您在 neo4j.conf 文件中是如何配置 server.unmanaged_extension_classes 的(如前文第 4 步所述)。

如果使用 SSL,请确保在 neo4j.conf 中设置了 dbms.ssl.policy.client_auth=NONE

用户需要使用其为 Neo4j 数据库配置的凭据进行登录。

Bloom 支持 Chrome、Firefox 和 Edge 浏览器。如果您使用其他网络浏览器,可能会遇到故障或意外行为。