luzzle/docs/web/config.example.yaml at main · eleith/luzzle · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# yaml-language-server: $schema=https://git.eleith.com/eleith/luzzle/raw/branch/main/packages/web/templates/config.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.

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