narratio/docs/config.md

Configuration

1. Overview

Narratio loads two YAML files:

• pipeline.yml: pipeline-level runtime configuration.
• session.yml: per-session metadata and input selection.

These commands load and validate both files before running:

• narratio run
• narratio plan
• narratio resume
• narratio run-stage

Behavior:

• strict YAML decode is enabled (KnownFields(true)): unknown fields fail.
• session templates render before session YAML decode.
• defaults are applied for optional pipeline fields.
• validation enforces required fields, value formats, and cross-field constraints.

2. Config file discovery

Pipeline config lookup for run, plan, resume, and run-stage:

• If --config <path> is provided, that path is used.
• If omitted, Narratio searches in order:
  1. /usr/local/etc/narratio/pipeline.yml
  2. /etc/narratio/pipeline.yml
• First existing file wins.

3. Session file discovery and templating

Session config lookup for run, plan, resume, and run-stage:

• If --session <path> is provided, that path is used.
• If omitted, Narratio searches in order:
  1. ./session.yml
  2. /usr/local/etc/narratio/session.yml
  3. /etc/narratio/session.yml
• First existing file wins.

Template behavior:

• Supported placeholders:
  • {{session_id}}
  • {{ session_id }}
• --session-id <value> supplies the placeholder value.
• unresolved placeholders fail load.
• if rendered session_id mismatches --session-id, load fails.

4. Minimal pipeline config

whisperx:
  transcribe_url: "https://transcription.example.com/transcribe"

Why this is sufficient:

• whisperx.transcribe_url is required.
• workspace.root defaults to /var/lib/narratio.
• optional sections (seriatim, audita, archive, scriptorium, trim, normalize, etc.) receive defaults or stay inactive.

5. Minimal session template

session_id: "{{ session_id }}"
campaign: sample-campaign
inputs:
  audio_dir: ./audio
  speakers_file: ./examples/speakers.yml
  autocorrect_file: ./examples/autocorrect.yml
  glossary_file: ./examples/glossary.yml

Usage:

narratio run --config /path/to/pipeline.yml --session ./session.yml --session-id 2026-05-03

6. Production-oriented config

workspace:
  root: /var/lib/narratio/workspace
  cleanup_after_archive: true

storage:
  backend: s3
  s3:
    bucket: my-dnd-archive
    root_prefix: dnd
    region: us-east-1
    access_key_id_env: OBJECT_STORAGE_KEY_ID
    secret_access_key_env: OBJECT_STORAGE_KEY

spool:
  root: /var/spool/narratio
  delete_audio_after_archive: true

archive:
  enabled: true
  upload_run: true
  promote_artifacts:
    - from: transcripts/trimmed.json
      to: transcripts/trimmed.json
      required: true
    - from: artifacts/session_recap.md
      to: artifacts/session_recap.md
      required: true

whisperx:
  transcribe_url: "https://transcription.example.com/transcribe"

scriptorium:
  artifacts:
    session_recap:
      enabled: true
      prompt_id: dnd.session_recap
      output_path: artifacts/session_recap.md
      inputs:
        transcript:
          source: narratio.transcript.trimmed
          required: true

Operational notes:

• archive promotion is explicit and path-based via archive.promote_artifacts.
• Narratio does not auto-promote all generated analyze artifacts.

7. Full pipeline reference

