Documentation Index
Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
Use this file to discover all available pages before exploring further.
Before You Begin
Confirm which plan you’re on before setting up Collate. Your setup path depends on it.Account Types
Your plan determines how ingestion runs and what infrastructure you need.Premium (Production)
Ingestion can run fully within your own infrastructure using the Hybrid Ingestion Runner — a Kubernetes-based agent that never exposes your internal network to Collate. Includes SSO and advanced governance features. Your admin receives credentials from the Collate support team by email. Premium customers receive dedicated support from the Collate team.Free Tier
The recommended path is Collate SaaS ingestion — connectors run inside Collate’s infrastructure and pull metadata from your sources over the public network. No infrastructure required on your end. If your data sources are not reachable from the public internet, you can optionally run a Local Ingestion Agent via Docker on your own laptop. This lets you push metadata from inside your network without any cloud infrastructure.The Local Ingestion Agent is a lightweight self-hosted option for Free Tier users. For production-grade, infrastructure-managed ingestion, upgrade to Premium to use the full Hybrid Runner. Contact free tier Collate support.
What to Prepare
- Your Collate workspace URL and login credentials
- Connection details for at least one data source (host, port, and credentials)
- Premium only: Network access to deploy the Hybrid Runner on Kubernetes 1.28 or later
- Premium only: Your identity provider details for SSO configuration
- Free tier only: Docker installed on your laptop if you plan to use the Local Ingestion Agent
Need credentials? Contact support@getcollate.io before starting setup.
Select Your Setup Path
All plans end at the same place: a connected data source, ingested metadata, and an invited team. Select the column that matches your setup.| Step | Collate SaaS | Hybrid Runner (Premium) | Local Agent (Free Tier) |
|---|---|---|---|
| 1 | Set up SSO (Premium only) | Set up SSO | — |
| 2 | Connect a data source via SaaS | Deploy the Hybrid Runner | Connect a data source via SaaS |
| 3 | Ingest metadata | Connect a data source via Hybrid Runner | Set up Local Ingestion Agent (optional) |
| 4 | Invite users and assign roles | Ingest metadata | Ingest metadata |
| 5 | — | Invite users and assign roles | Invite users and assign roles |