Справочник config.yaml

Загрузка и defaults

Config читается из YAML, затем нормализуется.

Приоритет пути:

1. --config
2. CONFIG_PATH
3. config.yaml

Актуальные стартовые значения для template-репозиториев (notepub-recipe-blog, notepub-recipe-docs):

• site.id: default
• content.source: local
• content.local_dir: ./content
• paths.file_root: ./.notepub
• paths.artifacts_dir: ./.notepub/artifacts
• paths.snapshot_file: ./.notepub/snapshot/objects.json
• paths.cache_root: ./.notepub/cache
• theme.dir: .
• theme.name: theme
• theme.templates_subdir: templates
• theme.assets_subdir: assets
• server.listen: 127.0.0.1:8080
• cache.html_ttl_seconds: 600
• cache.stale_if_error_seconds: 604800

Системные defaults движка (если поля не заданы) могут отличаться от recipe-конфигов.

site

• id: идентификатор пространства кеша (по умолчанию default).
• base_url: обязательный, нормализуется без завершающего /.
• title, description: default-метаданные.
• default_og_image: fallback-картинка OpenGraph.
• media_base_url: опциональная абсолютная база для медиа.
• host: основной allowlist host для serve.
• host_aliases: дополнительные разрешенные host для serve.

content

• source: local или s3.
• local_dir: путь для local-режима; относительный путь резолвится от директории config. Если source=local и local_dir не задан, используется markdown.

Если content.source пуст:

• выбирается local, если s3.bucket пуст
• выбирается s3, если s3.bucket задан

s3

• endpoint, region, force_path_style
• bucket (обязателен для content.source: s3)
• prefix нормализуется без ведущего /; если задан, движок добавляет завершающий /
• credentials:
  • либо обе пары access_key + secret_key, либо ни одной
  • при отсутствии пары используется AWS default credential chain
• anonymous: true выключает подпись запросов (публичный bucket)

og_type_by_type

Карта соответствия type -> og:type для OpenGraph.
Пример: article: article, page: website.

theme

• dir, name
• templates_subdir (по умолчанию templates)
• assets_subdir (по умолчанию assets)

paths

• artifacts_dir: директория чтения/записи index-артефактов
• snapshot_file: snapshot-файл для инкрементальной индексации
• cache_root: корень HTML-кеша в serve

robots

• disallow: список путей для robots.txt.
• extra: произвольный текст, который дописывается в robots.txt.

cache

• html_ttl_seconds: TTL HTML-кеша в serve (по умолчанию 600).
• stale_if_error_seconds: период выдачи stale-кеша при ошибках (по умолчанию 604800).

media

• expose_all_under_prefix:
  • false: /media/* только для медиа, найденных в индексированном markdown
  • true: открыть все медиа под заданным prefix

rules_path

Если не указан, по умолчанию ищется rules.yaml рядом с config-файлом.

Валидация при загрузке

• site.base_url обязателен.
• content.source должен быть только local или s3.
• Для source=s3 обязателен s3.bucket.
• Для source=s3 ключи s3.access_key и s3.secret_key задаются только парой.