hugo-node 镜像文档

镜像概述

hugo-node 镜像是由 Eclipse Foundation 维护的 Docker 镜像，集成了 Hugo 静态网站生成器和 Node.js 环境。该镜像旨在提供一个便捷的开发和构建环境，用于创建和部署基于 Hugo 的静态网站项目，同时满足需要 Node.js 运行时支持的构建流程需求。

核心功能和特性

• 集成环境：同时包含 Hugo 和 Node.js，满足静态网站开发的完整构建需求
• 版本稳定：基于官方稳定版本构建，确保开发环境一致性
• 多平台支持：支持多种架构的 Docker 环境
• 即开即用：无需手动配置 Hugo 和 Node.js 环境，简化项目构建流程
• 灵活配置：可通过环境变量和命令参数自定义构建过程

使用场景和适用范围

• Hugo 静态网站项目的开发和测试
• 需要 Node.js 预处理步骤的 Hugo 网站构建流程
• 静态网站的 CI/CD 自动化构建流程
• 多环境一致的静态网站开发环境
• 快速原型开发和演示环境搭建

使用方法和配置说明

基本使用

交互式运行

docker run -it --rm -v $(pwd):/app eclipsefdn/hugo-node bash

执行 Hugo 命令

docker run --rm -v $(pwd):/app eclipsefdn/hugo-node hugo version

执行 Node.js/NPM 命令

docker run --rm -v $(pwd):/app eclipsefdn/hugo-node npm install

Docker Compose 配置示例

version: '3'

services:
  hugo:
    image: eclipsefdn/hugo-node
    volumes:
      - ./:/app
    working_dir: /app
    command: hugo server --bind=0.0.0.0 --baseURL=http://localhost
    ports:
      - "1313:1313"

构建静态网站示例

# 安装依赖
docker run --rm -v $(pwd):/app eclipsefdn/hugo-node npm install

# 构建网站
docker run --rm -v $(pwd):/app eclipsefdn/hugo-node hugo --minify

# 本地预览
docker run --rm -v $(pwd):/app -p 1313:1313 eclipsefdn/hugo-node hugo server --bind=0.0.0.0

CI/CD 集成示例 (GitHub Actions)

name: Build Hugo Site

on:
  push:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Build with hugo-node
        uses: docker://eclipsefdn/hugo-node
        with:
          args: sh -c "npm install && hugo --minify"
          
      - name: Deploy
        uses: some-deployment-action

环境变量

镜像构建信息

• Dockerfile 源代码: [***]
• 维护者: Eclipse Foundation
• 许可证: Eclipse Public License 2.0

注意事项

• 确保项目目录正确挂载到容器内的 /app 目录
• 对于需要网络访问的 Hugo 命令（如 hugo server），需指定 --bind=0.0.0.0 以允许外部访问
• 生产环境构建建议使用 --minify 参数优化输出文件
• 如需持久化 Node.js 依赖，可考虑将 node_modules 目录挂载为卷或使用构建缓存

版本信息

镜像标签遵循以下命名约定：

• latest: 最新稳定版本
• <hugo-version>-node<node-version>: 特定版本组合
• <hugo-version>-node<node-version>-<timestamp>: 带构建时间戳的版本

具体版本信息请参考 GitHub 仓库的最新发布说明。