Maintained Examples
These files are safe, copyable starting points for Narratio configuration and input structure. Replace placeholder identifiers, storage names, integration URLs, and paths for the target environment. Field meanings and defaults belong in the configuration reference.
Pipeline Configuration
-
Minimal pipeline: campaign discovery plus the required WhisperX URL.
-
Production-shaped pipeline: S3 storage, publish, external tools, and configured Scriptorium artifacts.
-
Production-base/testing-overlay bundle: explicit
conf.dimports, one ordinary artifact perartifacts/<key>.yml, one family perartifact-families/<key>.yml, and the fixedoverlays/testing.ymloverlay. Production values live in the base. The bundle demonstrates an input-only artifact dependency, two character families sharing the campaign party, and a testing-only disabled artifact. Inspect it offline with:narratio config validate --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml narratio config show --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --overlay testing narratio config sources --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --overlay testing narratio config artifacts --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --overlay testing narratio config diff default testing --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.ymlThese inspection commands load configuration and resolve explicit credential references, but do not load a session or create runtime state. This bundle is intentionally local-storage and credential-reference free so the walkthrough needs no tools or cloud services.
-
Full annotated pipeline: every implemented pipeline section with explanatory comments.
-
Extraction subset pipeline: a focused Scriptorium artifact consuming only three declared Notarius lanes.
The existing internal/config example test loads and validates each pipeline
with the sample campaign and a compatible local- or S3-audio session.
Campaign And Session Configuration
- Sample campaign, its session template, and its adjacent stable inputs provide a complete campaign directory shape.
- Local-audio session and S3-audio session are concrete session files.
- Session template and the campaign-local equivalent
demonstrate the narrow placeholder syntax consumed by
session init; they are templates, not runtime session files.
Input Fixtures
- Speakers, autocorrect, and glossary show the standalone input shapes.
- The sample campaign references its local speakers, autocorrect, glossary, and canonical party fixture, plus an optional spell-catalog overlay that follows the Notarius v0.7 contract. Narratio derives the players projection from this party source.
- Sample speaker audio is a text placeholder that reserves the expected filename and directory shape. Replace it with a real FLAC file before running transcription.
The examples contain environment-variable names but no credential values. Set
OBJECT_STORAGE_KEY_ID, OBJECT_STORAGE_KEY, AUDITA_LLM_API_KEY, and
NOTARIUS_LLM_API_KEY to nonempty synthetic or real values before loading the
examples that reference them. They use fictional campaign content and reserved
example domains. The Audita and Notarius names are example references, not
implicit aliases: external backend/profile configurations must use those exact
names, or the Narratio credential lists must be changed to match. See the
Audita v2 migration guide
for maintained downstream configuration examples.
For a deployed bundle, keep credential files out of source control in a
secrets/ directory beside the root pipeline.yml, one file per referenced
environment-variable name, or select another directory with --secrets-dir.
Static S3 credentials are optional: omit both S3 credential references to use
the AWS SDK discovery chain.