shommey/dockerized-quartz repository overview

⁠Dockerized Quartz

Quartz (v4)⁠ is a lightweight static site generator that helps you host your digital garden. This project provides automated dockerized solution to build and serve Quartz sites with minimal configuration.

Github source⁠

⁠Features

• Minimal Configuration: Simply plug in your existing Obsidian Vault as docker bind volume.

• Automated Builds: Quartz will rebuild every time after set delay as notes in your docker voulume change.

• Default or Custom Quartz Repository: If none present, container will clone git repo on startup, the Quartz repo⁠ or your custom one.

• Support for Private Repositories: If you want to hide your Quartz config.

• NGINX Web Server: Served with NGINX, basic configuration by default, can be extended by mounting docker volume and editing nginx.conf

⁠Quick Start

To quickly get started with Quartz in Docker:

1. Clone the repository:

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

   Copy

2. Copy docker-compose example:
   cp docker-compose.yml.example docker-compose.yml

3. Edit compose file:

   version: '3.8'
   services:
       quartz:
           image: shommey/dockerized-quartz
           container_name: quartz-notes
           environment:
           # Use your custom Quartz repo or leave blank for the default Quartz repo
           # GIT_REPO: "https://github.com/yourusername/your-quartz-site.git"
           # Optional: specify a branch to checkout
           # GIT_BRANCH: "v4"
           # Optional: Update delay after which quartz build will trigger, default 300 seconds
           BUILD_UPDATE_DELAY: 900
           # Optional: Auto rebuild Quartz after change in Obsidian Vault 
           AUTO_REBUILD: true
           volumes:
           # Mount your Obsidian vault for Quartz to read and build the site from
           - /path/on/host:/vault:ro
           # Optional: Mount existing Quartz repo
           # - /path/on/host:/usr/src/app/quartz
           # Optional: Persist nginx logs if needed
           # - /path/to/nginx/logs:/var/log/nginx
           # Optional: Mount nginx conf
           # - /path/on/host:/etc/nginx
           ports:
           # Map any port on the host to port 80 in the container for web access
           - "80:80"
           restart: unless-stopped
   

   Copy

4. Run it:
   docker compose up -d in the repo directory.
   Access your Quartz site on http://<YOUR_MACHINE_IP>:<PORT>