安装和激活

Neo4j Desktop 托管的 Bloom 客户端

Neo4j Bloom 客户端预先打包在 Neo4j Desktop 中。从 Bloom 1.3 开始,Bloom 客户端已启用并可在 Desktop 中使用。在 Neo4j Desktop 1.2.5 及更早版本中,Bloom 客户端应用程序可以添加到任何项目中。从 Desktop 1.2.6 开始,您可以从“应用程序”侧边栏抽屉中找到并直接运行 Bloom 应用程序。如果您在那里没有看到 Bloom 应用程序,请确保已禁用脱机模式并重新启动 Desktop。您的 Desktop 将自动搜索最新版本的 Bloom,如果它丢失或版本较旧,则会安装它。

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

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

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

Bloom 服务器

Bloom 服务器组件作为 Neo4j 数据库插件安装。在开始之前,请下载 Bloom 服务器包此处,并确保您拥有 Bloom 服务器的有效激活密钥。服务器激活密钥可以从您的 Neo4j 代表处获取。

安装服务器插件

Bloom 不支持 Neo4j 3.x。

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

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

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

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

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

    使用 Neo4j 5

    对于 Neo4j 5
    dbms.bloom.license_file=<filepath>

    使用 Neo4j 4.x

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

    Bloom 服务器接受绝对路径(即以操作系统基本目录开头的完全限定路径)以及相对路径(即相对于 Neo4j 数据库安装目录的路径)。

    例如

    使用 Neo4j 5

    在 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 数据库安装位置不同的驱动器上,请使用绝对路径。

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

    添加无限制过程设置以允许 Bloom 服务器过程运行。

    dbms.security.procedures.unrestricted=bloom.*

    如果未将 Bloom 添加到无限制过程列表中,则会导致错误,并且您将无法运行 Bloom。

    如果该设置已存在于 neo4j.conf 中,请不要再次添加它,而只需将bloom.*追加到现有值中。如果您使用的是允许列表,则对过程允许列表设置执行相同的操作。

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

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

    对于 Neo4j 5
    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,请将角色添加到neo4j.conf中的dbms.bloom.authorization_role属性中,如下面的示例 1 和 2 所示。

    示例 1:要授予具有 admin 或 architect 角色的用户访问权限,设置将为

    对于 Neo4j 5
    dbms.bloom.authorization_role=admin,architect
    对于 Neo4j 4.x
    neo4j.bloom.authorization_role=admin,architect

    示例 2:要授予具有 admin、reader 和自定义 bloom 角色的用户访问权限,设置将为

    对于 Neo4j 5
    dbms.bloom.authorization_role=admin,reader,bloom
    对于 Neo4j 4.x
    neo4j.bloom.authorization_role=admin,reader,bloom

    添加插件或更改配置文件时,您需要重新启动 Neo4j 数据库才能使更改生效,Bloom 客户端才能使用。

  6. 与用户共享透视:如有必要,为任何有权访问 Bloom 的非管理员用户创建和共享透视。分配透视的最佳实践是为每个透视创建一个自定义角色,并将该角色添加到应该访问该透视的每个用户。

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

    要了解有关共享透视的更多信息,请参阅存储和共享

更新服务器插件

更新 Bloom 服务器插件非常简单。只需从上面提到的相应插件目录中删除以前的插件。将提供的更新插件放置在其位置。

您需要重新启动 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 网络浏览器上受支持。如果您使用其他网络浏览器,可能会遇到故障或意外行为。