Quartz-builder
Quartz Builder is a self-hosted Docker container that pairs the Quartz static site generator with a Node.js web server, letting you publish an Obsidian vault…
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
12/100 Low
- Maintained
- 2last commit 707 days ago
- Popular
- 102 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
Based on 3 of 4 factors.
Availability: platform listings confirmed today, links checked 29 days ago
- GitHub stars
- 2
- Open issues
- 1
- Last commit
- 2024-12-14
- Activity
- stale
Checked 9 days ago - source: GitHub (TypingPenguin/quartz_builder)
Resources & Compatibility
ARM (e.g. Raspberry Pi) is not supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Install dependencies and plugins first Run the dependency and plugin install commands before building, so npm (the package installer) and npx (the command runner) get everything the site needs. If you skip this, the build can fail or features may be missing. source
- Set site details during first setup When initializing a new site, choose a template and set the base URL (the web address where the site will be published). A wrong base URL can cause broken links or pages that do not load correctly. source
- Docker preview needs a ready image Before using the Docker preview, make sure Docker is installed and the Quartz image is built. The provided command opens ports 8080 and 3001 and shares your ./content folder, so the preview is reachable and your note edits show up. source
- Volumes and ports Map your Obsidian vault to the /vault volume and the generated site to /output; port 3000 serves the live preview. source
Fetched 39 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Which volumes should I mount for quartz-builder?
Mount your Obsidian vault to /vault and the generated site to /output. The /app volume is optional and should only be used for local development after npm install.
How do I change the rebuild delay and the vault folder that gets published?
Set TIMER to the delay that must pass after document changes before the build pipeline runs, and set FOLDER to the vault folder to output. The default is /public, and leaving FOLDER empty outputs the vault root.
What must I do before building the Quartz site?
Run the dependency and plugin install commands before building so npm and npx get everything the site needs. If you skip this, the build can fail or features may be missing.
What setting should I configure so pages and links work correctly after publishing?
Set the base URL when initializing a new Quartz site. A wrong base URL can cause broken links or pages that do not load correctly.
Answers sourced from github.com, quartz.jzhao.xyz, quartz.jzhao.xyz
Community
- Quartz v4: a free Obsidian Publish alternative : r/ObsidianMD - Reddit (reddit)
- Best way to self-host obsidian publish? : r/ObsidianMD - Reddit (reddit)
- Frequently Asked Questions - Forum Quartz (forum)
- [SUPPORT] Quartz builder - Docker Containers - Unraid (forum)
- Forum Quartz - Stone Inspired Collection (forum)
Collected 53 days ago - public community threads