多租户配置

概述

使用 Fess 的多租户功能，可以在单个 Fess 实例中隔离运行多个租户（组织、部门、客户等）。

通过使用虚拟主机功能，可以为每个租户提供:

独立的搜索UI
隔离的内容
定制的设计

虚拟主机功能

虚拟主机是根据HTTP请求的主机名提供不同搜索环境的功能。

工作原理

用户访问 tenant1.example.com
Fess 识别主机名
应用对应的虚拟主机设置
显示租户特定的内容和UI

虚拟主机头部配置

要启用虚拟主机功能，需要配置HTTP请求的头部与虚拟主机键的对应关系。配置方式有以下两种。

管理界面（推荐）: 在「系统」→「常规」的「虚拟主机」栏中进行设置。该值将作为系统设置保存，重启后仍会保留。优先级高于 fess_config.properties 中的 virtual.host.headers。
配置文件: 在 fess_config.properties 的 virtual.host.headers 属性中进行设置。

两种方式的设置值格式相同。

配置格式

每行按照 头部名:头部值=虚拟主机键 的格式指定:

配置多个虚拟主机时，以换行符分隔。

匹配行为

Fess 每次收到请求时，会将设定的各行「头部名」所对应的请求头部值与设定的「头部值」进行比较。

头部值的比较不区分大小写。
按从上到下的顺序依次评估各行，并应用第一个匹配行的虚拟主机键。
没有匹配行时，视为无虚拟主机（公共环境）处理。
判断结果会针对每个请求进行缓存。

虚拟主机键的限制

虚拟主机键有以下限制:

只允许使用字母数字和下划线（ a-zA-Z0-9_ ）。其他字符会被自动删除。
以下键名为保留字，不能使用: admin 、 common 、 error 、 login 、 profile

管理界面配置

爬取设置

通过在Web爬取设置中指定虚拟主机，可以隔离内容:

登录管理界面
在「爬虫」→「Web」中创建爬取设置
在「虚拟主机」字段中选择已配置的虚拟主机键（可多选）
使用此设置爬取的内容仅在指定的虚拟主机中可搜索

Note

「虚拟主机」字段已在Web、文件系统、数据存储各爬取设置中提供。此处选择的虚拟主机键将附加到爬取的每个文档上，并在搜索时按当前虚拟主机进行过滤。

访问控制

虚拟主机与角色的组合

通过组合虚拟主机和基于角色的访问控制，可以实现更精细的访问控制。

在爬取设置中同时配置虚拟主机和权限:

基于角色的搜索

详情请参阅基于角色的搜索配置。

UI定制

可以为每个虚拟主机定制UI。

主题应用

为每个虚拟主机应用不同的主题:

在「系统」→「设计」中设置主题
在虚拟主机设置中指定主题

自定义CSS

要为每个虚拟主机应用自定义CSS，请在管理界面的「系统」→「设计」中编辑CSS文件。也可以在虚拟主机键对应的视图目录中放置自定义模板。

标签设置

限制每个虚拟主机显示的标签:

在标签类型设置中指定虚拟主机
标签仅在指定的虚拟主机中显示

通过API访问

对搜索API的请求与UI一样，也会根据请求的主机名（配置的头部，通常为 Host 头部）来判断虚拟主机。例如，发往 tenant1.example.com 的请求会自动限定在 tenant1 的虚拟主机范围内，仅以该虚拟主机的内容作为搜索对象。

API请求

使用访问令牌进行认证时，在 Authorization 头部以 Bearer 格式指定:

Note

访问令牌不与特定虚拟主机绑定。令牌对任何虚拟主机均有效，目标虚拟主机由请求发送目标的主机名决定。将相同令牌发送到不同主机名时，将限定在不同的虚拟主机范围内。如需独立于虚拟主机控制访问范围，请与基于角色的访问控制（基于角色的搜索配置）结合使用。

DNS设置

实现多租户的DNS设置示例:

指向同一服务器的子域名

反向代理设置

使用Nginx的反向代理设置示例:

server {
    server_name tenant1.example.com;

    location / {
        proxy_pass http://localhost:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

server {
    server_name tenant2.example.com;

    location / {
        proxy_pass http://localhost:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

数据隔离

需要完全数据隔离时，可考虑以下方案:

索引级别隔离

为每个租户使用单独的 Fess 实例和索引:

# 租户1用Fess实例（fess_config.properties）
index.document.search.index=fess_tenant1.search

# 租户2用Fess实例（fess_config.properties）
index.document.search.index=fess_tenant2.search

Note

index.document.search.index 每个实例只能设置一个值。要实现索引级别的完全隔离，需要为每个租户运行单独的 Fess 实例或进行自定义实现。通常的多租户场景中，通过虚拟主机功能进行逻辑隔离即可满足需求。

最佳实践

明确的命名规则: 对虚拟主机和角色使用一致的命名规则
测试: 充分测试每个租户的功能
监控: 监控每个租户的资源使用情况
文档: 记录租户设置

限制事项

管理界面在所有租户间共享
系统设置影响所有租户
部分功能可能不支持虚拟主机

参考信息

基于角色的搜索配置 - 基于角色的访问控制
虚拟主机 - 虚拟主机设置详情
页面设计 - 设计定制