Path	Type	Required	Default
pipeline.workspace.root	string	No	/var/lib/narratio
pipeline.workspace.cleanup_after_archive	bool	No	false
pipeline.secrets.env_dir	string	Conditional	none
pipeline.storage.backend	string	No	empty
pipeline.storage.bucket	string	No	empty
pipeline.storage.prefix	string	No	empty
pipeline.storage.s3.bucket	string	Conditional	empty
pipeline.storage.s3.root_prefix	string	No	dnd
pipeline.storage.s3.region	string	No	empty
pipeline.storage.s3.endpoint	string	No	empty
pipeline.storage.s3.force_path_style	bool	No	false
pipeline.storage.s3.access_key_id_env	string	No	OBJECT_STORAGE_KEY_ID
pipeline.storage.s3.secret_access_key_env	string	No	OBJECT_STORAGE_KEY
pipeline.spool.root	string	No	/var/spool/narratio
pipeline.spool.delete_audio_after_archive	bool	No	false
pipeline.archive.enabled	bool	No	true
pipeline.archive.upload_run	bool	No	true
pipeline.archive.promote_artifacts[]	list	No	trimmed + session_recap rules
pipeline.archive.promote_artifacts[].from	string	Yes (per rule)	none
pipeline.archive.promote_artifacts[].to	string	Yes (per rule)	none
pipeline.archive.promote_artifacts[].required	bool	No	true
pipeline.whisperx.transcribe_url	string	Yes	none
pipeline.whisperx.language	string	No	en
pipeline.whisperx.timeout	duration string	No	30m
pipeline.whisperx.retries	int	No	3
pipeline.whisperx.retry_delay	duration string	No	2s
pipeline.whisperx.concurrency	int	No	2
pipeline.seriatim.binary	string	No	seriatim
pipeline.seriatim.timeout	duration string	No	10m
pipeline.seriatim.output_schema	string	No	seriatim-intermediate
pipeline.seriatim.coalesce_gap	float	No	3.0
pipeline.seriatim.report	bool	No	true
pipeline.seriatim.env.overlap_word_run_gap	float	No	unset
pipeline.seriatim.env.overlap_word_run_reorder_window	float	No	unset
pipeline.seriatim.env.backchannel_max_duration	float	No	unset
pipeline.seriatim.env.filler_max_duration	float	No	unset
pipeline.audita.binary	string	No	audita
pipeline.audita.timeout	duration string	No	3h
pipeline.audita.llm_api_key_env	string	No	empty
pipeline.audita.modules[]	list[string]	No	empty
pipeline.audita.base_url	string	No	empty
pipeline.audita.model	string	No	empty
pipeline.audita.total_llm_concurrency	int	No	unset
pipeline.audita.proposal_llm_concurrency	int	No	unset
pipeline.audita.validation_model	string	No	empty
pipeline.audita.validation_llm_concurrency	int	No	unset
pipeline.audita.transcript_description	string	No	empty
pipeline.audita.config_path	string	No	empty
pipeline.audita.output_schema	string	No	empty
pipeline.audita.work_dir_retention	string	No	empty
pipeline.audita.report	bool	No	true
pipeline.normalize.output_path	string	No	transcripts/normalized.json
pipeline.normalize.output_schema	string	No	seriatim-intermediate
pipeline.normalize.report	bool	No	true
pipeline.trim.enabled	bool	No	false
pipeline.trim.output_path	string	Conditional	none
pipeline.trim.bounds.prompt_id	string	Conditional	none
pipeline.trim.bounds.profile_id	string	No	empty
pipeline.trim.bounds.transcript_input_name	string	Conditional	none
pipeline.trim.bounds.output_path	string	Conditional	none
pipeline.trim.bounds.timeout	duration string	No	10m
pipeline.trim.bounds.render_debug	bool	No	false
pipeline.trim.bounds.render_output_path	string	Conditional	none
pipeline.trim.seriatim.report	bool	No	false
pipeline.scriptorium.binary	string	No	scriptorium
pipeline.scriptorium.config_path	string	No	empty
pipeline.scriptorium.timeout	duration string	No	10m
pipeline.scriptorium.render_debug	bool	No	false
pipeline.scriptorium.artifacts	map	No	empty
pipeline.scriptorium.artifacts.<name>.enabled	bool	No	false
pipeline.scriptorium.artifacts.<name>.depends_on[]	list[string]	No	empty
pipeline.scriptorium.artifacts.<name>.render_debug	bool	No	unset
pipeline.scriptorium.artifacts.<name>.prompt_id	string	Conditional	none
pipeline.scriptorium.artifacts.<name>.profile_id	string	No	empty
pipeline.scriptorium.artifacts.<name>.output_path	string	Conditional	none
pipeline.scriptorium.artifacts.<name>.timeout	duration string	No	empty
pipeline.scriptorium.artifacts.<name>.inputs.<key>.source	string	Conditional	none
pipeline.scriptorium.artifacts.<name>.inputs.<key>.artifact	string	No	empty
pipeline.scriptorium.artifacts.<name>.inputs.<key>.path	string	No	empty
pipeline.scriptorium.artifacts.<name>.inputs.<key>.required	bool	No	false
pipeline.scriptorium.artifacts.<name>.vars.<key>	map value	No	empty
pipeline.analyzer.binary_path	string	No	empty
pipeline.analyzer.timeout	duration string	No	empty
pipeline.analyzer.artifacts.output_dir	string	No	empty
pipeline.analyzer.artifacts.types[]	list[string]	No	empty
pipeline.notification.backend	string	No	empty
pipeline.notification.recipient	string	No	empty
pipeline.notification.timeout	duration string	No	empty

Scriptorium artifact-key and dependency rules:

• artifact keys must match ^[a-z][a-z0-9_]*$.
• enabled artifacts require prompt_id and output_path.
• output_path must be relative, traversal-safe, and under artifacts/.
• configured artifact input sources use narratio.artifact.<name>.
• if input source references narratio.artifact.<name>, artifact <name> must exist and must be listed in depends_on.
• every depends_on entry must be a configured artifact key.
• self-dependency is rejected.
• enabled dependency cycles are rejected.
• any artifact referenced by depends_on or narratio.artifact.<name> source must define output_path (even if not enabled).

Allowed pipeline.scriptorium.artifacts.<name>.inputs.<key>.source values:

• previous_session_artifact
• narratio.transcript.merged
• narratio.transcript.polished
• narratio.transcript.full
• narratio.transcript.trimmed
• narratio.bounds.session
• narratio.artifact.<configured_artifact_key>

8. Full session reference

Path	Type	Required	Default
session.session_id	string	Yes	none
session.campaign	string	Yes	none
session.date	string	No	empty
session.title	string	No	empty
session.inputs.audio_dir	string	Conditional	empty
session.inputs.audio_files[]	list[string]	Conditional	empty
session.inputs.audio_s3.prefix	string	Conditional	none
session.inputs.speakers_file	string	Yes	none
session.inputs.autocorrect_file	string	Yes	none
session.inputs.glossary_file	string	Yes	none

Audio-source rule:

• configure exactly one mode:
  • audio_dir, or
  • audio_files (at least one), or
  • audio_s3.prefix
• audio_s3 cannot be combined with local audio fields.

9. Secrets

Narratio supports filesystem-based secret injection via pipeline.secrets.env_dir.

Behavior:

• env_dir may be absolute or relative.
• relative env_dir resolves from current working directory.
• files with valid env-var names ([A-Za-z_][A-Za-z0-9_]*) are loaded.
• values are loaded from file contents with trailing newline trimming.
• existing process env vars are preserved.
• invalid names and subdirectories are skipped.
• missing/unreadable env_dir fails command execution.

Guidance:

• do not put secret values directly in YAML.
• configure env var names in config and provide values via env/secrets files.

10. Examples

Maintained examples:

• docs/examples/pipeline.minimal.yml
• docs/examples/pipeline.production.yml
• docs/examples/pipeline.full.annotated.yml
• docs/examples/session.template.yml
• docs/examples/session.local-audio.yml
• docs/examples/session.s3-audio.yml

These examples are validated by internal/config tests.