# Karakoram

> Karakoram is an Apache-2.0, self-hosted control plane for databases and stateful services on infrastructure you run: Zerops (the reference provider), Dokploy or Nomad. It orchestrates databases, message brokers, search, identity, secrets and workflow engines; see the engine guides for capabilities and provider availability. It provides a REST API, the karactl CLI, a web UI and a read-only-by-default MCP server for AI agents, plus an opt-in per-cluster data MCP gateway. Documentation covers installation, providers, operating costs, cluster and fleet operations, backups and backup drills, control-plane backup and rebuild, notifications, access control, security and MCP client setup.

Documentation sections and pages:

- [Overview](https://karakoram.dev/docs/)
- **Getting started**
  - [Quick start](https://karakoram.dev/docs/getting-started/quickstart/)
  - [Install](https://karakoram.dev/docs/getting-started/install/)
  - [Providers](https://karakoram.dev/docs/providers/)
  - [Operating costs](https://karakoram.dev/docs/operating-costs/)
  - [Upgrade](https://karakoram.dev/docs/getting-started/upgrade/)
- **Control plane**
  - [Architecture](https://karakoram.dev/docs/architecture/)
  - [Clusters and operations](https://karakoram.dev/docs/clusters/)
  - [Backups and storage](https://karakoram.dev/docs/backups/)
  - [Namespaces and relays](https://karakoram.dev/docs/namespaces/)
  - [Monitoring and events](https://karakoram.dev/docs/monitoring/)
  - [Access control](https://karakoram.dev/docs/access-control/)
  - [Security](https://karakoram.dev/docs/security/)
  - [Operations and troubleshooting](https://karakoram.dev/docs/operations/)
  - [Limitations](https://karakoram.dev/docs/limitations/)
- **Fleet operations**
  - [Control-plane backup and rebuild](https://karakoram.dev/docs/control-plane-backup/)
  - [Backup drills](https://karakoram.dev/docs/backup-drills/)
  - [Notifications](https://karakoram.dev/docs/notifications/)
- **Providers**
  - [Zerops](https://karakoram.dev/docs/zerops/)
  - [Dokploy](https://karakoram.dev/docs/dokploy/)
  - [Nomad](https://karakoram.dev/docs/nomad/)
- **Interfaces**
  - [Web UI](https://karakoram.dev/docs/web-ui/)
  - [CLI (karactl)](https://karakoram.dev/docs/cli/)
  - [REST API and SDK](https://karakoram.dev/docs/api/)
- **AI agents**
  - [MCP quick start](https://karakoram.dev/docs/mcp-quickstart/)
  - [MCP server](https://karakoram.dev/docs/mcp/)
  - [Cluster data MCP](https://karakoram.dev/docs/data-mcp/)
- **MongoDB**
  - [Overview](https://karakoram.dev/docs/mongodb/)
  - [Replica sets](https://karakoram.dev/docs/mongodb/replica-sets/)
  - [Sharding](https://karakoram.dev/docs/mongodb/sharding/)
  - [Users, roles and TLS](https://karakoram.dev/docs/mongodb/access-and-tls/)
  - [Backups and PITR](https://karakoram.dev/docs/mongodb/backups/)
  - [Operations](https://karakoram.dev/docs/mongodb/operations/)
- **PostgreSQL**
  - [Overview](https://karakoram.dev/docs/postgres/)
  - [Extension profiles](https://karakoram.dev/docs/postgres/profiles/)
  - [Consumer bindings](https://karakoram.dev/docs/postgres/bindings/)
  - [Distributed (Citus)](https://karakoram.dev/docs/postgres/distributed/)
  - [Access and TLS](https://karakoram.dev/docs/postgres/access-and-tls/)
  - [Backups and PITR](https://karakoram.dev/docs/postgres/backups/)
  - [Operations](https://karakoram.dev/docs/postgres/operations/)
- **Supabase**
  - [Overview](https://karakoram.dev/docs/supabase/)
  - [Components and availability](https://karakoram.dev/docs/supabase/components/)
  - [Operations](https://karakoram.dev/docs/supabase/operations/)
- **RabbitMQ**
  - [Overview](https://karakoram.dev/docs/rabbitmq/)
  - [Access and TLS](https://karakoram.dev/docs/rabbitmq/access-and-tls/)
  - [Definitions backups](https://karakoram.dev/docs/rabbitmq/backups/)
  - [Operations](https://karakoram.dev/docs/rabbitmq/operations/)
- **Elasticsearch**
  - [Overview](https://karakoram.dev/docs/elasticsearch/)
  - [Kibana, Logstash and APM](https://karakoram.dev/docs/elasticsearch/stack/)
  - [Access and security](https://karakoram.dev/docs/elasticsearch/access-and-security/)
  - [Snapshots](https://karakoram.dev/docs/elasticsearch/snapshots/)
  - [Operations](https://karakoram.dev/docs/elasticsearch/operations/)
- **MySQL and PXC**
  - [Overview](https://karakoram.dev/docs/mysql/)
  - [Configuration and topology](https://karakoram.dev/docs/mysql/configuration/)
  - [Access and TLS](https://karakoram.dev/docs/mysql/access-and-tls/)
  - [Backups and PITR](https://karakoram.dev/docs/mysql/backups/)
  - [Operations and recovery](https://karakoram.dev/docs/mysql/operations/)
  - [Verification](https://karakoram.dev/docs/mysql/verification/)
- **Neo4j**
  - [Overview](https://karakoram.dev/docs/neo4j/)
  - [Access and TLS](https://karakoram.dev/docs/neo4j/access-and-tls/)
  - [Offline backups](https://karakoram.dev/docs/neo4j/backups/)
  - [Operations](https://karakoram.dev/docs/neo4j/operations/)
- **Weaviate**
  - [Overview](https://karakoram.dev/docs/weaviate/)
  - [Access and TLS](https://karakoram.dev/docs/weaviate/access-and-tls/)
  - [Backups](https://karakoram.dev/docs/weaviate/backups/)
  - [Operations](https://karakoram.dev/docs/weaviate/operations/)
- **Keycloak**
  - [Overview](https://karakoram.dev/docs/keycloak/)
- **OpenBao**
  - [Overview](https://karakoram.dev/docs/openbao/)
  - [Access and TLS](https://karakoram.dev/docs/openbao/access-and-tls/)
  - [Raft backups and recovery](https://karakoram.dev/docs/openbao/backups/)
  - [Operations and unseal](https://karakoram.dev/docs/openbao/operations/)
- **Temporal**
  - [Overview](https://karakoram.dev/docs/temporal/)
  - [Access and TLS](https://karakoram.dev/docs/temporal/access-and-tls/)
  - [Operations and recovery](https://karakoram.dev/docs/temporal/operations/)
- **Reference**
  - [Native artifacts](https://karakoram.dev/docs/native-artifacts/)
  - [Verification](https://karakoram.dev/docs/verification/)
  - [Contributing](https://karakoram.dev/docs/contributing/)
  - [Code of Conduct](https://karakoram.dev/docs/code-of-conduct/)

## Documentation Sets

- [Abridged documentation](https://karakoram.dev/llms-small.txt): a compact version of the documentation for Karakoram, with non-essential content removed
- [Complete documentation](https://karakoram.dev/llms-full.txt): the full documentation for Karakoram

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation