Connectors

Connectors

Six harbours, and a shipyard for your own.

In short

  • Six bundled providers: local files, Google Drive, Notion, GitHub, Slack and Jira; the table links each one's page.
  • The rules every source shares, such as sync and fixed permissions, reconcile listings and quarantine.
  • For a source of your own, see writing a provider.

A connector provider is a Python package that fyrr's full build discovers through the fyrr.connectors entry point group and runs in isolated worker processes. The bundled providers ship in the fyrr-connectors package and in the fyrr image; each cloud provider needs its optional extra (fyrr-connectors[google-drive], [notion], [github], [slack], [jira]), which the image installs.

Source typeReadsPermission modesPage
local-filesUTF-8 text files under configured directoriesfixedlocal-files
google-driveGoogle Docs, Sheets and Slides exported to textsync, fixedgoogle-drive
notionpages and database rows under root pagesfixednotion
githubissues, pull requests, branch prose; code opt-insync (private repositories), fixedgithub
slackchannel conversation windows and threadssync, fixedslack
jiraJira Cloud issues with per-comment audiencessync, fixedjira

Maturity. local-files runs against real directories. The Google Drive, Notion, GitHub, Slack and Jira providers have been exercised only against synthetic APIs in the SDK's tests and through the real writer on an S3 fixture in CI, not yet against real workspaces.

Every provider page covers setup (credentials and API scopes), the settings and scope keys, what becomes a document, how permissions map to reader tokens (user and group grants), and known limits.

Shared configuration

In a checkout, install a cloud provider's extra with (cd connectors && uv sync --locked --extra slack), replacing slack with its source type. Rerun this after scripts/doctor, which syncs the environment without extras. The full image includes all bundled extras. A source's settings.api_endpoint can select a trusted proxy or test server; leave it at its default for the upstream API. Slack and Jira settings.corporate_domains default to identity.directory.verified_domains; only corporate e-mails in these domains link automatically to canonical users. Set [] to require explicit links. See identity configuration.

For permissions = "sync", set identity.encryption_key and intervals:

[sources.intervals]
permissions = "15m"
members = "15m"

A failed or partial permission/member read keeps the last published rights until the freshness deadline, then hides that source. See freshness and revocation.

Common rules for every source:

Writing a provider describes the SDK contract for your own sources.

Edit this page on GitHub ↗