Mounting the Vault as a Volume
The container path of the Obsidian vault is located at /vault. If no volume bind is provided, the container will copy example documentation to /vault, allowing it to be used as a demonstration.
The recommended way to provide the Obsidian vault to the container is by using a bind-mount volume:
-v /path/on/host:/vault:roNote
When possible use the :ro (read-only) flag to prevent unintentional modifications to the vault from within the container.
Updating the Vault
There are two main methods to update the vault contents: External Updates and Git-based Updates.
1. External Updates
If you are using an external tool such as Syncthing, direct editing with Obsidian, or any other synchronization method, you can trigger a rebuild of the Quartz site through an auto-rebuild mechanism, a cron job, or a webhook.
Example: Syncthing Setup
- Syncthing can sync the entire Obsidian vault to a directory, e.g.,
/home/user/Obsidian/. - Bind volume to container
-v /home/user/Obsidian:/vault:ro - Quartz will detect changes when syncthing syncs and execute rebuild
- If auto update (detect on file changes) is disabled, cronjob or webhook can be used to execute update.
Post Webhook Plugin can be useful for this scenario.
2. Git-based Updates
If your Obsidian vault is hosted in a Git repository (e.g., GitHub), follow these steps:
- Prepare the vault folder on the host machine:
mkdir /path/on/host/vault - Perform an initial Git clone or pull into this folder:
git clone <your-repo-url> /path/on/host/vault - Set the environment variable to enable automatic Git pulls:
VAULT_DO_GIT_PULL_ON_UPDATE=true - Choose an update strategy:
- Cron job: Schedule periodic updates
- Webhook: Trigger rebuilds on repository changes
Before rebuilding, the container will execute a git pull inside /vault to fetch the latest changes.
Note:
When using Git-based updates volume needs read-write permissions to execute git pull. Mount volume with /path/on/host/git_vault:/vault without the :ro flag.