App config Spotify Backstage

Spotify's Backstage App configuration for all plugins

Type object
File match app-config.yml app-config.yaml app-config.local.yaml app-config.local.yml app-config.production.yaml app-config.production.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/app-config-spotify-backstage/latest.json
Source https://www.schemastore.org/app-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

This is the schema describing the structure of the app-config.yaml configuration file.

Properties

app object

Generic frontend configuration.

11 nested properties
baseUrl string

The public absolute root URL that the frontend.

title string

The title of the app, as shown in the Backstage web interface.

datadogRum object

Datadog RUM events configuration

4 nested properties
env string

Environment for Datadog RUM events

clientToken string

clientToken for Datadog RUM events

applicationId string

applicationId for Datadog RUM events

site string

site for Datadog RUM events

listen object

Listening configuration for local development

2 nested properties
host string

The host that the frontend should be bound to. Only used for local development.

port number

The port that the frontend should be bound to. Only used for local development.

https object

Only used for local development. The https object is passed to webpack in order to enable using https on localhost.

1 nested properties
certificate object

Parent object containing certificate and the private key

2 nested properties
key string

Https Certificate private key. Use $file to load in a file

cert string

Https Certificate. Use $file to load in a file

support object

Information about support of this Backstage instance and how to contact the integrator team.

2 nested properties
url string

The primary support url.

items object[]

A list of categorized support item groupings.

extensions object | string[]
analytics object
3 nested properties
ga object
7 nested properties
trackingId string

Google Analytics tracking ID, e.g. UA-000000-0

scriptSrc string

