mirror of
https://github.com/Xe138/AI-Trader.git
synced 2026-04-02 01:27:24 -04:00
Bill
b3debc125f
Reorganize documentation into user-focused, developer-focused, and deployment-focused sections. **New structure:** - Root: README.md (streamlined), QUICK_START.md, API_REFERENCE.md - docs/user-guide/: configuration, API usage, integrations, troubleshooting - docs/developer/: contributing, development setup, testing, architecture - docs/deployment/: Docker deployment, production checklist, monitoring - docs/reference/: environment variables, MCP tools, data formats **Changes:** - Streamline README.md from 831 to 469 lines - Create QUICK_START.md for 5-minute onboarding - Create API_REFERENCE.md as single source of truth for API - Remove 9 outdated specification docs (v0.2.0 API design) - Remove DOCKER_API.md (content consolidated into new structure) - Remove docs/plans/ directory with old design documents - Update CLAUDE.md with documentation structure guide - Remove orchestration-specific references **Benefits:** - Clear entry points for different audiences - No content duplication - Better discoverability through logical hierarchy - All content reflects current v0.3.0 API
96 lines
1.4 KiB
Markdown
96 lines
1.4 KiB
Markdown
# Docker Deployment
|
|
|
|
Production Docker deployment guide.
|
|
|
|
---
|
|
|
|
## Quick Deployment
|
|
|
|
```bash
|
|
git clone https://github.com/Xe138/AI-Trader.git
|
|
cd AI-Trader
|
|
cp .env.example .env
|
|
# Edit .env with API keys
|
|
docker-compose up -d
|
|
```
|
|
|
|
---
|
|
|
|
## Production Configuration
|
|
|
|
### Use Pre-built Image
|
|
|
|
```yaml
|
|
# docker-compose.yml
|
|
services:
|
|
ai-trader:
|
|
image: ghcr.io/xe138/ai-trader:latest
|
|
# ... rest of config
|
|
```
|
|
|
|
### Build Locally
|
|
|
|
```yaml
|
|
# docker-compose.yml
|
|
services:
|
|
ai-trader:
|
|
build: .
|
|
# ... rest of config
|
|
```
|
|
|
|
---
|
|
|
|
## Volume Persistence
|
|
|
|
Ensure data persists across restarts:
|
|
|
|
```yaml
|
|
volumes:
|
|
- ./data:/app/data # Required: database and cache
|
|
- ./logs:/app/logs # Recommended: application logs
|
|
- ./configs:/app/configs # Required: model configurations
|
|
```
|
|
|
|
---
|
|
|
|
## Environment Security
|
|
|
|
- Never commit `.env` to version control
|
|
- Use secrets management (Docker secrets, Kubernetes secrets)
|
|
- Rotate API keys regularly
|
|
- Restrict network access to API port
|
|
|
|
---
|
|
|
|
## Health Checks
|
|
|
|
Docker automatically restarts unhealthy containers:
|
|
|
|
```yaml
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
retries: 3
|
|
start_period: 40s
|
|
```
|
|
|
|
---
|
|
|
|
## Monitoring
|
|
|
|
```bash
|
|
# Container status
|
|
docker ps
|
|
|
|
# Resource usage
|
|
docker stats ai-trader
|
|
|
|
# Logs
|
|
docker logs -f ai-trader
|
|
```
|
|
|
|
---
|
|
|
|
See [DOCKER_API.md](../../DOCKER_API.md) for detailed Docker documentation.
|