Skip to content

README.md

Latest commit

 

History

History
96 lines (60 loc) · 2.3 KB

README.md

File metadata and controls

96 lines (60 loc) · 2.3 KB

Deployment Guide

Complete guides for deploying FlowCheck in various environments.

Quick Navigation

Scenario Guide Time
Local Development Docker 5 min
Production (Docker) Docker 10 min
Production (Kubernetes) Kubernetes 30 min
CI/CD Integration CI/CD 15 min
Troubleshooting Troubleshooting -

Deployment Models

1. Docker (Recommended)

Best for: Local dev, small teams, single-host deployments

  • Setup time: 5 minutes
  • Resource footprint: ~200MB RAM, minimal CPU
  • Scaling: Manual or via Docker Swarm
  • Complexity: Low

Go to Docker Guide →

2. Kubernetes

Best for: Cloud deployments, high availability, auto-scaling

  • Setup time: 30+ minutes (includes cluster provisioning)
  • Resource footprint: Configurable
  • Scaling: Horizontal via Kubernetes
  • Complexity: High

Go to Kubernetes Guide →

3. CI/CD Integration

Best for: Automated testing and deployment workflows

  • Setup time: 15 minutes
  • Integrations: GitHub Actions, GitLab CI, Jenkins
  • Complexity: Medium

Go to CI/CD Guide →

Environment Variables

All deployment methods use the same environment variables. See .env.example for complete reference.

Required

  • ANTHROPIC_API_KEY or OPENAI_API_KEY - LLM provider credentials

Optional

  • FLOWCHECK_LOG_LEVEL - Log verbosity (DEBUG, INFO, WARNING, ERROR)
  • FLOWCHECK_STORAGE_PATH - Data directory path
  • FLOWCHECK_SESSION_TIMEOUT - Session expiry in seconds

Troubleshooting

Common issues and solutions: Troubleshooting Guide

Monitoring

After deployment, verify that FlowCheck is running:

# Check container/pod health
docker ps  # or kubectl get pods

# Check logs
docker logs flowcheck-server  # or kubectl logs pod/flowcheck-server

# Test that the process is running
docker exec flowcheck-server pgrep flowcheck-server

Next Steps