Eclipse EDC 连接器配置参数详解

配置参数概述

Eclipse EDC (Eclipse Dataspace Connector) 是一个用于构建数据空间连接器的开源框架。在部署和使用EDC连接器时，正确配置各项参数至关重要。本文将详细介绍EDC连接器中的核心配置参数及其作用。

核心配置参数

基本连接器配置

1. EDC_CONNECTOR_NAME
   定义连接器在数据空间中的名称标识。默认值为随机生成的UUID格式，建议在生产环境中设置为有意义的名称。

2. EDC_PARTICIPANT_ID
   设置连接器在特定数据空间中的唯一标识符。默认值为"anonymous"，在实际部署时必须修改为唯一值。

3. EDC_HOSTNAME
   指定EDC连接器的主机名。默认使用localhost，生产环境应配置为实际域名或IP地址。

安全相关配置

4. EDC_KEYSTORE
   密钥库文件路径，用于存储加密密钥等安全信息。支持多种格式包括JKS、JCEKS、PFX和P12。

5. EDC_KEYSTORE_PASSWORD
   密钥库文件的访问密码。生产环境中应使用强密码。

6. EDC_VAULT
   保险库文件路径，存储加密密钥等安全数据。默认使用dataspaceconnector-vault.properties文件。

API端点配置

7. EDC_DSP_CALLBACK_ADDRESS
   数据空间协议请求的代理端点地址。需要与WEB_HTTP_PROTOCOL_*配置保持一致。

8. EDC_DATAPLANE_TOKEN_VALIDATION_ENDPOINT
   公共数据平面API激活时，用于验证发送认证令牌的端点。

传输相关配置

9. EDC_TRANSFER_PROXY_TOKEN_SIGNER_KEY_ALIAS
   PUSH/PULL数据传输所需的密钥库中密钥别名。

10. EDC_TRANSFER_PROXY_TOKEN_VERIFIER_PUBLICKEY_ALIAS
    从保险库获取公钥的别名，用于数据传输验证。

Web服务配置

11. WEB_HTTP_PORT
    Jetty服务器的默认端口，默认为8181。

12. WEB_HTTP_PATH
    API的基础路径，默认为/api。

13. WEB_HTTP_CONTROL_PORT
    控制平面API端口，默认为9191。

14. WEB_HTTP_MANAGEMENT_PORT
    管理API端口，默认为8181。

15. WEB_HTTP_PROTOCOL_PORT
    数据空间协议端口，默认为8282。

16. WEB_HTTP_PUBLIC_PORT
    公共数据平面API端口，默认为8185。

配置文档生成

EDC项目提供了自动生成配置文档的工具：

1. 使用./gradlew autodoc命令生成配置清单
2. 执行./gradlew mergeManifest合并清单
3. 生成的JSON文件位于build/manifest.json
4. 可通过./gradlew doc2md转换为Markdown格式

最佳实践建议

1. 生产环境中不应使用默认的密钥库和保险库配置
2. 所有安全信息应使用强密码保护
3. API端点配置需要保持一致性
4. 连接器名称和参与者ID必须设置为唯一且有意义的标识
5. 定期检查并更新配置文档

通过合理配置这些参数，可以确保EDC连接器在数据空间中安全、高效地运行。建议在部署前仔细规划各项配置，特别是安全相关的参数设置。