app-config.yaml

app:
  title: Scaffolded Backstage App
  baseUrl: http://localhost:3000
  packages: all
  extensions:
    - api:app/app-language:
        config:
          availableLanguages: ['en', 'de', 'fr', 'it', 'es', 'ja']
          defaultLanguage: 'en'
    - api:home/visits: true
    - app-root-element:home/visit-listener: true
    - page:home:
        config:
          path: /

    # Scorecard tab: entity shows tab if it matches any filter below.
    - entity-content:catalog/entity-content-scorecard:
        config:
          allowedFilters:
            - kind: component # e.g. Component with spec.type: website
              type: website
            - kind: api # e.g. any API entity
            - type: service # e.g. Component or System with spec.type: service

    - home-page-layout:home/dynamic-homepage-layout:
        config:
          customizable: true
          widgetLayout:
            AggregatedCardWithDeprecatedMetricId:
              priority: 410
              breakpoints:
                xl: { w: 4, h: 6 }
                lg: { w: 4, h: 6 }
                md: { w: 4, h: 6 }
                sm: { w: 4, h: 6 }
                xs: { w: 4, h: 6 }
                xxs: { w: 4, h: 6 }

            AggregatedCardWithDefaultAggregation:
              priority: 420
              breakpoints:
                xl: { w: 4, h: 6, x: 4 }
                lg: { w: 4, h: 6, x: 4 }
                md: { w: 4, h: 6, x: 4 }
                sm: { w: 4, h: 6, x: 4 }
                xs: { w: 4, h: 6, x: 4 }
                xxs: { w: 4, h: 6, x: 4 }

            AggregatedCardWithJiraOpenIssues:
              priority: 430
              breakpoints:
                xl: { w: 4, h: 6 }
                lg: { w: 4, h: 6 }
                md: { w: 4, h: 6 }
                sm: { w: 4, h: 6 }
                xs: { w: 4, h: 6 }
                xxs: { w: 4, h: 6 }

            AggregatedCardWithGithubOpenPrs:
              priority: 440
              breakpoints:
                xl: { w: 4, h: 6, x: 4 }
                lg: { w: 4, h: 6, x: 4 }
                md: { w: 4, h: 6, x: 4 }
                sm: { w: 4, h: 6, x: 4 }
                xs: { w: 4, h: 6, x: 4 }
                xxs: { w: 4, h: 6, x: 4 }
            AggregatedCardWithGithubFilecheckLicense:
              priority: 450
              breakpoints:
                xl: { w: 4, h: 6 }
                lg: { w: 4, h: 6 }
                md: { w: 4, h: 6 }
                sm: { w: 4, h: 6 }
                xs: { w: 4, h: 6 }
                xxs: { w: 4, h: 6 }
            AggregatedCardWithGithubFilecheckCodeowners:
              priority: 460
              breakpoints:
                xl: { w: 4, h: 6, x: 8 }
                lg: { w: 4, h: 6, x: 8 }
                md: { w: 4, h: 6, x: 8 }
                sm: { w: 4, h: 6, x: 8 }
                xs: { w: 4, h: 6, x: 8 }
                xxs: { w: 4, h: 6, x: 8 }
            AggregatedCardWithGithubOpenPrsWeighted:
              priority: 470
              breakpoints:
                xl: { w: 4, h: 6, x: 8 }
                lg: { w: 4, h: 6, x: 8 }
                md: { w: 4, h: 6, x: 8 }
                sm: { w: 4, h: 6, x: 8 }
                xs: { w: 4, h: 6, x: 8 }
                xxs: { w: 4, h: 6, x: 8 }

organization:
  name: My Company

backend:
  # Used for enabling authentication, secret is shared by all backend plugins
  # See https://backstage.io/docs/auth/service-to-service-auth for
  # information on the format
  # auth:
  #   keys:
  #     - secret: ${BACKEND_SECRET}
  baseUrl: http://localhost:7007
  listen:
    port: 7007
    # Uncomment the following host directive to bind to specific interfaces
    # host: 127.0.0.1
  csp:
    connect-src: ["'self'", 'http:', 'https:']
    # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
    # Default Helmet Content-Security-Policy values can be removed by setting the key to false
  cors:
    origin: http://localhost:3000
    methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
    credentials: true
  # This is for local development only, it is not recommended to use this in production
  # The production database configuration is stored in app-config.production.yaml
  database:
    client: better-sqlite3
    connection: ':memory:'
  # workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir

  # Uncomment this when MCP Actions are needed
  # actions:
  #   pluginSources:
  #     - 'scorecard'
  # auth:
  #   externalAccess:
  #     - type: static
  #       options:
  #         token: ${MCP_TOKEN}
  #         subject: mcp-clients

