islandora/crayfish

Crayfish 镜像文档

1. 镜像概述和主要用途

Crayfish 镜像是 https://github.com/Islandora/Crayfish/tree/4.x%EF%BC%88**%E6%9C%AA%E5%8F%91%E5%B8%83%E7%89%88%E6%9C%AC**%EF%BC%89%E7%9A%84 Docker 基础镜像，构建自 https://github.com/Islandora-DevOps/isle-buildkit/tree/main/crayfish 项目。该镜像作为基于 Crayfish 的微服务的基础镜像，用于缓存下载资源，不旨在单独运行，仅作为构建过程中的缓存层。

2. 核心功能和特性

• 提供 Crayfish 微服务（如 Houdini、Hypercube、Homarus 等）的基础运行环境
• 预缓存 Crayfish 相关依赖和代码，加速后续微服务构建流程
• 集成 JWT 认证支持，与 Islandora 生态系统安全机制兼容
• 包含 Recast、Homarus、Hypercube、Houdini、Milliner、CrayFits 等子服务的基础配置

3. 使用场景和适用范围

适用于 Islandora 数字资产管理系统生态中，基于 Crayfish 框架的微服务构建与部署流程。作为基础镜像，主要用于开发和构建阶段，为上层微服务提供统一的运行环境和依赖基础，不直接用于生产环境独立部署。

4. 使用方法和配置说明

4.1 依赖要求

构建该镜像需依赖 islandora/nginx 镜像。有关 Nginx 镜像的详细配置（包括额外设置、卷、端口等），请参考 Nginx 镜像文档。

4.2 端口说明

4.3 配置设置

4.3.1 JWT 认证设置

Crayfish 微服务使用 JWT 进行身份验证，具体配置方法请参考 基础镜像文档 中的相关说明。

5. 镜像更新方法

5.1 修改构建参数

如需更新 Crayfish 版本，需修改 Dockerfile 中的 COMMIT 和 SHA256 构建参数（以下示例中以 XXXXXXXXXXXX 占位）：

Dockerfile
ARG COMMIT=XXXXXXXXXXXX
#...
ARG SHA256=XXXXXXXXXXXX

5.2 生成 SHA256 值

使用以下命令生成新的 SHA256 校验值：

bash
COMMIT=$(cat crayfish/Dockerfile | grep -o 'COMMIT=.*' | cut -f2 -d=)
FILE=$(cat crayfish/Dockerfile | grep -o 'FILE=.*' | cut -f2 -d=)
URL=$(cat crayfish/Dockerfile | grep -o 'URL=.*' | cut -f2 -d=)
FILE=$(eval "echo $FILE")
URL=$(eval "echo $URL")
wget --quiet "${URL}"
shasum -a 256 "${FILE}" | cut -f1 -d' '
rm "${FILE}"

5.3 更新 Composer 锁定文件

修改 COMMIT 和 SHA256 后，需同步更新各子服务的 composer.lock 文件，执行以下命令：

bash
make bake TARGET=crayfish

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/Recast/composer.lock:/var/www/crayfish/Recast/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/Recast && composer update"

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/Homarus/composer.lock:/var/www/crayfish/Homarus/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/Homarus && composer update"

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/Hypercube/composer.lock:/var/www/crayfish/Hypercube/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/Hypercube && composer update"

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/Houdini/composer.lock:/var/www/crayfish/Houdini/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/Houdini && composer update"

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/Milliner/composer.lock:/var/www/crayfish/Milliner/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/Milliner && composer update"

docker run --rm -ti \
  -v $(pwd)/crayfish/rootfs/var/www/crayfish/CrayFits/composer.lock:/var/www/crayfish/CrayFits/composer.lock \
  --entrypoint ash islandora/crayfish:local -c \
    "cd /var/www/crayfish/CrayFits && composer update"

参考链接

• https://github.com/Islandora/Crayfish/tree/4.x
• 基础镜像文档
• Nginx 镜像文档