Skip to content

Installation of Sample Component

Sample Component is the example service's internal component for assembling generated documents from smaller content fragments. This page describes how to install it into a development environment.

Sample Component is distributed as a package that can be installed alongside the main application. It requires a local cache directory to be configured before it will start, and it expects the same configuration values used by the main application for connecting to object storage.

Once installed, Sample Component exposes a small local API that the main application calls to request document assembly. No separate deployment step is needed in production, since Sample Component ships as part of the application's standard build artifact.