OutOfTheBoxDeploymentOptions

Home > @backstage/plugin-techdocs-backend > OutOfTheBoxDeploymentOptions

Required dependencies for running TechDocs in the "out-of-the-box" deployment configuration (prepare/generate/publish all in the Backend).

Signature:

export type OutOfTheBoxDeploymentOptions = {
    preparers: PreparerBuilder;
    generators: GeneratorBuilder;
    publisher: PublisherBase;
    logger: winston.Logger;
    discovery: PluginEndpointDiscovery;
    database?: Knex;
    config: Config;
    cache: PluginCacheManager;
    docsBuildStrategy?: DocsBuildStrategy;
    buildLogTransport?: winston.transport;
    catalogClient?: CatalogClient;
    httpAuth?: HttpAuthService;
    auth?: AuthService;
};

References: PreparerBuilder, GeneratorBuilder, PublisherBase, PluginEndpointDiscovery, Config, PluginCacheManager, DocsBuildStrategy, CatalogClient, HttpAuthService, AuthService