photoprism/develop

PhotoPrism 构建环境镜像

镜像概述和主要用途

PhotoPrism 构建环境镜像是一个集成开发工具与编译器的专用环境，旨在为 PhotoPrism 项目开发者提供一致、高效的构建平台。该镜像预装了项目开发所需的各类工具链，简化源码编译、测试及贡献流程，确保开发环境的一致性和可重复性。

核心功能和特性

• 集成开发工具：包含 Git、Make、CMake 等基础构建工具，支持源码拉取、依赖管理及构建流程自动化。
• 编译器支持：预装 Go 编译器、Node.js、GCC 等编译工具链，满足 PhotoPrism 多语言开发需求（如后端 Go 代码、前端 JavaScript/TypeScript 代码编译）。
• 预配置环境：内置项目构建所需的依赖库（如图像处理库、数据库客户端等），无需手动安装，开箱即可使用。
• 开发流程兼容：支持 PhotoPrism 源码的本地构建、单元测试、集成测试及打包流程，与项目贡献指南（如提交 PR、代码编译规范）无缝衔接。

使用场景和适用范围

• PhotoPrism 项目开发：开发者用于本地修改、编译 PhotoPrism 源码，验证功能实现或 bug 修复。
• 贡献者工作流：贡献者在提交 PR 前，通过该环境进行本地编译和测试，确保代码符合项目构建规范。
• CI/CD 集成：可作为自动化构建流程的基础环境，用于持续集成中的代码编译、测试环节。

使用方法和配置说明

Docker Run 命令示例

通过以下命令启动构建环境，并挂载本地 PhotoPrism 源码目录进行开发：

bash
docker run -it --rm \
  -v /path/to/local/photoprism/source:/app \  # 挂载本地源码目录到容器内 /app
  -w /app \  # 设置工作目录为 /app（源码根目录）
  photoprism/build-env \  # 镜像名称
  make build  # 执行构建命令（如编译源码）

参数说明：

• -it：交互式终端，支持命令行操作。
• --rm：容器退出后自动删除，避免残留。
• -v：挂载本地源码目录至容器内，确保代码修改实时同步。
• -w：指定工作目录，默认为源码根目录。

Docker Compose 配置示例

创建 docker-compose.yml 文件，简化多环境配置：

yaml
version: '3.8'

services:
  photoprism-build:
    image: photoprism/build-env
    volumes:
      - ./photoprism-source:/app  # 本地源码目录（相对路径）挂载到容器 /app
    working_dir: /app
    environment:
      - GOPATH=/go  # Go 工作目录（可选，默认已配置）
      - NODE_ENV=development  # Node.js 环境（开发模式）
    command: make test  # 启动时执行测试命令

启动命令：

bash
docker-compose up

环境变量说明

配置参数

注意事项

• 源码目录权限：确保本地挂载的源码目录具有读写权限，避免容器内因权限不足导致构建失败。
• 依赖更新：若项目依赖库更新，建议重新拉取最新镜像（docker pull photoprism/build-env）以获取最新工具链。
• 网络需求：首次启动时，部分依赖可能需要联网下载，确保容器可访问外部网络。
• 贡献规范：使用该环境构建的代码需符合 PhotoPrism 项目贡献指南（如代码风格、测试要求），详情参考项目 贡献文档。

注：PhotoPrism® 是已注册商标。使用本镜像即表示同意 PhotoPrism 项目的 服务条款、隐私政策 及 行为准则。