What It Does
- discovers pages via a space, a list of page IDs, a label, a CQL query, or a folder
- converts each page to Markdown for indexing
- optionally follows descendant pages when discovering by page IDs
- runs ingestion on configurable schedules
Discovery Modes
Exactly one discovery mode must be set per source:Authentication
Set one of the following. Username/password, API token, and bearer token auth are mutually exclusive withoauth2; cookies is the exception and may be combined with oauth2.
- Cloud basic (
username+api_token): email address and API token. Recommended for Confluence Cloud. Generate a token at id.atlassian.com/manage-profile/security/api-tokens. - Server basic (
username+password): account username and password. For Confluence Server/Data Center. - Bearer token (
api_tokenonly): a Personal Access Token. For Server/Data Center; requirescloud: false. - OAuth2 (
oauth2): an OAuth2 credentials dict (client_id,token) passed directly to the underlying reader. - Cookies (
cookies): a session cookies dict, e.g. produced byatlassian.utils.parse_cookie_file(). Can be combined withoauth2.
Required Environment Variables
Set these in.env.rag:
CONFLUENCE1_BASE_URL: Confluence base URL (example:https://yoursite.atlassian.net/wiki)CONFLUENCE1_USERNAME: Confluence username or email — required for basic authCONFLUENCE1_API_TOKEN: API token (Cloud basic auth) or Personal Access Token (Bearer auth) — mutually exclusive withCONFLUENCE1_PASSWORDCONFLUENCE1_PASSWORD: Confluence password (Server basic auth) — mutually exclusive withCONFLUENCE1_API_TOKENCONFLUENCE1_SPACE_KEY: space key to ingest — set when using the space discovery modeCONFLUENCE1_PAGE_IDS: comma-separated page IDs — set when using the page IDs discovery modeCONFLUENCE1_PAGE_LABEL: page label — set when using the label discovery modeCONFLUENCE1_CQL: CQL query — set when using the CQL discovery modeCONFLUENCE1_FOLDER_ID: folder ID — set when using the folder discovery modeCONFLUENCE1_SCHEDULES: ingestion interval in seconds (default is3600)
config.yaml Example
Configuration Reference
Multiple Confluence Sources
Add moresources entries (confluence2, confluence3, etc) with separate env vars per source.