README.md
<a href="https://cap.so"><strong>Cap.so »</strong></a>
<b>Downloads for </b>
<a href="https://cap.so/download">macOS & Windows</a>
Cap is the open source alternative to Loom. It's a video messaging tool that allows you to record, edit and share videos in seconds.
git clone https://github.com/CapSoftware/Cap.git && cd Cap && docker compose up -d
Cap will be running at http://localhost:3000. That's it!
Note: Login links appear in the logs (
docker compose logs cap-web) since email isn't configured by default.
| Method | Best For |
|---|---|
| Docker Compose | VPS, home servers, any Docker host |
| Railway | One-click managed hosting |
| Coolify | Self-hosted PaaS (use docker-compose.coolify.yml) |
For production, create a .env file:
CAP_URL=https://cap.yourdomain.com
S3_PUBLIC_URL=https://s3.yourdomain.com
See our self-hosting docs for full configuration options including email setup, AI features, and SSL.
Cap Desktop can connect to your self-hosted instance via Settings → Cap Server URL.
We use a combination of Rust, React (Next.js), TypeScript, Tauri, Drizzle (ORM), MySQL, TailwindCSS throughout this Turborepo powered monorepo.
A note about database: The codebase is currently designed to work with MySQL only. MariaDB or other compatible databases might partially work but are not officially supported.
desktop: A Tauri (Rust) app, using SolidStart on the frontend.web: A Next.js web app.ui: A React Shared component library.utils: A React Shared utility library.tsconfig: Shared tsconfig configurations used throughout the monorepo.database: A React and Drizzle ORM Shared database library.config: eslint configurations (includes eslint-config-next, eslint-config-prettier other configs used throughout the monorepo).Portions of this software are licensed as follows:
cap-camera* and scap-* families of crates is licensed under the MIT License (see licenses/LICENSE-MIT).See CONTRIBUTING.md for more information. This guide is a work in progress, and is updated regularly as the app matures.
Cap uses Tinybird to ingest viewer telemetry for dashboards. The Tinybird admin token (TINYBIRD_ADMIN_TOKEN or TINYBIRD_TOKEN) must be available in your environment. Once the token is present you can:
pnpm analytics:setup. This command installs the Tinybird CLI (if needed), runs tb login when a .tinyb credential file is missing, copies that credential into scripts/analytics/tinybird, and finally executes tb deploy --allow-destructive-operations --wait from that directory. It synchronizes the Tinybird workspace to the resources defined in scripts/analytics/tinybird, removing any other datasources/pipes in that workspace.pnpm analytics:check.Both commands target the workspace pointed to by TINYBIRD_HOST (defaults to https://api.tinybird.co). Make sure you are comfortable with the destructive nature of the deploy step before running analytics:setup.