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
syncandfixedpermissions, 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 type | Reads | Permission modes | Page |
|---|---|---|---|
local-files | UTF-8 text files under configured directories | fixed | local-files |
google-drive | Google Docs, Sheets and Slides exported to text | sync, fixed | google-drive |
notion | pages and database rows under root pages | fixed | notion |
github | issues, pull requests, branch prose; code opt-in | sync (private repositories), fixed | github |
slack | channel conversation windows and threads | sync, fixed | slack |
jira | Jira Cloud issues with per-comment audiences | sync, fixed | jira |
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:
permissions = "sync"publishes the source's own access rights and needsintervals.permissions;intervals.membersis optional and, when set, its reads count toward freshness too.permissions = "fixed"grants the configuredreadersto every document and makes no permission or member reads.- Every source runs a full-ID listing on
intervals.reconcile(1 day); only a listing the provider marks complete may delete documents. - Documents over
document_max_bytes, invalid text or a malformed representation are quarantined: the last good revision stays visible andwriter statuscounts the quarantine. - A provider failure, a partial permission read or a transport error fails that sync pass; it never produces an empty permission set.
- Settings secrets are
{ env = "VAR" }references, validated by the provider's schema (fyrr config check,fyrr config schema). fyrr writer sync --dry-runruns the provider and validates its output without writing anything.
Writing a provider describes the SDK contract for your own sources.