mille535/dockerized-quartz

Dockerized Quartz

免责声明： 我不是原始作者，也不隶属于Quartz、Obsidian或原始Dockerized Quartz项目（shommey/dockerized-quartz）。此分支运行在Alpine基础节点容器中，以减少完整Ubuntu镜像的开销。

https://github.com/jackyzha0/quartz 是一个轻量级静态网站生成器，帮助你以最少的设置托管数字花园。本项目提供自动化的Docker化解决方案，轻松构建和服务Quartz站点。只需将你的Obsidian Vault挂载为Docker卷，Quartz就会处理剩下的工作！

核心功能

• 🚀 最小配置：只需将现有Obsidian Vault作为Docker绑定卷插入。
• 🔄 自动构建：当Docker卷中的笔记更改时，会在设定延迟后自动重建。
• 🔗 Webhook触发：通过向秘密URL发送POST请求触发构建。
• 📢 通知：在构建开始、成功或失败时获取通知。
• 📦 默认或自定义Quartz仓库：如果不存在，容器将在启动时克隆https://github.com/jackyzha0/quartz%EF%BC%8C%E6%88%96%E4%BD%A0%E5%8F%AF%E4%BB%A5%E6%8F%90%E4%BE%9B%E8%87%AA%E5%B7%B1%E5%AE%9A%E5%88%B6%E7%9A%84Quartz%E3%80%82
• 🔒 支持私有仓库：保持你的Quartz配置私有。
• 🌐 NGINX Web服务器：使用NGINX提供服务，基础配置可扩展。

使用场景

• 个人数字花园托管：将Obsidian笔记转换为可公开访问的静态网站，分享知识。
• 团队知识管理：集中管理团队的Obsidian笔记，并通过Web界面共享。
• 快速原型：快速搭建基于笔记的静态站点，无需复杂的服务器配置。

配置说明

环境变量

• GIT_REPO：可选，自定义Quartz仓库地址，留空则使用默认Quartz仓库。
• GIT_BRANCH：可选，指定要检出的分支，如"v4"。
• BUILD_UPDATE_DELAY：可选，Quartz构建触发前的更新延迟（秒），默认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.yml文件：

1. 编辑compose文件：

   yaml
   version: '3.8'
   services:
       quartz:
           image: mille535/dockerized-quartz
           container_name: quartz-notes
           environment:
           # 使用自定义Quartz仓库或留空使用默认
           # GIT_REPO: "https://github.com/yourusername/your-quartz-site.git"
           
           # 可选：指定分支
           # GIT_BRANCH: "v4"
           
           # 可选：构建触发延迟（秒），默认300
           BUILD_UPDATE_DELAY: 120
   
           # 可选：Obsidian Vault更改后自动重建
           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
   

2. 运行：在文件目录执行docker compose up -d，访问http://<你的机器IP>:<端口>即可查看Quartz站点。

更多详细设置请https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/index.md%E3%80%82

文档

1. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/overview.md
2. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/providing-quartz.md
3. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/importing-vault.md
4. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/basic-auth.md
5. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/build-from-source.md
6. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/trigger-rebuild-with-webhook.md
7. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/cron-job-trigger.md
8. https://github.com/shommey/dockerized-quartz/blob/54ad48408d9e65cd7356c2440c46bc30823ae4b7/docs/notifications.md

致谢

本项目基于并集成了多个开源项目：

• https://github.com/shommey/dockerized-quartz - 此容器的官方仓库，我仅更新了部分包并适配了自己的需求。
• https://github.com/jackyzha0/quartz – 驱动本项目的核心静态网站生成器。
• https://github.com/caronc/apprise – 处理构建状态更新的通知。
• NGINX – 用可配置的Web服务器提供生成的Quartz站点。

非常感谢这些项目的维护者所做的出色工作！🚀