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

# Deployment

> Deploy Shannon to production environments

## Production Deployment Guide

Deploy Shannon to your infrastructure with confidence. This section covers deployment patterns, cloud platform integrations, and operational best practices.

<Warning>
  Shannon is currently in active development. Production deployment guides are being finalized. For production use, we recommend:

  * Thorough testing in staging environments
  * Monitoring all services closely
</Warning>

## Deployment Options

<CardGroup cols={2}>
  <Card title="Docker Compose" icon="docker" href="/en/deployment/docker-compose">
    Production-ready Docker Compose configuration

    <br />

    **Status**: 🚧 Phase 3
  </Card>

  <Card title="Kubernetes" icon="dharmachakra" href="/en/deployment/kubernetes">
    Kubernetes manifests and Helm charts

    <br />

    **Status**: 🚧 Phase 3
  </Card>

  <Card title="AWS" icon="aws" href="/en/deployment/aws">
    Deploy to Amazon Web Services (ECS, RDS, ElastiCache)

    <br />

    **Status**: 🚧 Phase 3
  </Card>

  <Card title="Azure" icon="microsoft" href="/en/deployment/azure">
    Deploy to Microsoft Azure (AKS, PostgreSQL, Redis)

    <br />

    **Status**: 🚧 Phase 3
  </Card>
</CardGroup>

## Operations

<CardGroup cols={2}>
  <Card title="Monitoring" icon="chart-line" href="/en/deployment/monitoring">
    Prometheus metrics, Grafana dashboards, and alerting

    <br />

    **Status**: 🚧 Phase 3
  </Card>

  <Card title="Performance Tuning" icon="gauge" href="/en/deployment/performance-tuning">
    Optimize throughput, latency, and resource usage

    <br />

    **Status**: 🚧 Phase 3
  </Card>

  <Card title="Security" icon="shield" href="/en/deployment/security">
    Production security hardening and best practices

    <br />

    **Status**: 🚧 Phase 3
  </Card>
</CardGroup>

## Quick Start: Local Development

For development and testing, use Docker Compose:

```bash theme={null}
# Clone repository
git clone https://github.com/Kocoro-lab/Shannon.git
cd Shannon

# Setup configuration
make setup
echo "OPENAI_API_KEY=sk-your-key-here" >> .env

# Download Python WASI interpreter
./scripts/setup_python_wasi.sh

# Start all services
make dev
```

See [Installation Guide](/en/quickstart/installation) for detailed setup instructions.

## Architecture Overview

Shannon consists of multiple services that need to be deployed:

<img src="https://mintcdn.com/ptmind-3aa3d4e1/2Bzddmlzr-QTR0Yc/en/deployment/assets/deployment-architecture.svg?fit=max&auto=format&n=2Bzddmlzr-QTR0Yc&q=85&s=29abee947177afa39ed12b0387194b6a" alt="Deployment Architecture" width="800" height="650" data-path="en/deployment/assets/deployment-architecture.svg" />

### Core Services

| Service          | Purpose                                 | Scaling                                   |
| ---------------- | --------------------------------------- | ----------------------------------------- |
| **Gateway**      | REST API, authentication                | Horizontal (stateless)                    |
| **Orchestrator** | Task coordination, gRPC                 | Horizontal (stateful via Temporal)        |
| **Agent Core**   | Agent execution, Rust runtime           | Horizontal                                |
| **LLM Service**  | LLM provider gateway                    | Horizontal                                |
| **Desktop App**  | Real-time monitoring UI (native client) | Client-side; backend scales independently |

### Data Stores

| Store          | Purpose                            | Scaling                  |
| -------------- | ---------------------------------- | ------------------------ |
| **PostgreSQL** | Task metadata, events, sessions    | Vertical + read replicas |
| **Redis**      | Caching, pub/sub, sessions         | Cluster mode             |
| **Qdrant**     | Vector embeddings, semantic memory | Horizontal               |
| **Temporal**   | Workflow state, durable execution  | Cluster mode             |

## Production Checklist

Before deploying to production:

### Security

* [ ] Enable authentication (`GATEWAY_SKIP_AUTH=0`)
* [ ] Configure TLS/SSL for all services
* [ ] Rotate API keys regularly
* [ ] Set up OPA policies for access control
* [ ] Enable audit logging
* [ ] Configure network policies/firewalls

### Reliability

* [ ] Set up health checks and readiness probes
* [ ] Configure auto-scaling policies
* [ ] Implement circuit breakers
* [ ] Set resource limits (CPU, memory)
* [ ] Configure backup and disaster recovery
* [ ] Test failover scenarios

### Observability

* [ ] Deploy Prometheus and Grafana
* [ ] Configure alerting rules
* [ ] Set up log aggregation (ELK/Loki)
* [ ] Enable distributed tracing (OpenTelemetry)
* [ ] Create runbooks for common issues

### Performance

* [ ] Tune Temporal worker concurrency
* [ ] Optimize database connections
* [ ] Configure Redis caching
* [ ] Set appropriate resource limits
* [ ] Load test before production launch

## Resource Requirements

### Minimum (Development)

* **CPU**: 4 cores
* **RAM**: 8GB
* **Storage**: 20GB SSD

### Recommended (Production - Small)

* **CPU**: 16 cores total (distributed across services)
* **RAM**: 32GB total
* **Storage**: 100GB SSD
* **Network**: 1Gbps

### Recommended (Production - Large)

* **CPU**: 64+ cores
* **RAM**: 128GB+
* **Storage**: 500GB+ SSD
* **Network**: 10Gbps
* **Load Balancer**: Required
* **Multi-AZ**: Recommended

## What's Next?

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/en/quickstart/installation">
    Install Shannon locally first
  </Card>

  <Card title="Configuration" icon="gear" href="/en/quickstart/configuration">
    Understand environment variables
  </Card>

  <Card title="Architecture" icon="sitemap" href="/en/architecture/overview">
    Learn system architecture
  </Card>

  <Card title="Monitoring" icon="chart-line" href="/en/quickstart/concepts/monitoring">
    Set up monitoring
  </Card>
</CardGroup>

## Get Help

* **GitHub**: File deployment issues or questions
* **Docs**: Check [Troubleshooting](/en/quickstart/troubleshooting) for common problems