Groundeddocs

What is Grounded

An open-source, multi-tenant platform for knowledge bases and agents that answer only from your own sources, with citations.

Grounded is an open-source (MIT) platform for retrieval-augmented generation (RAG) and agents, built for organisations. One install serves many teams. Each team turns uploaded files and crawled websites into knowledge bases, then publishes agents that answer questions only from those sources. Every answer cites the passages it used.

People use the agents in the web app, in a widget embedded on a website, or from any OpenAI-compatible client. Platform admins decide what happens: which models may see which data, who may use an agent, how long data is kept, and who can read what.

A Help Desk Assistant answer to "I forgot my NetID password. How do I reset it?": numbered steps with citation chips marked with check marks, one sentence marked Uncited, the summary "5 of 6 claims supported · 1 uncited", and the two sources opened below.

What it does

How it is built

Grounded is a single Go binary with the React web app embedded in it. The same binary runs the API, the background worker, database migrations and a few operator commands. It stores everything in PostgreSQL with pgvector, keeps rebuildable state (rate limits, crawl pacing) in Valkey or Redis, keeps files in S3-compatible storage, and talks to models through any OpenAI-compatible gateway. Sign-in uses OIDC.

It runs on Kubernetes. The repository ships a generic Kustomize base, optional components and example overlays. See Self-hosting.

Who these docs are for

You areStart with
Someone chatting with an agentChatting with an agent
A team editor building sources, knowledge bases and agentsData sources
A team owner or adminMembers and roles
A platform admin or auditorThe admin portal
An operator installing and running GroundedRequirements
A developer calling the APIAPI overview

If you only want to see it working, try it locally with Docker. No model keys are needed.

Project status

Grounded is pre-1.0, and it currently has one maintainer. The latest release is v0.2.1. What to expect:

  • Meant to stay stable through 0.x: the OpenAI-compatible chat endpoint, the widget embed, the environment variables, and the Kubernetes resource names that overlays patch. If one of these has to change, the release notes say how to adapt.
  • May change between minor releases: the native REST API, metric names, the UI and component defaults.
  • Upgrades are forward-only and happen without downtime. Downgrading means restoring a backup.

Capacity figures in the project come from load tests on a single-node test cluster, not from long production use. Test your own install before relying on it. See the known limitations.

These docs and the repository

These pages are the user and operator guide. The Grounded repository's own docs/ folder stays the engineering record: the design, architecture decision records and the original runbooks.

On this page