shommey/dockerized-quartz

Docker化Quartz

https://github.com/jackyzha0/quartz 是一款轻量级静态网站生成器，可帮助你托管个人数字花园。本项目提供自动化的Docker化解决方案，以最少的配置构建和服务Quartz站点。

https://github.com/shommey/dockerized-quartz

核心功能

• 极简配置：只需将现有Obsidian Vault作为Docker绑定卷挂载即可使用。
• 自动构建：当Docker卷中的笔记发生变化后，Quartz会在设定延迟后自动重建站点。
• 默认或自定义Quartz仓库：若本地无Quartz仓库，容器启动时会克隆默认仓库(https://github.com/jackyzha0/quartz)%E6%88%96%E4%BD%A0%E6%8C%87%E5%AE%9A%E7%9A%84%E8%87%AA%E5%AE%9A%E4%B9%89%E4%BB%93%E5%BA%93%E3%80%82
• 私有仓库支持：可隐藏你的Quartz配置。
• NGINX Web服务器：默认使用NGINX提供服务，基础配置可通过挂载卷编辑nginx.conf扩展。

使用场景

• 个人数字花园搭建：将Obsidian笔记转化为可公开访问的静态网站。
• 知识管理分享：分享个人知识库或学习笔记。
• 轻量级静态博客部署：快速构建无需数据库的静态博客。

配置说明

环境变量

• GIT_REPO：可选，指定自定义Quartz仓库地址，留空则使用默认仓库。
• GIT_BRANCH：可选，指定要检出的仓库分支，默认使用v4。
• BUILD_UPDATE_DELAY：可选，笔记变化后触发构建的延迟时间（秒），默认300秒。
• AUTO_REBUILD：可选，是否在Obsidian Vault变化后自动重建，默认true。

卷挂载

• /path/on/host:/vault:ro：挂载Obsidian Vault供Quartz读取和构建。
• /path/on/host:/usr/src/app/quartz：可选，挂载已有的Quartz仓库。
• /path/to/nginx/logs:/var/log/nginx：可选，持久化NGINX日志。
• /path/on/host:/etc/nginx：可选，挂载自定义NGINX配置。

快速部署示例

Docker Compose方式

1. 克隆仓库：

   bash
   git clone https://github.com/shommey/dockerized-quartz.git
   cd dockerized-quartz
   

2. 复制示例配置文件：

   bash
   cp docker-compose.yml.example docker-compose.yml
   

3. 编辑docker-compose.yml：

   yaml
   version: '3.8'
   services:
       quartz:
           image: shommey/dockerized-quartz
           container_name: quartz-notes
           environment:
               # 可选：指定自定义Quartz仓库地址
               # GIT_REPO: "https://github.com/你的用户名/你的Quartz站点.git"
               # 可选：指定仓库分支
               # GIT_BRANCH: "v4"
               # 可选：构建延迟时间（秒）
               BUILD_UPDATE_DELAY: 900
               # 可选：自动重建开关
               AUTO_REBUILD: true
           volumes:
               # 挂载Obsidian Vault
               - /本地路径:/vault:ro
               # 可选：挂载已有Quartz仓库
               # - /本地路径:/usr/src/app/quartz
               # 可选：持久化NGINX日志
               # - /本地路径:/var/log/nginx
               # 可选：挂载自定义NGINX配置
               # - /本地路径:/etc/nginx
           ports:
               # 映射主机端口到容器80端口
               - "80:80"
           restart: unless-stopped
   

4. 启动服务：

   bash
   docker compose up -d
   

访问你的Quartz站点：http://<你的机器IP>:<端口>