@philips-software/backstage-plugin-search-confluence-backend

Confluence Search Backend Module Plugin

A plugin that provides Confluence-specific functionality that can be used for search in your Backstage App.

It is used in combination with its frontend counterpart

Installation

Add the plugin to your backend app:

yarn add @philips-software/backstage-plugin-search-confluence-backend

Configuration

Update app-config.yml

confluence:
  schedule:
    frequency:
    # example: frequency: { minutes: 15 }
    timeout:
    # example: timeout: { minutes: 15 }
    initialDelay:
  # example initialDelay: { seconds: 3 }
  wikiUrl: https://org-name.atlassian.net/wiki
  auth:
    token: ${Your PAT Token}
  category:
    # provide the list of categories you want to use to find spaces that will be indexed
    # example
    # - space1
    # - space2
  retries:
    attempts: 3 # optional, defaults to 3
    delay: 5000 # optional, defaults to 5000

Note: if the Confluence API rate limit is exceeded, the plugin will automatically retry with increasing wait times for a specified number of retry attempts. This can increase the duration of the task. Take this into account when setting the schedule.frequency and schedule.timeout values.

Backend Configuration (Follows new backend)

Add the collator to your backend instance, along with the search plugin itself

// packages/backend/src/index.ts
import { createBackend } from '@backstage/backend-defaults';
import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
import searchConfluenceCollatorModule from '@philips-software/backstage-plugin-search-confluence-backend'; // confluence backend collator

const backend = createBackend();
backend.add(searchPlugin());
backend.add(searchConfluenceCollatorModule());
backend.start();