svfe/svfe-api-firmador 镜像文档

镜像概述和主要用途

本镜像为FESV（Firma Electrónica de Servicios Virtuales）环境提供DTE（Documento Tributario Electrónico）文档签名服务。通过Docker容器化部署，支持灵活配置，可运行在SSL加密或非SSL模式下，满足不同安全需求的文档签名场景。

核心功能和特性

• 文档签名：提供DTE文档的电子签名功能，支持FESV环境下的文档处理需求
• 双模式部署：支持SSL加密模式和非SSL模式，适应不同安全级别要求
• 灵活配置：通过环境变量和卷挂载实现参数自定义，如证书路径、密码等
• 稳定运行：配置自动重启策略，确保服务持续可用
• 数据持久化：通过卷挂载实现签名文件和证书的持久化存储

使用场景和适用范围

适用于需要在FESV环境中进行DTE文档签名的场景，包括但不限于：

• 企业电子文档处理系统集成
• 电子政务平台中的文档签名服务部署
• 需要合规电子签名的业务系统（如财务、税务文档处理）

使用方法和配置说明

前置要求

• 已安装Docker和Docker Compose
• （SSL模式）准备好PKCS#12格式的SSL证书文件

Docker Compose配置示例

非SSL模式部署

以下配置适用于无需加密传输的场景：

version: '3'
services:
    svfe-api-firmador:
        image: svfe/svfe-api-firmador:v20250526  # 使用指定版本镜像
        container_name: svfe-api-firmador       # 容器名称
        restart: always                          # 容器退出时自动重启
        ports:
         - "8113:8113"                           # 端口映射（主机端口:容器端口）
        env_file:
         - ./svfe-api.env                        # 加载环境变量文件
        volumes:
         - "./certificado:/uploads"              # 挂载签名文件存储目录（主机目录:容器目录）

SSL模式部署

以下配置适用于需要加密传输的场景，需额外挂载SSL证书目录：

version: '3'
services:
 svfe-api-firmador:
  image: svfe/svfe-api-firmador:v20250526  # 使用指定版本镜像
  container_name: svfe-api-firmador       # 容器名称
  restart: always                          # 容器退出时自动重启
  ports:
   - "443:8113"                            # 端口映射（使用443标准HTTPS端口）
  env_file:
    - ./svfe-api.env                       # 加载环境变量文件
  volumes:
   - "./certificado:/uploads"              # 挂载签名文件存储目录
   - "./ssl:/ssl"                          # 挂载SSL证书目录（主机目录:容器目录）

环境变量配置说明

环境变量需配置在 svfe-api.env 文件中，根据部署模式（SSL/非SSL）选择对应配置：

非SSL模式

仅需指定激活非SSL配置文件：

SPRING_PROFILES_ACTIVE=nonssl

SSL模式

需指定SSL配置文件、证书路径及密码：

# 如需禁用SSL，将SPRING_PROFILES_ACTIVE改为nonssl，并建议使用非443端口
SPRING_PROFILES_ACTIVE=ssl
SVFE_ARCHIVO=ssl/certificado.p12  # 容器内SSL证书路径（对应主机./ssl目录）
SVFE_PASSWORD=hacienda            # SSL证书密码

卷挂载说明

• ./certificado:/uploads：用于存储签名过程中的文件，主机目录./certificado需提前创建
• ./ssl:/ssl（仅SSL模式）：用于挂载SSL证书文件，主机目录./ssl需包含PKCS#12格式证书（如certificado.p12）

部署步骤概要

1. 创建环境变量文件 svfe-api.env，根据模式配置环境变量
2. 创建必要的主机目录（./certificado，SSL模式需额外创建./ssl并放入证书）
3. 编写Docker Compose配置文件（选择SSL或非SSL模式）
4. 执行 docker-compose up -d 启动服务
5. 通过 docker-compose logs 查看服务运行日志