xemle/home-gallery-api-server

HomeGallery API服务器镜像（人脸和物体检测）

镜像概述

本镜像为HomeGallery项目的API服务器组件，专注于提供人脸和物体检测功能。作为HomeGallery应用的后端服务，它通过API接口为前端应用提供智能识别能力，帮助用户在个人媒体库中实现人脸与物体的自动检测和标记。项目官网：[***]

核心功能与特性

主要功能

• 人脸检测：自动识别媒体文件中的人脸区域并进行标记
• 物体检测：识别图像/视频中的物体类别（如人、动物、交通工具等）
• API服务：以独立API服务器模式运行，提供标准化检测接口
• HomeGallery集成：与HomeGallery主应用无缝对接，支持其智能媒体管理功能

使用场景与适用范围

• 个人照片库管理：为个人媒体库添加智能识别能力，实现人脸/物体分类检索
• 家庭媒体服务器：增强家庭媒体中心的内容组织能力，提升用户体验
• HomeGallery配套组件：作为HomeGallery应用的必要后端服务，确保其核心识别功能运行
• 开发者测试：供开发者调试或集成人脸/物体检测API到自定义媒体应用中

使用方法与配置说明

基本运行命令

通过Docker运行镜像的基础命令：

bash
docker run -d \
  --name homegallery-api \
  -p 3000:3000 \  # 映射API服务端口（默认端口请以官方文档为准）
  homegallery/api-server

配置参数说明

端口映射

默认情况下，API服务器监听容器内的3000端口（具体端口请参考HomeGallery官方文档），通过-p参数映射到主机端口，例如：

bash
-p 8080:3000  # 将主机8080端口映射到容器3000端口

环境变量（示例）

可通过环境变量调整服务行为（具体支持的变量请以官方文档为准）：

bash
docker run -d \
  --name homegallery-api \
  -p 3000:3000 \
  -e DETECTION_THRESHOLD=0.7 \  # 检测置信度阈值（0.0-1.0）
  -e LOG_LEVEL=info \  # 日志级别（debug/info/warn/error）
  homegallery/api-server

数据持久化（如需）

若需持久化检测结果或模型文件，可挂载数据卷：

bash
docker run -d \
  --name homegallery-api \
  -p 3000:3000 \
  -v /host/path/to/data:/app/data \  # 挂载数据目录到容器
  homegallery/api-server

与HomeGallery集成

1. 确保API服务正常运行并可被HomeGallery主应用访问
2. 在HomeGallery配置中指定API服务器地址（如http://localhost:3000）
3. 具体集成步骤请参考HomeGallery官方文档中的配置指南

注意事项

• 检测功能对计算资源要求较高，建议在CPU性能较好或支持GPU的环境中运行
• 首次启动可能需要下载检测模型文件，耗时取决于网络环境
• 完整配置参数、高级用法及故障排除，请访问官方网站：[***]