diff --git a/Applications/quartz-docker.md b/Applications/quartz-docker.md index e4765c2..db40fa1 100644 --- a/Applications/quartz-docker.md +++ b/Applications/quartz-docker.md @@ -29,13 +29,23 @@ See a list of all Environment Variables [[environment variables|here.]] ``` 2. Create a `docker-compose.yml` file -#### Minimal + + #### Minimal + ![[minimal docker-compose]] + ##### `BASE_URL` + The only required variable is `BASE_URL`. The rest are set to the developer's [defaults](https://quartz.jzhao.xyz/configuration) `BASE_URL` sets both quartz's `baseUrl` as well as nginx's `server_name`. -#### Recommended - ![[recommended docker-compose]] - **node_modules volume:** To keep the image small, `node_modules` are not included. When the container is run, they're downloaded to `/usr/share/nginx/html/node_modules`. You should keep them in a volume so that the modules persist between container runs. + #### Recommended - [[cron]] You should also set `ENABLE_CRON` to `true` and set `BUILD_SCHEDULE` to a cron expression to enable the cron job that `npx quartz build` is executed which will pull the latest content and build the site. + ![[recommended docker-compose]] + + ##### node_modules volume + + To keep the image small, `node_modules` are not included. When the container is run, they're downloaded to `/usr/share/nginx/html/node_modules`. You should keep them in a volume so that the modules persist between container runs. + + ##### [[cron]] + + You should also set `ENABLE_CRON` to `true` and set `BUILD_SCHEDULE` to a cron expression to enable the cron job that `npx quartz build` is executed which will pull the latest content and build the site.