machinaos 0.0.1 → 0.0.7

package/docs-MachinaOs/README.md

@@ -1,85 +0,0 @@
-# MachinaOs Documentation
-
-This folder contains the Mintlify documentation for MachinaOs.
-
-## Setup
-
-1. Create a new repository `trohitg/machinaos-docs` on GitHub
-2. Copy the contents of this folder to the new repository
-3. Connect the repository to Mintlify:
-   - Go to [mintlify.com](https://mintlify.com)
-   - Click "Get Started" and sign in with GitHub
-   - Select your `machinaos-docs` repository
-   - Mintlify will automatically deploy your docs
-
-## Local Development
-
-```bash
-# Install Mintlify CLI
-npm install -g mintlify
-
-# Run local dev server
-cd docs-mintlify
-mintlify dev
-```
-
-The docs will be available at http://localhost:3000
-
-## Structure
-
-```
-docs-mintlify/
-├── docs.json           # Mintlify configuration
-├── introduction.mdx    # Home page
-├── installation.mdx    # Setup guide
-├── quickstart.mdx      # Quick start tutorial
-├── faq.mdx            # FAQ page
-├── tutorials/         # Step-by-step guides
-│   ├── first-workflow.mdx
-│   ├── ai-agent-workflow.mdx
-│   ├── whatsapp-automation.mdx
-│   └── android-automation.mdx
-├── nodes/             # Node documentation
-│   ├── overview.mdx
-│   ├── ai-models.mdx
-│   ├── ai-agent.mdx
-│   ├── whatsapp.mdx
-│   ├── android.mdx
-│   ├── webhooks.mdx
-│   └── schedulers.mdx
-├── deployment/        # Deployment guides
-│   ├── docker.mdx
-│   └── production.mdx
-├── logo/              # Logo assets
-│   ├── dark.svg
-│   └── light.svg
-├── images/            # Screenshots and diagrams
-└── favicon.svg        # Browser favicon
-```
-
-## Adding Content
-
-1. Create new `.mdx` files in the appropriate folder
-2. Add frontmatter with title and description:
-   ```mdx
-   ---
-   title: Page Title
-   description: Brief description
-   ---
-   ```
-3. Update `docs.json` navigation to include new pages
-4. Commit and push - Mintlify auto-deploys
-
-## Mintlify Components
-
-Common components used in docs:
-
-- `<Card>` - Feature cards with icons
-- `<CardGroup>` - Grid layout for cards
-- `<Tabs>` - Tabbed content
-- `<Accordion>` - Collapsible sections
-- `<Info>`, `<Warning>`, `<Tip>` - Callout boxes
-- `<ParamField>` - Parameter documentation
-- `<Check>` - Success checkmarks
-
-See [Mintlify docs](https://mintlify.com/docs) for full component reference.

package/docs-MachinaOs/deployment/docker.mdx

@@ -1,228 +0,0 @@
----
-title: Docker Setup
-description: Run MachinaOs with Docker Compose
----
-
-# Docker Setup
-
-The easiest way to run MachinaOs is with Docker Compose.
-
-## Prerequisites
-
-- Docker 20.10+
-- Docker Compose 2.0+
-- 2GB RAM minimum
-
-## Quick Start
-
-```bash
-# Clone the repository
-git clone https://github.com/trohitg/MachinaOS.git
-cd MachinaOs
-
-# Build images
-npm run docker:build
-
-# Start all services
-npm run docker:up
-```
-
-This starts 4 containers:
-- **frontend** - React app on port 3000
-- **backend** - FastAPI server on port 3010
-- **whatsapp** - Go WhatsApp service on port 9400
-- **redis** - Cache on port 6379 (optional)
-
-## Container Overview
-
-| Container | Image | Port | Purpose |
-|-----------|-------|------|---------|
-| frontend | machinaos-frontend | 3000 | React UI |
-| backend | machinaos-backend | 3010 | API server |
-| whatsapp | machinaos-whatsapp | 9400 | WhatsApp bridge |
-| redis | redis:7-alpine | 6379 | Cache (optional) |
-
-## Configuration
-
-### Environment Variables
-
-Create a `.env` file in the project root:
-
-```bash
-# Ports
-VITE_CLIENT_PORT=3000
-PYTHON_BACKEND_PORT=3010
-WHATSAPP_RPC_PORT=9400
-
-# Authentication
-AUTH_MODE=single
-JWT_SECRET_KEY=your-secret-key-min-32-chars
-
-# Cache (optional)
-REDIS_ENABLED=false
-
-# AI API Keys (optional)
-OPENAI_API_KEY=
-ANTHROPIC_API_KEY=
-```
-
-### Redis (Optional)
-
-Redis is disabled by default for local development. To enable:
-
-```bash
-# In .env
-REDIS_ENABLED=true
-```
-
-Then start with Redis profile:
-
-```bash
-docker-compose --profile redis up -d
-```
-
-## Common Commands
-
-```bash
-# Start services
-npm run docker:up
-
-# View logs
-npm run docker:logs
-
-# Stop all services
-npm run docker:down
-
-# Rebuild after code changes
-npm run docker:build && npm run docker:up
-
-# Stop and remove volumes (clean slate)
-docker-compose down -v
-
-# View specific service logs
-docker-compose logs -f backend
-
-# Restart specific service
-docker-compose restart backend
-```
-
-## Accessing Services
-
-After starting, access:
-
-| Service | URL |
-|---------|-----|
-| Frontend | http://localhost:3000 |
-| Backend API | http://localhost:3010 |
-| Health Check | http://localhost:3010/health |
-| WebSocket | ws://localhost:3010/ws/status |
-
-## Health Checks
-
-All containers include health checks:
-
-```bash
-# Check container health
-docker-compose ps
-
-# Check backend health
-curl http://localhost:3010/health
-```
-
-Expected health response:
-```json
-{
-  "status": "healthy",
-  "redis_enabled": false,
-  "version": "1.0.0"
-}
-```
-
-## Troubleshooting
-
-<Accordion title="Container won't start">
-  Check logs for errors:
-  ```bash
-  docker-compose logs backend
-  docker-compose logs frontend
-  ```
-
-  Common issues:
-  - Port already in use: Change port in `.env`
-  - Missing environment variables: Check `.env` file exists
-</Accordion>
-
-<Accordion title="Frontend can't connect to backend">
-  - Verify both containers are running: `docker-compose ps`
-  - Check network: containers should be on same network
-  - Check CORS settings in backend `.env`
-</Accordion>
-
-<Accordion title="WhatsApp service issues">
-  ```bash
-  # Check WhatsApp logs
-  docker-compose logs whatsapp
-
-  # Restart WhatsApp service
-  docker-compose restart whatsapp
-  ```
-</Accordion>
-
-<Accordion title="Out of disk space">
-  Clean up Docker resources:
-  ```bash
-  docker system prune -af
-  docker builder prune -af
-  ```
-</Accordion>
-
-## Resource Usage
-
-Typical resource consumption:
-
-| Container | Memory | CPU |
-|-----------|--------|-----|
-| frontend | ~50 MB | Low |
-| backend | ~150 MB | Medium |
-| whatsapp | ~30 MB | Low |
-| redis | ~10 MB | Low |
-
-## Data Persistence
-
-Data is stored in Docker volumes:
-
-| Volume | Purpose |
-|--------|---------|
-| backend-data | SQLite database, uploads |
-| whatsapp-data | WhatsApp session |
-| redis-data | Cache data |
-
-To backup data:
-```bash
-docker cp machinaos-backend-1:/app/data ./backup
-```
-
-## Development Mode
-
-For development with hot reload:
-
-```bash
-# Use development compose file
-docker-compose -f docker-compose.dev.yml up
-```
-
-Or run services separately:
-```bash
-npm run dev  # Starts frontend + backend with hot reload
-```
-
-## Next Steps
-
-<CardGroup cols={2}>
-  <Card title="Production Deployment" icon="server" href="/deployment/production">
-    Deploy to a server with nginx and SSL
-  </Card>
-  <Card title="Configuration" icon="gear" href="/installation">
-    Full environment variable reference
-  </Card>
-</CardGroup>

package/docs-MachinaOs/deployment/production.mdx

@@ -1,345 +0,0 @@
----
-title: Production Deployment
-description: Deploy MachinaOs to production with nginx and SSL
----
-
-# Production Deployment
-
-Deploy MachinaOs to a production server with Docker, nginx reverse proxy, and SSL.
-
-## Server Requirements
-
-- Ubuntu 20.04+ or similar Linux
-- 2+ CPU cores
-- 2GB+ RAM
-- Docker and Docker Compose
-- Domain name (for SSL)
-
-## Deployment Overview
-
-```
-Internet --> nginx (SSL) --> Docker Containers
-                   |
-                   +--> frontend (3000)
-                   +--> backend (3010)
-                   +--> whatsapp (9400)
-                   +--> redis (6379)
-```
-
-## Step 1: Server Setup
-
-```bash
-# Update system
-sudo apt update && sudo apt upgrade -y
-
-# Install Docker
-curl -fsSL https://get.docker.com | sh
-sudo usermod -aG docker $USER
-
-# Install Docker Compose
-sudo apt install docker-compose-plugin
-
-# Install nginx
-sudo apt install nginx certbot python3-certbot-nginx
-```
-
-## Step 2: Clone and Configure
-
-```bash
-# Clone repository
-cd /opt
-sudo git clone https://github.com/trohitg/MachinaOs.git
-cd MachinaOs
-
-# Create production environment file
-sudo cp .env.example .env.prod
-sudo nano .env.prod
-```
-
-### Production Environment
-
-```bash
-# .env.prod
-VITE_CLIENT_PORT=3000
-PYTHON_BACKEND_PORT=3010
-WHATSAPP_RPC_PORT=9400
-
-# Security - CHANGE THESE
-SECRET_KEY=your-random-64-char-string
-JWT_SECRET_KEY=your-random-32-char-string
-API_KEY_ENCRYPTION_KEY=your-random-64-char-string
-
-# Authentication
-AUTH_MODE=single
-JWT_COOKIE_SECURE=true
-JWT_COOKIE_SAMESITE=strict
-
-# Cache
-REDIS_ENABLED=true
-REDIS_URL=redis://redis:6379
-
-# CORS - your domain
-CORS_ORIGINS=["https://your-domain.com"]
-
-# Logging
-LOG_LEVEL=INFO
-DEBUG=false
-```
-
-<Warning>
-Generate secure random strings for SECRET_KEY, JWT_SECRET_KEY, and API_KEY_ENCRYPTION_KEY. Never use default values in production.
-</Warning>
-
-## Step 3: Build and Start
-
-```bash
-# Build production images
-docker-compose -f docker-compose.prod.yml build
-
-# Start services
-docker-compose -f docker-compose.prod.yml up -d
-
-# Verify containers
-docker-compose -f docker-compose.prod.yml ps
-```
-
-## Step 4: Configure nginx
-
-Create nginx configuration:
-
-```bash
-sudo nano /etc/nginx/sites-available/machinaos
-```
-
-```nginx
-server {
-    listen 80;
-    server_name your-domain.com;
-
-    location / {
-        return 301 https://$server_name$request_uri;
-    }
-}
-
-server {
-    listen 443 ssl http2;
-    server_name your-domain.com;
-
-    # SSL configuration (will be added by certbot)
-
-    # Frontend
-    location / {
-        proxy_pass http://127.0.0.1:3000;
-        proxy_http_version 1.1;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-    }
-
-    # Backend API
-    location /api/ {
-        proxy_pass http://127.0.0.1:3010/api/;
-        proxy_http_version 1.1;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-    }
-
-    # WebSocket
-    location /ws/ {
-        proxy_pass http://127.0.0.1:3010/ws/;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "upgrade";
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_read_timeout 86400;
-    }
-
-    # Webhooks
-    location /webhook/ {
-        proxy_pass http://127.0.0.1:3010/webhook/;
-        proxy_http_version 1.1;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    }
-
-    # Health check
-    location /health {
-        proxy_pass http://127.0.0.1:3010/health;
-    }
-}
-```
-
-Enable the site:
-
-```bash
-sudo ln -s /etc/nginx/sites-available/machinaos /etc/nginx/sites-enabled/
-sudo nginx -t
-sudo systemctl reload nginx
-```
-
-## Step 5: SSL Certificate
-
-```bash
-# Get SSL certificate from Let's Encrypt
-sudo certbot --nginx -d your-domain.com
-
-# Auto-renewal is configured automatically
-# Test renewal
-sudo certbot renew --dry-run
-```
-
-## Step 6: Firewall
-
-```bash
-# Allow required ports
-sudo ufw allow 22/tcp   # SSH
-sudo ufw allow 80/tcp   # HTTP (redirect)
-sudo ufw allow 443/tcp  # HTTPS
-sudo ufw enable
-```
-
-## Verify Deployment
-
-```bash
-# Check health endpoint
-curl https://your-domain.com/health
-
-# Check containers
-docker-compose -f docker-compose.prod.yml ps
-
-# View logs
-docker-compose -f docker-compose.prod.yml logs -f
-```
-
-## Maintenance
-
-### Updates
-
-```bash
-cd /opt/MachinaOs
-
-# Pull latest code
-git pull
-
-# Rebuild and restart
-docker-compose -f docker-compose.prod.yml down
-docker-compose -f docker-compose.prod.yml up --build -d
-```
-
-### Backups
-
-```bash
-# Backup database
-docker cp machinaos-backend-1:/app/data/workflow.db ./backup/
-
-# Backup WhatsApp session
-docker cp machinaos-whatsapp-1:/app/data ./backup/whatsapp/
-```
-
-### Monitoring
-
-```bash
-# Check resource usage
-docker stats --no-stream
-
-# Check logs for errors
-docker-compose -f docker-compose.prod.yml logs --tail=100 backend
-```
-
-### Log Rotation
-
-Add to `/etc/logrotate.d/docker`:
-
-```
-/var/lib/docker/containers/*/*.log {
-    rotate 7
-    daily
-    compress
-    missingok
-    delaycompress
-    copytruncate
-}
-```
-
-## Security Checklist
-
-<Check>
-All secret keys are randomly generated and unique
-</Check>
-
-<Check>
-SSL/TLS is enabled with valid certificate
-</Check>
-
-<Check>
-JWT_COOKIE_SECURE is set to true
-</Check>
-
-<Check>
-CORS_ORIGINS only includes your domain
-</Check>
-
-<Check>
-DEBUG is set to false
-</Check>
-
-<Check>
-Firewall is configured
-</Check>
-
-<Check>
-SSH key authentication (disable password auth)
-</Check>
-
-## Troubleshooting
-
-<Accordion title="502 Bad Gateway">
-  - Check if containers are running: `docker-compose ps`
-  - Verify ports match nginx config
-  - Check backend logs: `docker-compose logs backend`
-</Accordion>
-
-<Accordion title="WebSocket connection fails">
-  - Verify nginx WebSocket config has Upgrade headers
-  - Check proxy_read_timeout is set
-  - Ensure firewall allows connections
-</Accordion>
-
-<Accordion title="SSL certificate issues">
-  ```bash
-  # Renew certificate manually
-  sudo certbot renew --force-renewal
-  sudo systemctl reload nginx
-  ```
-</Accordion>
-
-<Accordion title="High memory usage">
-  - Check for memory leaks: `docker stats`
-  - Restart containers: `docker-compose restart`
-  - Increase server RAM if needed
-</Accordion>
-
-## Scaling
-
-For higher load:
-
-1. **Horizontal scaling**: Use Docker Swarm or Kubernetes
-2. **Database**: Migrate from SQLite to PostgreSQL
-3. **Cache**: Use Redis cluster
-4. **Load balancer**: Add HAProxy or cloud load balancer
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Docker Setup" icon="docker" href="/deployment/docker">
-    Local Docker development
-  </Card>
-  <Card title="Configuration" icon="gear" href="/installation">
-    Environment variables reference
-  </Card>
-</CardGroup>