# 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 as a live, static website on Unraid. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2241/quartz-builder

## Description

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 as a live, static website on Unraid.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

12/100 (Low), based on 3 of 4 factors.
- Maintained: 2 (last commit 707 days ago)
- Popular: 10 (2 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/typingpenguin/quartz_builder
- GitHub: https://github.com/TypingPenguin/quartz_builder
- Unraid: https://ca.unraid.net/apps/quartz-builder-0yynu200okx4b8?q=quartz-builder

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/2241/quartz-builder), the self-hosted and open-source app directory.