integrations:
  github:
    - host: github.com
      # This is a Personal Access Token or PAT from GitHub. You can find out how to generate this token, and more information
      # about setting up the GitHub integration here: https://backstage.io/docs/integrations/github/locations#configuration
      token: ${GITHUB_TOKEN}
    ### Example for how to add your GitHub Enterprise instance using the API:
    # - host: ghe.example.net
    #   apiBaseUrl: https://ghe.example.net/api/v3
    #   token: ${GHE_TOKEN}

proxy:
  '/jira/api':
    target: ${JIRA_URL}
    headers:
      Authorization: ${JIRA_TOKEN}
      Accept: 'application/json'
      Content-Type: 'application/json'
      X-Atlassian-Token: 'nocheck'
      User-Agent: 'MY-UA-STRING'

# Jira plugin and scorecard configuration
jira:
  # Proxy Jira configuration
  # Supported products: `cloud` or `datacenter`
  # product: cloud
  # proxyPath: /jira/api

  # Direct Jira configuration
  # Supported products: `cloud` or `datacenter`
  product: cloud
  baseUrl: ${JIRA_URL}
  token: ${JIRA_TOKEN}

# Reference documentation http://backstage.io/docs/features/techdocs/configuration
# Note: After experimenting with basic setup, use CI/CD to generate docs
# and an external cloud storage when deploying TechDocs for production use-case.
# https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-basic-to-recommended-deployment-approach
techdocs:
  builder: 'local' # Alternatives - 'external'
  generator:
    runIn: 'docker' # Alternatives - 'local'
  publisher:
    type: 'local' # Alternatives - 'googleGcs' or 'awsS3'. Read documentation for using alternatives.

auth:
  # see https://backstage.io/docs/auth/ to learn about auth providers
  providers:
    # See https://backstage.io/docs/auth/guest/provider
    guest:
      userEntityRef: user:development/guest

scaffolder:
  # see https://backstage.io/docs/features/software-templates/configuration for software template options

catalog:
  import:
    entityFilename: catalog-info.yaml
    pullRequestBranchName: backstage-integration
  rules:
    - allow: [Component, System, Group, Resource, Location, Template, API]
  locations:
    - type: file
      target: ../../examples/all-scorecards-location.yaml
      rules:
        - allow: [Component]
    - type: file
      target: ../../examples/orgs/guest.yaml
      rules:
        - allow: [User, Group]
    - type: url
      target: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/components/showcase.yaml

kubernetes:
  # see https://backstage.io/docs/features/kubernetes/configuration for kubernetes configuration options

# see https://backstage.io/docs/permissions/getting-started for more on the permission framework
permission:
  # setting this to `false` will disable permissions
  enabled: true
  rbac:
    pluginsWithPermission:
      - catalog
      - permission
      - scaffolder
      - scorecard
    admin:
      users:
        - name: user:development/guest

# SonarQube configuration (optional - defaults to https://sonarcloud.io, no auth for public projects)
sonarqube:
  baseUrl: https://sonarcloud.io
  apiKey: ${SONARQUBE_TOKEN}
  instances:
    - name: internal
      baseUrl: https://sonarcloud.io
      apiKey: ${SONARQUBE_INTERNAL_KEY}
      authType: Basic # optional, defaults to Basic
    - name: cloud
      baseUrl: https://sonarcloud.io

# Scorecard development configuration
scorecard:
  aggregationKPIs:
    openPrsKpi:
      title: GitHub Open PRs KPI
      type: statusGrouped
      description: This KPI is provide information about GitHub open PRs grouped by status.
      metricId: github.open_prs
    openPrsWeightedKpi:
      title: GitHub Open PRs (weighted health)
      type: weightedStatusScore
      description: Weighted health score for open PRs by threshold status across your entities.
      metricId: github.open_prs
      options:
        statusScores:
          success: 100
          warning: 40
          error: 0
        thresholds:
          rules:
            - key: success
              expression: '>=80'
              color: '#6bb300' # green
            - key: warning
              expression: '30-80'
              color: 'rgb(224, 189, 108)' # light orange
            - key: error
              expression: '<30'
              color: '#be1ec7' # purple
    openIssuesKpi:
      title: Jira Open Issues KPI
      type: statusGrouped
      description: This KPI is provide information about Jira open issues grouped by status.
      metricId: jira.open_issues
    licenseFileExistsKpi:
      title: License File Exists KPI
      type: statusGrouped
      description: This KPI is provide information about whether the license file exists in the repository.
      metricId: filecheck.license
  plugins:
    jira:
      open_issues:
        schedule:
          frequency: { minutes: 5 }
          timeout: { minutes: 10 }
          initialDelay: { seconds: 10 }
    github:
      open_prs:
        schedule:
          frequency: { minutes: 5 }
          timeout: { minutes: 10 }
          initialDelay: { seconds: 10 }
    filecheck:
      files:
        license: 'LICENSE'
        codeowners: 'CODEOWNERS'
      schedule:
        frequency: { minutes: 5 }
        timeout: { minutes: 10 }
        initialDelay: { seconds: 10 }