> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r5d.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# r5d.chat

> A white-label, self-hosted AI agent workspace where every user gets an isolated, on-demand Kubernetes pod with a persistent home directory.

r5d.chat is a self-hosted chat application for AI agents that actually do work.
Each user chats with an OpenAI-compatible model while the agent operates inside a
dedicated Kubernetes pod: it reads and writes files, runs shell commands,
searches documents, and installs tools. The pod scales to zero when idle and
keeps its home directory on a retained volume, so the next conversation resumes
with the same files.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Install the chart, claim the administrator account, and run a first agent
    task.
  </Card>

  <Card title="Core concepts" icon="diagram-project" href="/concepts">
    Control plane, workspaces, providers, and the idle lifecycle.
  </Card>

  <Card title="Install with Helm" icon="cube" href="/install/helm">
    Install from the Helm repository or directly from the OCI registry.
  </Card>

  <Card title="Configuration" icon="sliders" href="/configure/environment">
    Environment variables, model providers, SSO, branding, and MCP.
  </Card>
</CardGroup>

## What you get

<AccordionGroup>
  <Accordion title="Per-user isolated workspaces" icon="server">
    Every user maps to one deterministic Deployment, Service, identity Secret,
    and retained `ReadWriteOnce` PVC. The Deployment scales between zero and one
    and the complete PVC mounts at `/home/r5d`. The browser never receives
    workspace credentials.
  </Accordion>

  <Accordion title="Bring your own model" icon="plug">
    Users configure any OpenAI-compatible endpoint with their own API key, custom
    headers, model IDs, context windows, and output limits. Keys and headers are
    encrypted at rest with the installation key.
  </Accordion>

  <Accordion title="A batteries-included agent environment" icon="toolbox">
    The workspace image ships Bun, Node.js, Python with the scientific stack,
    native build tools, FFmpeg, ImageMagick, libvips, OCR, LibreOffice, Pandoc,
    Recoll full-text search, and Git/GitHub tooling.
  </Accordion>

  <Accordion title="White-label branding" icon="palette">
    Administrators set the product name, tagline, logo, favicon, and primary
    colors at runtime. No rebuild required.
  </Accordion>

  <Accordion title="Durable conversations" icon="comments">
    Conversations are stored in PostgreSQL with explicit fresh-context
    boundaries. The agent can re-read its own history through the `r5dchat`
    CLI inside the workspace.
  </Accordion>
</AccordionGroup>

## Install in one command

Add the Helm repository and install into a dedicated namespace:

```bash theme={null}
helm repo add r5d-chat https://charts.r5d.dev
helm repo update
helm install r5d-chat r5d-chat/r5d-chat \
  --namespace r5d-chat --create-namespace \
  --set existingSecret=r5d-chat-secrets
```

<Note>
  Both the chart and its container images are published to GHCR on every release
  tag. A chart version always resolves to the images built from the same commit.
  See [Releases and publishing](/reference/releases).
</Note>

## Where to go next

<Columns cols={2}>
  <Card title="Workspace lifecycle" icon="arrows-rotate" href="/operate/workspaces">
    How workspaces start, lease activity, and scale to zero.
  </Card>

  <Card title="Security model" icon="shield-halved" href="/operate/security">
    Trust boundaries, isolation guarantees, and their limits.
  </Card>

  <Card title="Agent tools" icon="wrench" href="/reference/agent-tools">
    Every tool the model can call, with its parameters.
  </Card>

  <Card title="Upgrades" icon="arrow-up-right-dots" href="/operate/upgrades">
    Rolling out new versions and existing user workspaces.
  </Card>
</Columns>