Files
luzzle/docs/web/config.example.yaml
eleith 176970b04f
ci/woodpecker/pr/web Pipeline was successful
ci/woodpecker/push/web Pipeline was successful
[web] serve the bundled editor schema at /schema.json
2026-11-03 09:04:43 -08:00

86 lines
3.3 KiB
YAML

# yaml-language-server: $schema=http://localhost:8080/schema.json
# Save as config/config.yaml beside docker-compose.yml. No checkout files needed.
url:
app: http://localhost:8080 # Change to your public URL before sharing.
# Addresses inside the published-image Compose network, not browser URLs.
network:
internal:
explorer: http://luzzle-web:3000
worker: http://luzzle-worker:9000
lsp: http://luzzle-lsp:9001
content:
text:
title: My garden
description: A few things worth keeping.
# Optional local files, each a readable regular file <=5 MiB.
# Relative to /app/config.yaml: ./content/images means /app/content/images.
# Uses the existing read-only content mount.
# Schema defaults: /images/favicon.png and /images/opengraph.png (bundled files).
# images:
# favicon: ./content/images/favicon.png # PNG, SVG, ICO.
# opengraph: ./content/images/share.png # PNG, JPEG, WebP, GIF.
# Files are reread on use; restart web only for config changes.
# Optional local sans font: WOFF2 only, readable regular file <=5 MiB.
# Resolve from /app/config.yaml; the content mount serves both web and worker.
# fonts:
# sans: ./content/fonts/my-font.woff2
# Overrides the browser font-sans-url and the worker's paths.static lookup.
# Omit to retain the bundled/default font-sans-url behavior.
# Reread on use; restart web + worker only for config changes. Republish for new OGs.
# Pair a local font with its actual family and supported weight range.
# theme:
# globals:
# font-sans-name: '"My Font"'
# font-sans-weight: 300 900
# No font-sans-url needed: content.fonts.sans uses /assets/fonts/my-font.woff2.
# See config.md#local-sans-font for licensing, caching and failure behavior.
# Match this type and these frontmatter selectors to your own archive.
# For example: hello.notes.md, with title and date_published in its frontmatter.
pieces:
- type: notes
fields:
title: title
summary: summary
date_consumed: date_published
tags: tags
templates:
icon:
name: lined-notebook-paper
page:
name: note
opengraph:
name: lined-notebook-paper
# Omitted auth means public-only: no admin editing or publishing.
# To enable admin access, uncomment this block and supply your own values in .env.
# Generate a session secret with: openssl rand -hex 32
# auth:
# secret: '${LUZZLE_AUTH_SECRET}'
# credentials:
# username: '${LUZZLE_AUTH_USERNAME}'
# password: '${LUZZLE_AUTH_PASSWORD}'
# Optional ordinary Markdown files. Create them before enabling these settings.
# Paths below resolve from /app/config.yaml, so ./content means /app/content.
# pages:
# home:
# body: ./content/home.md
# feed:
# about: ./content/feed-about.md
# error:
# "404": # Selected before "4xx"; each slot defaults to {}.
# body: ./content/not-found.md # Omit for built-in copy.
# home: true # Default: show the home link.
# "4xx": # All remaining client errors, independently configured.
# body: ./content/client-error.md
# home: false
# "500": # All server errors; the actual HTTP status is preserved.
# body: ./content/server-error.md
# home: true
# Error Markdown is loaded lazily for the selected slot; failures use built-in copy.
# Restart web after changing error settings or Markdown files.