codenotary/immuproof

codenotary/immuproof 镜像文档

镜像概述

codenotary/immuproof是一个用于与社区证明服务(CAS)集成的Docker镜像。该镜像提供审计CAS账本功能，并启动HTTP REST服务器以展示审计结果，同时支持通过挂载卷持久化存储immudb状态文件和审计历史记录。

核心功能与特性

• CAS集成：与Community Attestation Service无缝集成，支持审计CAS账本
• 审计功能：定期执行账本审计，可配置审计间隔和历史记录大小
• REST接口：提供HTTP REST服务器，用于访问审计结果
• 持久化存储：支持通过挂载卷保存immudb状态文件和审计历史，确保数据不丢失
• 灵活配置：通过命令行参数或环境变量进行多维度配置，包括TLS设置、Web服务器参数等

使用场景

• 需要持续监控CAS账本状态的场景
• 需要持久化保存审计历史记录的环境
• 需要通过HTTP接口访问审计结果的应用集成
• 对CAS账本审计频率和历史保留有自定义需求的场景

使用方法

拉取镜像

shell
docker pull codenotary/immuproof:latest

基本运行

shell
docker run -p 8091:8091 codenotary/immuproof serve --api-key {your api key} --port 443 --host cas.codenotary.com --audit-interval 1h --state-history-size 72

持久化存储配置

为保留审计历史和immudb状态文件，推荐使用挂载卷运行，通过以下参数指定容器内的存储路径：

shell
docker run -p 8091:8091 -v /host/path:/container/mountpoint codenotary/immuproof serve \
  --api-key {your api key} \
  --audit-state-folder=/container/mountpoint \
  --state-history-file=/container/mountpoint/state-history.json

环境变量配置

可通过环境变量配置服务，支持的环境变量如下：

使用环境变量运行示例：

shell
docker run -p 8091:8091 \
  -e IMMUPROOF_API_KEY={your api key} \
  -e IMMUPROOF_HOST=cas.codenotary.com \
  -e IMMUPROOF_PORT=443 \
  -e IMMUPROOF_AUDIT_INTERVAL=1h \
  -e IMMUPROOF_STATE_HISTORY_SIZE=72 \
  codenotary/immuproof serve

详细配置选项

serve命令参数

用于审计账本并启动HTTP REST服务器，支持以下参数：

Flags:
  --audit-interval duration         审计运行间隔时间（默认1h0m0s）
  --audit-state-folder string       存储immudb不可变状态的文件夹（默认"HOME/.local/state/immuproof"）
  -h, --help                            显示帮助信息
  --state-history-file string       存储不可变状态历史的绝对文件路径（JSON格式，默认"HOME/.local/state/immuproof/state-history.json"）
  --state-history-size int          不可变状态历史的最大数量（默认90）
  --web-address string              REST服务器地址（默认"localhost"）
  --web-cert-file string            证书文件绝对路径
  --web-hosted-by-logo-url string   "由...托管"Logo的URL
  --web-hosted-by-text string       "由...托管"副标题文本（默认"Hosted by:"）
  --web-key-file string             密钥文件绝对路径
  --web-port string                 REST服务器端口（默认"8091"）
  --web-title-text string           显示的标题文本（默认"COMMUNITY ATTESTATION SERVICE VALIDATOR"）

全局参数

Global Flags:
  --api-key strings   CAS API密钥，可多次指定。第一个密钥用于签名，每个提供的密钥对应的账本都会被审计。若未提供密钥，则不执行审计
  --cert string       用于建立与CAS服务器TLS连接的证书文件（本地或绝对路径）
  --config string     配置文件（默认"/root/.config/immuproof/.immuproof.yaml"）
  -a, --host string       CAS服务器主机地址（默认"localhost"）
  --no-tls            允许连接CAS服务器时使用不安全连接
  -p, --port int          CAS服务器端口号（默认443）
  --skip-tls-verify   禁用与CAS服务器连接时的TLS证书验证

示例：收集3天的状态检查（每小时1次）

shell
immuproof serve --api-key {your CAS api-key} --port 443 --host cas.codenotary.com --audit-interval 1h --state-history-size 72