phoss SMP Server 镜像文档

1. 镜像概述

phoss SMP Server是一款实现Peppol和OASIS BDXR标准的服务元数据发布（SMP）服务器。该镜像提供了完整的SMP功能，专为电子数据交换（EDI）场景设计，采用XML格式作为后端存储，用于管理和发布服务元数据，支持交易伙伴间的服务端点发现与配置。

2. 核心功能与特性

• 标准支持：完全兼容Peppol SMP规范（EN 16931-3）和OASIS BDXR SMP v1.0标准
• XML后端：采用XML文件系统存储元数据，无需额外数据库，简化部署
• Web管理界面：内置Web控制台，支持元数据可视化管理与配置
• REST API：提供标准化RESTful API，支持元数据的程序化操作
• 安全特性：支持HTTPS加密传输，可配置访问控制列表（ACL）
• 轻量化部署：基于Java运行时，镜像体积优化，适合容器化环境

3. 使用场景

• 企业间电子数据交换（EDI）系统的服务元数据管理
• Peppol网络参与者的服务端点发布与维护
• 政府电子采购平台（如Peppol eProcurement）的服务注册
• 供应链管理系统中交易伙伴的服务元数据同步
• 需要符合OASIS BDXR标准的跨组织数据交换场景

4. 使用方法

4.1 基本运行

通过以下命令启动基本实例，映射默认端口并挂载数据卷：

docker run -d \
  --name phoss-smp \
  -p 8080:8080 \
  -v ./smp-data:/opt/phoss/smp/xml-data \
  phoss/smp-server

4.2 环境变量配置

支持以下关键环境变量自定义配置：

示例（启用HTTPS并修改管理员密码）：

docker run -d \
  --name phoss-smp \
  -p 8443:8443 \
  -v ./smp-data:/opt/phoss/smp/xml-data \
  -v ./ssl:/opt/phoss/smp/ssl \
  -e SERVER_PORT=8443 \
  -e HTTPS_ENABLED=true \
  -e ADMIN_PASSWORD=SecurePass2024! \
  phoss/smp-server

4.3 Docker Compose配置

创建docker-compose.yml文件简化部署：

version: '3.8'

services:
  smp-server:
    image: phoss/smp-server
    container_name: phoss-smp
    restart: always
    ports:
      - "8443:8443"
    volumes:
      - ./smp-data:/opt/phoss/smp/xml-data
      - ./ssl:/opt/phoss/smp/ssl
      - ./config:/opt/phoss/smp/config
    environment:
      - SERVER_PORT=8443
      - HTTPS_ENABLED=true
      - XML_DATA_DIR=/opt/phoss/smp/xml-data
      - LOG_LEVEL=INFO
      - ADMIN_USER=sysadmin
      - ADMIN_PASSWORD=${SMP_ADMIN_PASSWORD}

启动命令：docker-compose up -d

4.4 持久化配置

为确保数据与配置持久化，需挂载以下目录：

• ./smp-data: 存储XML格式的元数据文件
• ./ssl: 存放HTTPS证书（当启用HTTPS时）
• ./config: 自定义配置文件（如application.properties）

5. 配置说明

5.1 自定义配置文件

通过挂载config目录替换默认配置：

-v ./custom-config:/opt/phoss/smp/config

核心配置文件说明：

• application.properties: 服务器核心参数（端口、日志、存储路径等）
• smp.properties: SMP协议相关配置（标准版本、验证规则等）
• logback.xml: 日志输出配置

5.2 HTTPS配置

1. 准备SSL证书（JKS格式），放置于./ssl目录
2. 在application.properties中配置：

   server.ssl.enabled=true
   server.ssl.key-store=/opt/phoss/smp/ssl/smp-cert.jks
   server.ssl.key-store-password=your-keystore-password
   server.ssl.key-password=your-key-password
   

6. 访问与验证

服务启动后，通过以下方式验证：

• Web管理界面：http://<host>:8080/smp-admin（使用配置的管理员账号登录）
• API健康检查：http://<host>:8080/api/v1/health，返回{"status":"UP"}表示正常运行
• 元数据查询示例：http://<host>:8080/smp/participant/<participant-id>（需替换为实际参与者ID）

7. 数据备份

定期备份XML数据目录确保元数据安全：

# 创建数据备份
tar -czf smp-backup-$(date +%Y%m%d).tar.gz ./smp-data