Box连接器

概述

Box连接器提供从Box.com云存储获取文件并 注册到 Fess 索引的功能。

此功能需要 fess-ds-box 插件。

前提条件

  1. 需要安装插件

  2. 需要Box开发者账户和应用程序创建

  3. 需要设置JWT（JSON Web Token）认证或OAuth 2.0认证

插件安装

方法1：直接放置JAR文件

# 从Maven Central下载
wget https://repo1.maven.org/maven2/org/codelibs/fess/fess-ds-box/X.X.X/fess-ds-box-X.X.X.jar

# 放置
cp fess-ds-box-X.X.X.jar $FESS_HOME/app/WEB-INF/lib/
# 或
cp fess-ds-box-X.X.X.jar /usr/share/fess/app/WEB-INF/lib/

方法2：从管理界面安装

  1. 打开”系统”→”插件”

  2. 上传JAR文件

  3. 重启 Fess

设置方法

从管理界面的”爬虫”→”数据存储”→”新建”进行设置。

基本设置

项目 设置示例
名称 Company Box Storage
处理器名 BoxDataStore
启用 开

参数设置

JWT认证示例（推荐）：

client_id=hdf8a7sd9f8a7sdf9a87sdf98a7sd
client_secret=kMN7sd8f7a9sd8f7a9sd8f7a9sd8f
public_key_id=4tg5h6j7
private_key=<YOUR_PRIVATE_KEY>
passphrase=7ba8sd9f7a9sd8f7a9sd8f7a9sd8f
enterprise_id=1923456

参数列表

脚本设置

url=file.url
title=file.name
content=file.contents
mimetype=file.mimetype
filetype=file.filetype
filename=file.name
content_length=file.size
created=file.created_at
last_modified=file.modified_at

可用字段

字段 说明
file.url 在浏览器中打开文件的链接
file.contents 文件的文本内容
file.mimetype 文件的MIME类型
file.filetype 文件类型
file.name 文件名
file.size 文件大小（字节）
file.created_at 创建日期
file.modified_at 最后更新日期

详细信息请参阅 Box File Object。

Box认证设置

JWT认证设置步骤

1. 在Box Developer Console创建应用程序

访问 https://app.box.com/developers/console：

  1. 点击”Create New App”

  2. 选择”Custom App”

  3. 在认证方法中选择”Server Authentication (with JWT)”

  4. 输入应用名称并创建

2. 应用程序设置

在”Configuration”标签页设置：

Application Scopes：

  • 勾选”Read all files and folders stored in Box”

Advanced Features：

  • 点击”Generate a Public/Private Keypair”

  • 下载生成的JSON文件（重要！）

App Access Level：

  • 选择”App + Enterprise Access”

3. 在企业中批准

在Box管理控制台：

  1. 打开”Apps”→”Custom Apps”

  2. 批准创建的应用

4. 获取认证信息

从下载的JSON文件获取以下信息：

{
  "boxAppSettings": {
    "clientID": "hdf8a7sd...",         // client_id
    "clientSecret": "kMN7sd8f...",      // client_secret
    "appAuth": {
      "publicKeyID": "4tg5h6j7",        // public_key_id
      "privateKey": "-----BEGIN...",    // private_key
      "passphrase": "7ba8sd9f..."       // passphrase
    }
  },
  "enterpriseID": "1923456"             // enterprise_id
}

私钥格式

private_key 将换行替换为 \n 成为一行：

private_key=-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIFDjBABgk...=\n-----END ENCRYPTED PRIVATE KEY-----\n

使用示例

抓取企业整个Box存储

参数：

client_id=abc123def456ghi789jkl012mno345
client_secret=pqr678stu901vwx234yz567abc890
public_key_id=a1b2c3d4
private_key=-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIFDjBABgkqhkiG9w0BBQ0wOzAbBgkqhkiG9w0BBQwwDgQI...=\n-----END ENCRYPTED PRIVATE KEY-----\n
passphrase=1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p
enterprise_id=123456789

脚本：

url=file.url
title=file.name
content=file.contents
mimetype=file.mimetype
filetype=file.filetype
filename=file.name
content_length=file.size
created=file.created_at
last_modified=file.modified_at

故障排除

认证错误

症状：Authentication failed 或 Invalid grant

检查项：

  1. 确认 client_id 和 client_secret 是否正确

  2. 确认私钥是否正确复制（换行是否变成 \n）

  3. 确认密码短语是否正确

  4. 确认应用在Box管理控制台中是否已被批准

  5. 确认 enterprise_id 是否正确

私钥格式错误

症状：Invalid private key format

解决方法：

确认私钥的换行是否正确转换为 \n：

# 正确格式
private_key=-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIFDj...\n-----END ENCRYPTED PRIVATE KEY-----\n

# 错误格式（包含实际换行）
private_key=-----BEGIN ENCRYPTED PRIVATE KEY-----
MIIFDj...
-----END ENCRYPTED PRIVATE KEY-----

无法获取文件

症状：抓取成功但文件数为0

检查项：

  1. 确认Application Scopes中”Read all files and folders”是否启用

  2. 确认App Access Level是否为”App + Enterprise Access”

  3. 确认Box存储中是否确实存在文件

  4. 确认服务账户是否有适当权限

参考信息