Docs | Pi-Chat

Getting started

New to Pi-Chat? Start with the overview to understand what it is and who it is for, then follow the installation guide to get a local instance running.

IntroOverviewWhat Pi-Chat is, why it exists, and what it ships today.SetupInstallationClone, configure, migrate, and run Pi-Chat locally in minutes.ConfigConfigurationEvery environment variable: database, auth, storage, and branding.

Deployment

Run Pi-Chat in production with Docker Compose. One command brings up the full stack: app, database, and object storage.

DeploySelf-HostingProduction setup with Docker Compose, reverse proxy, and health checks.OpsOperationsBuild, lint, migrate, seed, Docker commands, and smoke tests.

Features

SecurityAuthenticationDomain restriction, invite flow, banned users, and bootstrap admin.IntegrationsWebhooks and BotsPost messages from external apps, CI pipelines, and monitoring tools.

Reference

InternalsArchitectureHow the Next.js, Prisma, Postgres, and MinIO layers fit together.SchemaData ModelUsers, channels, messages, DMs, tasks, webhooks, and more.APIRoutes and PagesPublic routes, protected app routes, and API endpoints.CodebaseRepository StructureA map of every important folder, file, and script in the repo.