ethyca/fideslog

fideslog API Docker镜像文档

镜像概述

fideslog API Docker镜像是Ethyca开发的容器化解决方案，用于部署fideslog服务——一个专注于隐私尊重的使用分析数据收集系统。该镜像封装了fideslog的核心API服务，支持开发者以隐私友好的方式收集、处理和存储产品使用数据，同时确保用户隐私得到严格保护。

核心功能与特性

• 隐私优先设计：默认采用数据化处理，不收集个人身份信息（PII），符合GDPR等隐私要求
• RESTful API服务：提供标准化API接口，支持客户端应用上报使用事件数据（事件类型、时间戳、***用户标识等）
• 轻量级部署：基于容器化架构，资源占用低，可快速集成到现有Docker环境
• 可配置化：支持通过环境变量自定义服务参数，适配不同部署场景需求

使用场景

• 隐私敏感型产品：需要收集使用数据但严格保护用户隐私的开发者或企业
• 开源项目集成：开源工具/框架希望了解用户使用情况，同时避免隐私合规风险
• 商业产品分析：商业软件或SaaS平台在合规前提下集成基础使用分析功能
• 内部工具监控：企业内部系统需要收集使用数据以优化功能，同时保护员工隐私

使用方法与配置说明

基本部署（Docker Run）

通过以下命令快速启动fideslog服务：

bash
docker run -d -p 8000:8000 --name fideslog ethyca/fideslog:latest

• -p 8000:8000：将容器内8000端口映射到主机（默认API服务端口）
• --name fideslog：指定容器名称便于管理

环境变量配置

支持通过环境变量自定义服务行为，常用配置参数如下：

自定义配置示例：

bash
docker run -d \
  -p 9000:9000 \
  -e PORT=9000 \
  -e LOG_LEVEL=DEBUG \
  -e CORS_ALLOWED_ORIGINS=https://example.com,https://app.example.com \
  --name fideslog ethyca/fideslog:latest

Docker Compose部署

创建docker-compose.yml实现多容器协调部署（如搭配外部数据库）：

yaml
version: '3'
services:
  fideslog:
    image: ethyca/fideslog:latest
    ports:
      - "8000:8000"
    environment:
      - LOG_LEVEL=INFO
      - DATABASE_URL=postgresql://user:password@db:5432/fideslog
    depends_on:
      - db
  
  db:
    image: postgres:14
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=fideslog
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:

启动服务：

bash
docker-compose up -d

数据持久化

默认使用容器内SQLite数据库存储数据，建议通过目录挂载实现数据持久化：

bash
docker run -d \
  -p 8000:8000 \
  -v ./fideslog-data:/app/data \
  -e DATABASE_URL=sqlite:////app/data/fideslog.db \
  --name fideslog ethyca/fideslog:latest

注意事项

• 生产环境建议使用外部数据库（如PostgreSQL）替代默认SQLite，提高数据可靠性
• 配置CORS_ALLOWED_ORIGINS时应限制具体域名，避免使用通配符*以增强安全性
• 定期备份持久化数据目录，防止数据丢失
• 根据实际负载调整容器资源限制（CPU/内存）