# Roomote Docs

> Documentation for Roomote, the open, self-hostable platform for cloud coding agents.

> ## Agent Instructions
> When helping someone deploy Roomote, distinguish self-hosting from contributing to Roomote. Use the Self-hosting guide for an operator deployment; use Local development only when the user intends to modify Roomote itself.
> Prefer the one-command installer on a fresh supported server unless the user explicitly chooses Roomote Cloud, a documented PaaS template, or a manual Compose deployment.
> Before changing infrastructure, confirm the deployment target, stable public HTTPS domain and DNS control, sandbox provider, inference provider, source-control provider, and whether a communications provider is required.
> Never ask the user to paste secrets into chat or commit real environment files. Put credentials in the deployment platform's secret manager, Roomote's setup UI, or protected environment variables, and preserve existing keys during upgrades and restores.
> Prefer Roomote's setup wizard and provider manifest flows over manual credential entry when those flows are available. Ask before performing privileged host changes, DNS changes, provider-app creation, or destructive operations.
> A setup is not complete when the services merely start. Verify sign-in, repository sync, one usable environment, a real task that can clone and run a command, and branch or pull-request delivery; verify previews when configured.
> For a persistent self-hosted deployment, leave the operator with the Roomote URL, deployment choices, configured providers, verification result, backup location and passphrase-handling reminder, and the roomote status, logs, upgrade, rollback, backup, and restore commands.

## Docs