URL to Google Analytics analytics.js script Defaults to fetching from GA source (eg. https://www.google-analytics.com/analytics.js)

identity string

Controls how the identityApi is used when sending data to GA:

  • disabled: (Default) Explicitly prevents a user's identity from being used when capturing events in GA.
  • optional: Pageviews and hits are forwarded to GA as they happen and only include user identity metadata once known. Guarantees that hits are captured for all sessions, even if no sign in occurs, but may result in dropped hits in User ID views.
  • required: All pageviews and hits are deferred until an identity is known. Guarantees that all data sent to GA correlates to a user identity, but prevents GA from receiving events for sessions in which a user does not sign in. An identityApi instance must be passed during instantiation when set to this value.
Values: "disabled" "optional" "required"
virtualSearchPageView object

Controls whether to send virtual pageviews on search events. Can be used to enable Site Search in GA.

debug boolean

Whether or not to log analytics debug statements to the console. Defaults to false.

testMode boolean

Prevents events from actually being sent when set to true. Defaults to false.

customDimensionsMetrics object[]

Configuration informing how Analytics Context and Event Attributes metadata will be captured in Google Analytics.

ga4 object
7 nested properties
measurementId string

Google Analytics measurement ID, e.g. G-000000-0

identity string

Controls how the identityApi is used when sending data to GA:

  • disabled: (Default) Explicitly prevents a user's identity from being used when capturing events in GA.
  • optional: Pageviews and hits are forwarded to GA as they happen and only include user identity metadata once known. Guarantees that hits are captured for all sessions, even if no sign in occurs, but may result in dropped hits in User ID views.
  • required: All pageviews and hits are deferred until an identity is known. Guarantees that all data sent to GA correlates to a user identity, but prevents GA from receiving events for sessions in which a user does not sign in. An identityApi instance must be passed during instantiation when set to this value.
Values: "disabled" "optional" "required"
debug boolean

Whether to log analytics debug statements to the console. Defaults to false.

testMode boolean

Prevents events from actually being sent when set to true. Defaults to false.

contentGrouping string

Content grouping definition Feature available in Google Analytics 4 More information https://support.google.com/analytics/answer/11523339?hl=en Data can be grouped by pluginId, routeRef Takes 24 hours before metrics shows up in GA dashboard Specifies the dimension to be used for content grouping Can be one of pluginId, extension or routeRef

Values: "extension" "pluginId" "routeRef"
allowedContexts string[] | array

Configuration informing how Analytics Context and Event Attributes metadata will be captured in Google Analytics. Contexts that will be sent as parameters in the event. context-name will be prefixed by c_, for example, pluginId will be c_pluginId in the event.

allowedAttributes string[] | array

Attributes that will be sent as parameters in the event attribute-name will be prefixed by a_, for example , testAttribute will be c_testAttribute in the event.

newRelic object
6 nested properties
endpoint string

Data ingestion endpoint to use, either bam.eu01.nr-data.net (EU) or bam.nr-data.net (US)

Values: "bam.eu01.nr-data.net" "bam.nr-data.net"
accountId string

New Relic Account ID, e.g. 1234567

applicationId string

New Relic Application ID, e.g. 987654321

licenseKey string

New Relic License Key, e.g. NRJS-12a3456bc78de9123f4

distributedTracingEnabled boolean

Whether to enabled distributed tracing, defaults to false

cookiesEnabled boolean

Whether to enabled tracing of cookies, defaults to false

packageName string

The name of the app package (in most Backstage repositories, this is the "name" field in packages/app/package.json) that content should be served from. The same app package should be added as a dependency to the backend package in order for it to be accessible at runtime.

In a typical setup with a single app package, this will default to 'app'.

disableConfigInjection boolean

Disables the configuration injection. This can be useful if you're running in an environment with a read-only filesystem, or for some other reason don't want configuration to be injected.

Note that this will cause the configuration used when building the app bundle to be used, unless a separate configuration loading strategy is set up.

This also disables configuration injection though APP_CONFIG_ environment variables.

disableStaticFallbackCache boolean

By default the app backend plugin will cache previously deployed static assets in the database. If you disable this, it is recommended to set a staticFallbackHandler instead.

allure object
1 nested properties
baseUrl string
firehydrant object
1 nested properties
baseUrl string
lighthouse object
1 nested properties
baseUrl string
nomad object
2 nested properties
addr string

The address of the Nomad API. See: https://developer.hashicorp.com/nomad/api-docs#addressing-and-ports

token string

The token to call the Nomad API with. See: https://developer.hashicorp.com/nomad/api-docs#authentication

auth object

Configuration that provides information on available configured authentication providers.

5 nested properties
providers Record<string, object>

The available auth-provider options and attributes

13 nested properties
google Record<string, object>
github Record<string, object>
saml object
12 nested properties
entryPoint string
logoutUrl string
issuer string
cert string
audience string
privateKey string
authnContext string[]
identifierFormat string
decryptionPvk string
signatureAlgorithm string
Values: "sha256" "sha512"
digestAlgorithm string
acceptedClockSkewMs number
okta Record<string, object>
oauth2 Record<string, object>
oidc Record<string, object>
auth0 Record<string, object>
microsoft Record<string, object>
onelogin Record<string, object>
awsalb object
2 nested properties
iss string
region string
cfaccess object
1 nested properties
teamName string
gcpIap Record<string, object>

Configuration for the Google Cloud Platform Identity-Aware Proxy (IAP) auth provider.

gitlab Record<string, object>
environment string

The 'environment' attribute added as an optional parameter to have configurable environment value for auth.providers. default value: 'development' optional values: 'development' | 'production'

session object
1 nested properties
secret string

The secret attribute of session object.

identityTokenAlgorithm string

JWS "alg" (Algorithm) Header Parameter value. Defaults to ES256. Must match one of the algorithms defined for IdentityClient. When setting a different algorithm, check if the key field of the signing_keys table can fit the length of the generated keys. If not, add a knex migration file in the migrations folder. More info on supported algorithms: https://github.com/panva/jose

keyStore object

To control how to store JWK data in auth-backend

2 nested properties
provider string
Values: "database" "firestore" "memory"
firestore object
7 nested properties
host string

The host to connect to

port number

The port to connect to

ssl boolean

Whether to use SSL when connecting.

projectId string

The Google Cloud Project ID

keyFilename string

Local file containing the Service Account credentials. You can omit this value to automatically read from GOOGLE_APPLICATION_CREDENTIALS env which is useful for local development.

path string

The path to use for the collection. Defaults to 'sessions'

timeout number

Timeout used for database operations. Defaults to 10000ms

backend object

Generic backend configuration.

9 nested properties
auth object

Backend configuration for when request authentication is enabled

1 nested properties
keys object[]

Keys shared by all backends for signing and validating backend tokens.

baseUrl string

The public absolute root URL that the backend is reachable at, from the browser's perspective.

listen object | string

Address that the backend should listen to.

https object | boolean

HTTPS configuration for the backend. If omitted the backend will serve HTTP.

Setting this to true will cause self-signed certificates to be generated, which can be useful for local development or other non-production scenarios.

database object

Database connection configuration, select base database type using the client field

8 nested properties
client string

Default database client to use

Values: "better-sqlite3" "pg" "sqlite3"
connection object | string

Base database connection string, or object with individual connection properties

prefix string

Database name prefix override

ensureExists boolean

Whether to ensure the given database exists by creating it if it does not. Defaults to true if unspecified.

pluginDivisionMode string

How plugins databases are managed/divided in the provided database instance.

database -> Plugins are each given their own database to manage their schemas/tables.

schema -> Plugins will be given their own schema (in the specified/default database) to manage their tables.

NOTE: Currently only supported by the pg client.

Default: "database"
Values: "database" "schema"
role string

Configures the ownership of newly created schemas in pg databases.

knexConfig object

Arbitrary config object to pass to knex when initializing (https://knexjs.org/#Installation-client). Most notable is the debug and asyncStackTraces booleans

plugin Record<string, object>

Plugin specific database configuration and client override

cache object | object | object

Cache connection configuration, select cache type using the store field

cors object
8 nested properties
origin string[] | string
methods string[] | string
allowedHeaders string[] | string
exposedHeaders string[] | string
credentials boolean
maxAge number
preflightContinue boolean
optionsSuccessStatus number
reading object

Configuration related to URL reading, used for example for reading catalog info files, scaffolder templates, and techdocs content.

1 nested properties
allow object[]

A list of targets to allow outgoing requests to. Users will be able to make requests on behalf of the backend to the targets that are allowed by this list.

csp Record<string, string[] | boolean>

Content Security Policy options.

The keys are the plain policy ID, e.g. "upgrade-insecure-requests". The values are on the format that the helmet library expects them, as an array of strings. There is also the special value false, which means to remove the default value that Backstage puts in place for that policy.

discovery object

Discovery options.

1 nested properties
endpoints object[]

Endpoints

A list of target baseUrls and the associated plugins.

organization object

Configuration that provides information about the organization that the app is for.

1 nested properties
name string

The name of the organization that the app belongs to.

homepage object

This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin

1 nested properties
clocks object[]
enableExperimentalRedirectFlow boolean

Enable redirect authentication flow type, instead of a popup for authentication.

integrations object

Configuration for integrations towards various external repository provider systems

10 nested properties
azure object[]

Integration configuration for Azure

bitbucket object[]

Integration configuration for Bitbucket

bitbucketCloud object[]

Integration configuration for Bitbucket Cloud

bitbucketServer object[]

Integration configuration for Bitbucket Server

gerrit object[]

Integration configuration for Gerrit

github object[]

Integration configuration for GitHub

gitlab object[]

Integration configuration for GitLab

googleGcs object

Integration configuration for Google Cloud Storage

2 nested properties
clientEmail string

Service account email used to authenticate requests.

privateKey string

Service account private key used to authenticate requests.

awsS3 object[]

Integration configuration for AWS S3 Service

gitea object[]

Integration configuration for Gitea

aws object

Configuration for access to AWS accounts

3 nested properties
accountDefaults object

Defaults for retrieving AWS account credentials

4 nested properties
roleName string

The IAM role to assume to retrieve temporary AWS credentials

partition string

The AWS partition of the IAM role, e.g. "aws", "aws-cn"

region string

The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. "ap-northeast-1"

externalId string

The unique identifier needed to assume the role to retrieve temporary AWS credentials

mainAccount object

Main account to use for retrieving AWS account credentials

4 nested properties
accessKeyId string

The access key ID for a set of static AWS credentials

secretAccessKey string

The secret access key for a set of static AWS credentials

profile string

The configuration profile from a credentials file at ~/.aws/credentials and a configuration file at ~/.aws/config.

region string

The STS regional endpoint to use for the main account, e.g. "ap-northeast-1"

accounts object[]

Configuration for retrieving AWS accounts credentials

airbrake object

Configuration options for the Airbrake plugin

1 nested properties
apiKey string

The API Key to authenticate requests. More details on how to get this here: https://airbrake.io/docs/api/#authentication

apacheAirflow object

Configurations for the Apache Airflow plugin

1 nested properties
baseUrl string

The base url of the Apache Airflow installation.

azureDevOps object

Configuration options for the azure-devops-backend plugin

3 nested properties
host string

The hostname of the given Azure instance

token string

Token used to authenticate requests.

organization string

The organization of the given Azure instance

catalog object

Configuration options for the catalog plugin.

8 nested properties
rules object[]

Rules to apply to all catalog entities, from any location.

An undefined list of matchers means match all, an empty list of matchers means match none.

This is commonly used to put in what amounts to an allowlist of kinds that regular users of Backstage are permitted to register locations for. This can be used to stop them from registering yaml files describing for example a Group entity called "admin" that they make themselves members of, or similar.

readonly boolean

Readonly defines whether the catalog allows writes after startup.

Setting 'readonly=false' allows users to register their own components. This is the default value.

Setting 'readonly=true' configures catalog to only allow reads. This can be used in combination with static locations to only serve operator provided locations. Effectively this removes the ability to register new components to a running backstage instance.

locations object[]

A set of static locations that the catalog shall always keep itself up-to-date with. This is commonly used for large, permanent integrations that are defined by the Backstage operators at an organization, rather than individual things that users register dynamically.

These have (optional) rules of their own. These override what the global rules above specify. This way, you can prevent everybody from register e.g. User and Group entities, except for one or a few static locations that have those two kinds explicitly allowed.

For example:

rules:
  - allow: [Component, API, Template, Location]
locations:
  - type: url
    target: <https://github.com/org/repo/blob/master/users.yaml>
    rules:
      - allow: [User, Group]
  - type: url
    target: <https://github.com/org/repo/blob/master/systems.yaml>
    rules:
      - allow: [System]
orphanStrategy string

The strategy to use for entities that are orphaned, i.e. no longer have any other entities or providers referencing them. The default value is "keep".

Values: "delete" "keep"
processingInterval

The interval at which the catalog should process its entities.

processors object

List of processor-specific options and attributes

4 nested properties
awsOrganization object

AwsOrganizationCloudAccountProcessor configuration

1 nested properties
provider object
githubMultiOrg object

GithubMultiOrgReaderProcessor configuration

1 nested properties
orgs object[]

The configuration parameters for each GitHub org to process.

ldapOrg object

LdapOrgReaderProcessor configuration

1 nested properties
providers object[]

The configuration parameters for each single LDAP provider.

microsoftGraphOrg object

MicrosoftGraphOrgReaderProcessor configuration

1 nested properties
providers object[]

The configuration parameters for each single Microsoft Graph provider.

providers object

List of provider-specific options and attributes

11 nested properties
awsS3 object | object

AwsS3EntityProvider configuration

Uses "default" as default id for the single config variant.

azureDevOps Record<string, object>

AzureDevopsEntityProvider configuration

bitbucketCloud object | object

BitbucketCloudEntityProvider configuration

Uses "default" as default id for the single config variant.

bitbucketServer object | object

BitbucketServerEntityProvider configuration

Uses "default" as default id for the single config variant.

gcp object

GCPCatalogModuleConfig configuration

1 nested properties
gke object

Config for GKE clusters

gerrit Record<string, object>

GerritEntityProvider configuration

Maps provider id with configuration.

github object | object

GithubEntityProvider configuration

Uses "default" as default id for the single config variant.

githubOrg object | object[]

Configuration for catalogModuleGithubOrgEntityProvider

gitlab Record<string, object>

GitlabDiscoveryEntityProvider configuration

microsoftGraphOrg object | object

MicrosoftGraphOrgEntityProvider configuration.

puppetdb object | object

PuppetDB Entity Provider configuration. Uses "default" as default ID for the single config variant.

import object

List of import flow specific options and attributes

2 nested properties
entityFilename string

Catalog entity descriptor filename, defaults to "catalog-info.yaml"

pullRequestBranchName string

A branch name used in pull request when registering existing component via UI Valid git refname required, see: https://git-scm.com/docs/git-check-ref-format Defaults to "backstage-integration"

ldap object

LdapOrgEntityProvider / LdapOrgReaderProcessor configuration

1 nested properties
providers object[]

The configuration parameters for each single LDAP provider.

codescene object

Configuration options for the CodeScene plugin

1 nested properties
baseUrl string

The base url of the CodeScene installation.

costInsights object
6 nested properties
engineerCost number
engineerThreshold number
baseCurrency object
2 nested properties
locale string
options object
10 nested properties
localeMatcher string
style string
currency string
currencySign string
useGrouping boolean
minimumIntegerDigits number
minimumFractionDigits number
maximumFractionDigits number
minimumSignificantDigits number
maximumSignificantDigits number
products Record<string, object>
metrics Record<string, object>
currencies Record<string, object>
devTools object

DevTools configuration.

2 nested properties
externalDependencies object

External dependency configuration.

1 nested properties
endpoints object[]

The list of endpoints to check.

info object

Info configuration

1 nested properties
packagePrefixes string[]

A list of package prefixes that DevTools will use for filtering all available dependencies (default is ["@backstage"])

dynatrace object

dynatrace config

1 nested properties
baseUrl string

base url for links

events object
2 nested properties
http object
1 nested properties
topics string[]

Topics for which a route has to be registered at which we can receive events via HTTP POST requests (i.e. received from webhooks).

modules object
3 nested properties
awsSqs object

events-backend-module-aws-sqs plugin configuration.

1 nested properties
awsSqsConsumingEventPublisher object

Configuration for AwsSqsConsumingEventPublisher.

github object

events-backend-module-github plugin configuration.

1 nested properties
webhookSecret string

Secret token for webhook requests used to verify signatures.

See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks for more details.

gitlab object

events-backend-module-gitlab plugin configuration.

1 nested properties
webhookSecret string

Secret token for webhook requests used to verify tokens.

See https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#validate-payloads-by-using-a-secret-token for more details.

explore object
1 nested properties
tools object[]

Tools to be used for the explore tool provider.

fossa object
2 nested properties
organizationId string

The organization id in fossa.

externalLinkBaseUrl string

The base url to use for external links (from Backstage to Fossa).

gocd object

Configurations for the GoCD plugin

1 nested properties
baseUrl string

The base url of the GoCD installation.

ilert object
2 nested properties
baseUrl string

Domain used by users to access iLert web UI. Example: https://my-app.ilert.com/

proxyPath string

Path to use for requests via the proxy, defaults to /ilert/api

jenkins object
4 nested properties
baseUrl string

Default instance baseUrl, can be specified on a named instance called "default"

username string

Default instance username, can be specified on a named instance called "default"

apiKey string

Default Instance apiKey, can be specified on a named instance called "default"

instances object[]
kafka object
2 nested properties
clusters object[]
clientId string

Client ID used to Backstage uses to identify when connecting to the Kafka cluster.

kubernetes object
5 nested properties
objectTypes string[]
serviceLocatorMethod object
1 nested properties
type string
Values: "multiTenant" "singleTenant" "catalogRelation"
clusterLocatorMethods object | object | object | object[]
customResources object[]
apiVersionOverrides Record<string, string>

(Optional) API Version Overrides If set, the specified api version will be used to make requests for the corresponding object. If running a legacy Kubernetes version, you may use this to override the default api versions that are not supported in your cluster.

13 nested properties
pods string
services string
configmaps string
deployments string
limitranges string
replicasets string
horizontalpodautoscalers string
jobs string
cronjobs string
ingresses string
customresources string
statefulsets string
daemonsets string
linguist object

Configuration options for the linguist plugin

7 nested properties
schedule
batchSize number
Default: 20
useSourceLocation boolean
Default: false
age

Refresh generated language breakdown

kind string[]
Default: "['API', 'Component', 'Template']"
linguistJsOptions

linguist-js options

tagsProcessor object

Options for the tags processor

4 nested properties
bytesThreshold number

Determines how many bytes of a language should be in a repo for it to be added as an entity tag. Defaults to 0.

languageTypes string[]

The types of linguist languages that should be processed. Can be any of "programming", "data", "markup", "prose". Defaults to ["programming"].

languageMap Record<string, string>

A custom mapping of linguist languages to how they should be rendered as entity tags. If a language is mapped to '' it will not be included as a tag.

cacheTTL

How long to cache entity languages for in memory. Used to avoid constant db hits during processing. Defaults to 30 minutes.

opencost object

Configurations for the OpenCost plugin

1 nested properties
baseUrl string

The base URL for the OpenCost API

periskop object

Configuration options for the periskop plugin

1 nested properties
instances object[]

Integration configuration for the periskop servers

pagerDuty object

Configuration for the PagerDuty plugin

1 nested properties
eventsBaseUrl string

Optional Events Base URL to override the default.

permission object

Configuration options for Backstage permissions and authorization

1 nested properties
enabled boolean

Whether authorization is enabled in Backstage. Defaults to false, which means authorization requests will be automatically allowed without invoking the authorization policy.

playlist object
1 nested properties
title string

(Optional) The title that will shown in the UI; Defaults toPlaylist if undefined.

proxy object
3 nested properties
skipInvalidProxies boolean

Rather than failing to start up, the proxy backend will instead just warn on invalid endpoints.

reviveConsumedRequestBodies boolean

Revive request bodies that have already been consumed by earlier middleware.

endpoints Record<string, object | string>

A list of forwarding-proxies. Each key is a route to match, below the prefix that the proxy plugin is mounted on. It must start with a '/'.

rollbar object

Configuration options for the rollbar plugin

2 nested properties
organization string

The Rollbar organization name. This can be omitted by using the rollbar.com/project-slug annotation.

accountToken string

The authentication token for accessing the Rollbar API

scaffolder object

Configuration options for the scaffolder plugin

3 nested properties
defaultAuthor object

The commit author info used when new components are created.

2 nested properties
name string
email string
defaultCommitMessage string

The commit message used when new components are created.

concurrentTasksLimit number

Sets the number of concurrent tasks that can be run at any given time on the TaskWorker.

Defaults to 10.

Set to 0 to disable task workers altogether.

confluence object

Configuration options for the Confluence to Markdown action

2 nested properties
baseUrl string

The base URL for accessing the Confluence API

auth object
5 nested properties
type string

Authentication method - basic, bearer, username/password

Values: "basic" "bearer" "userpass"
token string

Token used for the basic and bearer auth methods

email string

Email used with the token for the basic auth method

username string

Username used with the Username/Password auth method

password string

Password used with the Username/Password auth method

sentry object

Configuration options for the sentry plugin

1 nested properties
organization string

The 'organization' attribute

sonarqube object

Optional configurations for the SonarQube plugin

4 nested properties
baseUrl string

The base url of the sonarqube installation. Defaults to https://sonarcloud.io.

externalBaseUrl string

The external url of the sonarqube installation. Use this if you want to use a different url for the frontend than the backend.

apiKey string

The api key to access the sonarqube instance under baseUrl.

instances object[]

The optional sonarqube instances.

splunkOnCall object

Splunk On Call Plugin specific configs

1 nested properties
eventsRestEndpoint string
stackoverflow object

Configuration options for the stack overflow plugin

4 nested properties
baseUrl string

The base url of the Stack Overflow API used for the plugin

apiKey string

The API key to authenticate to Stack Overflow API

teamName string

The name of the team for a Stack Overflow for Teams account

apiAccessToken string

The API Access Token to authenticate to Stack Overflow API

stackstorm object
1 nested properties
webUrl string

StackStorm Web UI url Used in links to StackStorm web UI

techdocs object

Configuration options for the techdocs plugin

6 nested properties
builder string

Documentation building process depends on the builder attr

Values: "external" "local"
legacyUseCaseSensitiveTripletPaths boolean

Allows fallback to case-sensitive triplets in case of migration issues.

sanitizer object
1 nested properties
allowedIframeHosts string[]

Allows iframe tag only for listed hosts Example: allowedIframeHosts: ["example.com"] this will allow all iframes with the host example.com in the src attribute

generator object

Techdocs generator information

4 nested properties
runIn string

Where to run the techdocs (mkdocs) generator

Values: "docker" "local"
dockerImage string

Override the default techdocs docker image

pullImage boolean

Pull the latest docker image

mkdocs object

Override behavior specific to mkdocs.

2 nested properties
legacyCopyReadmeMdToIndexMd boolean

(Optional and not recommended) Configures the techdocs generator to attempt to ensure an index.md exists falling back to using /README.md or README.md in case a default /index.md is not provided. Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior will be broken in these scenarios.

defaultPlugins string[]

List of mkdocs plugins which should be added as default to all mkdocs.yml files.

publisher object | object | object | object | object

Techdocs publisher information

cache object
2 nested properties
ttl number

The cache time-to-live for TechDocs sites (in milliseconds). Set this to a non-zero value to cache TechDocs sites and assets as they are read from storage.

Note: you must also configure backend.cache appropriately as well, and to pass a PluginCacheManager instance to TechDocs Backend's createRouter method in your backend.

readTimeout number

The time (in milliseconds) that the TechDocs backend will wait for a cache service to respond before continuing on as though the cached object was not found (e.g. when the cache sercice is unavailable).

Defaults to 1000 milliseconds.

vault object
5 nested properties
baseUrl string

The baseUrl for your Vault instance.

publicUrl string

The publicUrl for your Vault instance (Optional).

token string

The token used by Backstage to access Vault.

secretEngine string

The secret engine name where in vault. Defaults to secrets.

kvVersion number

The version of the K/V API. Defaults to 2.

Values: 1 2
scorecards object

Extra configuration for score card plugin

2 nested properties
jsonDataUrl string

The public absolute root URL with json file defining the score card entries.

wikiLinkTemplate string

The template for the link to the wiki, e.g. "https://TBD/XXX/_wiki/wikis/XXX.wiki/{id}"

travisci object

Configuration options for the travisci plugin

1 nested properties
baseUrl string

The 'baseUrl' attribute. It should point to the address of the travis portal. If not provided, frontend plugin will use 'https://travis-ci.com/'