- [Introduction](https://docs.roomote.dev/index.md): Roomote is an open, self-hostable platform for cloud coding agents.
- [Self-hosting](https://docs.roomote.dev/self-hosting.md): Deploy the cloud coding agent you own on Roomote Cloud or your own infrastructure.
- [Homelab deployment](https://docs.roomote.dev/homelab.md): Run Roomote on a Proxmox VM or another Linux server in your homelab.
- [How Roomote works](https://docs.roomote.dev/how-roomote-works.md): Understand where work starts, how Roomote runs, and how results come back.
- [What to ask Roomote](https://docs.roomote.dev/use-cases.md): Frame asks so Roomote can stay scoped, useful, and reviewable.
- [Review a task](https://docs.roomote.dev/tasks.md): Inspect the transcript, logs, diffs, previews, and follow-up path before you trust the result.
- [File attachments](https://docs.roomote.dev/file-attachments.md): Attach files that Roomote can read directly in chat and the web app.
- [Cookbook](https://docs.roomote.dev/cookbook/index.md): Copyable recipes for turning Roomote automations, skills, and integrations into standing team systems.
- [Contributing recipes](https://docs.roomote.dev/cookbook/template.md): Propose a reusable Roomote system for the Cookbook through a repository issue.
- [Inference Overview](https://docs.roomote.dev/models.md): Choose inference providers, enable task models, and tune model roles for different kinds of Roomote work.
- [Amazon Bedrock](https://docs.roomote.dev/providers/inference/amazon-bedrock.md): Connect Roomote to native Amazon Bedrock and Bedrock Mantle models.
- [Anthropic](https://docs.roomote.dev/providers/inference/anthropic.md): Use Anthropic API models directly for Roomote tasks and model roles.
- [Azure AI Foundry](https://docs.roomote.dev/providers/inference/azure-foundry.md): Run supported GPT deployments from Azure AI Foundry in Roomote tasks.
- [Azure OpenAI](https://docs.roomote.dev/providers/inference/azure-openai.md): Run OpenAI models from an Azure OpenAI resource in Roomote tasks.
- [Baseten](https://docs.roomote.dev/providers/inference/baseten.md): Route Roomote tasks to supported foundation models through Baseten.
- [ChatGPT Subscription](https://docs.roomote.dev/providers/inference/chatgpt.md): Connect an eligible ChatGPT subscription to Roomote through OpenAI sign-in.
- [GitHub Copilot](https://docs.roomote.dev/providers/inference/github-copilot.md): Use models included with an eligible GitHub Copilot account in Roomote.
- [Google Gemini](https://docs.roomote.dev/providers/inference/google-gemini.md): Use Google Gemini API models directly through an AI Studio key.
- [Kimi for Coding](https://docs.roomote.dev/providers/inference/kimi-for-coding.md): Connect a Kimi for Coding membership key and use its included coding models.
- [LiteLLM](https://docs.roomote.dev/providers/inference/litellm.md): Route Roomote model calls through a LiteLLM gateway.
- [MiniMax](https://docs.roomote.dev/providers/inference/minimax.md): Use MiniMax API models directly for Roomote coding tasks.
- [Moonshot AI (Kimi)](https://docs.roomote.dev/providers/inference/moonshot-ai.md): Use Kimi models through the metered Moonshot AI Open Platform API.
- [Ollama](https://docs.roomote.dev/providers/inference/ollama.md): Use locally or privately served Ollama models with Roomote.
- [OpenAI](https://docs.roomote.dev/providers/inference/openai.md): Use OpenAI API models with separately billed API capacity.
- [OpenAI-compatible](https://docs.roomote.dev/providers/inference/openai-compatible.md): Connect one or more OpenAI API endpoints as Roomote inference providers.
- [OpenCode Zen](https://docs.roomote.dev/providers/inference/opencode.md): Use OpenCode's routed Zen model service with Roomote.
- [OpenCode Go](https://docs.roomote.dev/providers/inference/opencode-go.md): Use an OpenCode Go subscription with Roomote.
- [OpenRouter](https://docs.roomote.dev/providers/inference/openrouter.md): Access models from many vendors through one OpenRouter account and key.
- [Requesty](https://docs.roomote.dev/providers/inference/requesty.md): Route Roomote model calls through Requesty's multi-provider AI gateway.
- [Together AI](https://docs.roomote.dev/providers/inference/together-ai.md): Use Together AI's hosted open-model catalog for Roomote tasks.
- [Vercel AI Gateway](https://docs.roomote.dev/providers/inference/vercel-ai-gateway.md): Route Roomote model calls through Vercel AI Gateway.
- [vLLM](https://docs.roomote.dev/providers/inference/vllm.md): Serve OpenAI-compatible models on vLLM infrastructure for Roomote tasks.
- [xAI](https://docs.roomote.dev/providers/inference/xai.md): Use metered Grok API access through an xAI API key.
- [xAI Grok Subscription](https://docs.roomote.dev/providers/inference/xai-subscription.md): Connect an eligible SuperGrok or X Premium+ subscription to Roomote.
- [Z.AI](https://docs.roomote.dev/providers/inference/zai.md): Use metered GLM API access from the international Z.AI or China BigModel platform.
- [Z.AI Coding Plan](https://docs.roomote.dev/providers/inference/zai-coding-plan.md): Connect a regional Z.AI Coding Plan key and use its included GLM allowance.
- [Communications Overview](https://docs.roomote.dev/communications.md): Connect Slack, Microsoft Teams, Telegram, or Discord so Roomote can start, continue, and summarize work from chat.
- [Discord](https://docs.roomote.dev/providers/communications/discord.md): Configure a Discord bot so Roomote can start and continue tasks in DMs, channels, threads, and forums.
- [Microsoft Teams](https://docs.roomote.dev/providers/communications/microsoft-teams.md): Configure Microsoft sign-in and Microsoft Teams bot messaging for Roomote.
- [Slack](https://docs.roomote.dev/providers/communications/slack.md): Configure Slack sign-in, Slack app callbacks, events, and interactivity for Roomote.
- [Telegram](https://docs.roomote.dev/providers/communications/telegram.md): Configure a Telegram bot and webhook so Roomote can start and continue tasks from Telegram.
- [Source Control Overview](https://docs.roomote.dev/source-control.md): Connect GitHub, GitLab, Gitea, Bitbucket, or Azure DevOps so Roomote can clone repositories and open reviewable changes.
- [Azure DevOps](https://docs.roomote.dev/providers/source-control/azure-devops.md): Configure Azure DevOps repository sync for Roomote.
- [Bitbucket Cloud](https://docs.roomote.dev/providers/source-control/bitbucket.md): Configure Bitbucket Cloud repository sync and pull request webhooks and pipeline failure triage for Roomote.
- [Gitea](https://docs.roomote.dev/providers/source-control/gitea.md): Configure Gitea repository sync, pull request webhooks, and Actions failure triage for Roomote.
- [GitHub](https://docs.roomote.dev/providers/source-control/github.md): Configure a GitHub App so Roomote can sync repositories, clone code, and work with pull requests.
- [GitLab](https://docs.roomote.dev/providers/source-control/gitlab.md): Configure GitLab repository sync, merge request webhooks, and pipeline failure triage for Roomote.
- [Sandboxes Overview](https://docs.roomote.dev/compute.md): Choose where Roomote runs task sandboxes: local Docker or a hosted sandbox backend.
- [Azure Container Apps](https://docs.roomote.dev/providers/compute/azure.md): Run Roomote tasks on Azure Container Apps sandboxes.
- [Blaxel](https://docs.roomote.dev/providers/compute/blaxel.md): Run Roomote tasks in Blaxel perpetual sandboxes.
- [Daytona](https://docs.roomote.dev/providers/compute/daytona.md): Run Roomote tasks on Daytona-hosted sandboxes.
- [Docker](https://docs.roomote.dev/providers/compute/docker.md): Run Roomote task sandboxes as Docker containers on the same host as the deployment.
- [E2B](https://docs.roomote.dev/providers/compute/e2b.md): Run Roomote tasks on E2B-hosted sandboxes.
- [Modal](https://docs.roomote.dev/providers/compute/modal.md): Run Roomote tasks on Modal-hosted sandboxes with snapshot support.
- [Integrations Overview](https://docs.roomote.dev/integrations/index.md): Connect the tools that give Roomote the right context inside tasks.
- [Custom MCP Servers](https://docs.roomote.dev/integrations/custom-mcp-servers.md): Connect MCP servers that are not in the built-in catalog
- [Roomote MCP](https://docs.roomote.dev/integrations/roomote-mcp.md): Run and manage Roomote agent tasks from your MCP client.
- [Asana](https://docs.roomote.dev/integrations/asana.md): Bring Asana project and task context into Roomote tasks.
- [Better Stack](https://docs.roomote.dev/integrations/better-stack.md): Bring monitoring and incident context into Roomote tasks.
- [Braintrust](https://docs.roomote.dev/integrations/braintrust.md): Give Roomote access to Braintrust prompts, runs, and results.
- [Grafana](https://docs.roomote.dev/integrations/grafana.md): Let Roomote inspect shared Grafana dashboards, alerting state, annotations, and data sources during a task.
- [Granola](https://docs.roomote.dev/integrations/granola.md): Give Roomote read-only access to shared Granola meeting context.
- [Jira](https://docs.roomote.dev/integrations/jira.md): Bring Jira issue and project context into Roomote tasks.
- [Linear](https://docs.roomote.dev/integrations/linear.md): Turn Linear issues into scoped Roomote work.
- [monday.com](https://docs.roomote.dev/integrations/monday.md): Bring monday.com board, item, update, and workspace context into Roomote tasks.
- [Neon](https://docs.roomote.dev/integrations/neon.md): Let Roomote inspect Neon databases during a task.
- [Notion](https://docs.roomote.dev/integrations/notion.md): Bring Notion pages and databases into Roomote tasks.
- [PostHog](https://docs.roomote.dev/integrations/posthog.md): Let Roomote inspect analytics, experiments, and error-tracking context from PostHog.
- [Pylon](https://docs.roomote.dev/integrations/pylon.md): Bring customer issue and account context from Pylon into Roomote tasks.
- [Railway](https://docs.roomote.dev/integrations/railway.md): Let Roomote inspect Railway projects and services during a task.
- [Resend](https://docs.roomote.dev/integrations/resend.md): Inspect and manage shared email infrastructure from Roomote tasks.
- [Sentry](https://docs.roomote.dev/integrations/sentry.md): Bring Sentry issue and performance context into Roomote tasks.
- [Snowflake](https://docs.roomote.dev/integrations/snowflake.md): Let Roomote query and explore your Snowflake warehouse during a task.
- [Supabase](https://docs.roomote.dev/integrations/supabase.md): Let Roomote inspect read-only database context from Supabase.
- [Supermemory](https://docs.roomote.dev/integrations/supermemory.md): Save and recall shared memories across Roomote tasks.
- [Vercel](https://docs.roomote.dev/integrations/vercel.md): Let Roomote inspect shared Vercel teams, projects, deployments, logs, and domain availability during a task.
- [Zero](https://docs.roomote.dev/integrations/zero.md): Discover and pay for external capabilities with a workspace Zero connection.
- [Agent Guidance](https://docs.roomote.dev/agent-guidance.md): Add deployment-wide instructions that Roomote should consider across tasks.
- [Anonymous Telemetry](https://docs.roomote.dev/anonymous-analytics.md): What anonymous usage data a Roomote deployment can share, how it is identified, and how admins turn it off.
- [Automations](https://docs.roomote.dev/automations.md): Set up background Roomote work for PR review, conflict resolution, recurring triage, and team updates.
- [Cost Analytics](https://docs.roomote.dev/cost-analytics.md): Review Roomote inference spend by task type, environment, provider, model, or user.
- [Environment Variables](https://docs.roomote.dev/environment-variables.md): Understand Roomote environment-variable precedence, production recommendations, and supported deployment configuration keys.
- [Environments](https://docs.roomote.dev/environments.md): Give Roomote the repositories, services, secrets, and guidance it needs to run and verify work.
- [Environment definition](https://docs.roomote.dev/environments/definition.md): Understand the environment definition YAML: the schema, how it relates to Dev Containers, and how to write your own by hand or with a coding agent.
- [Personal Settings](https://docs.roomote.dev/personal-settings.md): Manage your profile, linked accounts, theme, and personal app preferences.
- [Skills](https://docs.roomote.dev/skills.md): Add reusable environment-level playbooks that help Roomote handle specialized tools, workflows, and team practices.
- [Users](https://docs.roomote.dev/users.md): Manage who can sign in to a Roomote deployment, what role they have, and how password resets work.
- [Local development](https://docs.roomote.dev/local-development.md): Set up the repository to develop on Roomote itself.
- [Architecture](https://docs.roomote.dev/architecture.md): A contributor-oriented map of the apps and packages that make up Roomote.