suthep 0.1.0 → 0.2.0-beta.1

package/docs/english/08-advanced.md

@@ -0,0 +1,411 @@
+# Advanced Topics
+
+This guide covers advanced configuration options and optimization techniques for Suthep.
+
+## Advanced Configuration
+
+### Custom Nginx Configuration
+
+While Suthep generates Nginx configurations automatically, you can customize them by editing the generated files:
+
+```bash
+# Edit generated config
+sudo nano /etc/nginx/sites-available/example_com.conf
+```
+
+**Note:** Manual edits may be overwritten on redeployment. Consider using Nginx includes for custom configurations.
+
+### Environment-Specific Configurations
+
+Use different configuration files for different environments:
+
+```bash
+# Development
+suthep deploy -f suthep.dev.yml
+
+# Staging
+suthep deploy -f suthep.staging.yml
+
+# Production
+suthep deploy -f suthep.prod.yml
+```
+
+### Multiple Deployment Strategies
+
+Configure different strategies per service (future feature):
+
+```yaml
+services:
+  - name: api
+    deployment:
+      strategy: blue-green
+  - name: webapp
+    deployment:
+      strategy: rolling
+```
+
+## Performance Optimization
+
+### Health Check Optimization
+
+Optimize health check intervals based on service criticality:
+
+```yaml
+# Critical service - frequent checks
+services:
+  - name: payment-api
+    healthCheck:
+      interval: 15  # Check every 15 seconds
+
+# Less critical service - less frequent checks
+services:
+  - name: analytics
+    healthCheck:
+      interval: 120  # Check every 2 minutes
+```
+
+### Deployment Timeout Tuning
+
+Adjust health check timeouts for slow-starting services:
+
+```yaml
+deployment:
+  healthCheckTimeout: 60000  # 60 seconds for slow services
+```
+
+### Resource Management
+
+Monitor and manage resources:
+
+```bash
+# Monitor Docker resources
+docker stats
+
+# Monitor Nginx connections
+sudo nginx -V  # Check worker processes
+```
+
+## Security Best Practices
+
+### SSL/TLS Configuration
+
+Ensure strong SSL configuration:
+
+1. **Use Production Certificates**
+   ```yaml
+   certbot:
+     staging: false  # Use production certificates
+   ```
+
+2. **Monitor Certificate Expiry**
+   ```bash
+   sudo certbot certificates
+   ```
+
+3. **Set Up Auto-Renewal**
+   ```bash
+   # Certbot auto-renewal (usually set up automatically)
+   sudo certbot renew --dry-run
+   ```
+
+### Firewall Configuration
+
+Configure firewall rules:
+
+```bash
+# Allow HTTP and HTTPS
+sudo ufw allow 80/tcp
+sudo ufw allow 443/tcp
+
+# Deny direct access to service ports
+sudo ufw deny 3000/tcp
+```
+
+### Container Security
+
+Secure Docker containers:
+
+```yaml
+services:
+  - name: api
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      # Consider adding:
+      # - Resource limits
+      # - Security options
+      # - Network isolation
+```
+
+## Monitoring and Logging
+
+### Nginx Access Logs
+
+Monitor access patterns:
+
+```bash
+# Real-time access monitoring
+sudo tail -f /var/log/nginx/access.log
+
+# Analyze access patterns
+sudo cat /var/log/nginx/access.log | grep "GET /api"
+```
+
+### Docker Container Logs
+
+Monitor container logs:
+
+```bash
+# Follow logs
+docker logs -f <container-name>
+
+# View last 100 lines
+docker logs --tail 100 <container-name>
+
+# Logs with timestamps
+docker logs -t <container-name>
+```
+
+### Health Check Monitoring
+
+Monitor health check status:
+
+```bash
+# Manual health check
+curl http://localhost:3000/health
+
+# Automated monitoring script
+while true; do
+  curl -f http://localhost:3000/health || echo "Health check failed"
+  sleep 30
+done
+```
+
+## Scaling Strategies
+
+### Horizontal Scaling
+
+Deploy multiple instances:
+
+```yaml
+services:
+  - name: api
+    port: 3000
+    instances: 3  # Deploy 3 instances
+    domains:
+      - api.example.com
+```
+
+**Note:** This is a conceptual example. Current implementation manages single instances per service.
+
+### Load Balancing
+
+Use Nginx for load balancing (advanced):
+
+```nginx
+upstream api_backend {
+    server localhost:3000;
+    server localhost:3001;
+    server localhost:3002;
+}
+```
+
+## Backup and Recovery
+
+### Configuration Backup
+
+Backup your configuration:
+
+```bash
+# Backup configuration
+cp suthep.yml suthep.yml.backup
+
+# Version control
+git add suthep.yml
+git commit -m "Update deployment configuration"
+```
+
+### Nginx Configuration Backup
+
+Backup Nginx configurations:
+
+```bash
+# Backup all Nginx configs
+sudo tar -czf nginx-configs-backup.tar.gz /etc/nginx/sites-available/
+```
+
+### Container Backup
+
+Backup Docker containers:
+
+```bash
+# Export container
+docker export <container-name> > container-backup.tar
+
+# Or commit to image
+docker commit <container-name> backup-image:latest
+```
+
+## Automation and CI/CD
+
+### Deployment Scripts
+
+Create deployment scripts:
+
+```bash
+#!/bin/bash
+# deploy.sh
+
+set -e
+
+echo "Deploying services..."
+
+# Run tests
+npm test
+
+# Deploy
+suthep deploy
+
+echo "Deployment complete!"
+```
+
+### CI/CD Integration
+
+Example GitHub Actions workflow:
+
+```yaml
+name: Deploy
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - run: npm install -g suthep
+      - run: suthep deploy
+        env:
+          SSH_KEY: ${{ secrets.SSH_KEY }}
+```
+
+## Advanced Docker Usage
+
+### Multi-Stage Builds
+
+Use multi-stage builds for optimized images:
+
+```dockerfile
+# Build stage
+FROM node:16 AS builder
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+RUN npm run build
+
+# Production stage
+FROM node:16-alpine
+WORKDIR /app
+COPY --from=builder /app/dist ./dist
+COPY --from=builder /app/node_modules ./node_modules
+CMD ["node", "dist/index.js"]
+```
+
+### Docker Compose Integration
+
+Use Docker Compose alongside Suthep:
+
+```yaml
+# docker-compose.yml
+version: '3'
+services:
+  database:
+    image: postgres:14
+    # ... database config
+```
+
+Then connect Suthep to the container:
+
+```yaml
+services:
+  - name: api
+    docker:
+      container: myapp_database_1  # From docker-compose
+      port: 5432
+```
+
+## Troubleshooting Advanced Issues
+
+### Performance Debugging
+
+Identify performance bottlenecks:
+
+```bash
+# Monitor Nginx performance
+sudo nginx -V  # Check compiled modules
+sudo nginx -T  # Test and show full config
+
+# Monitor system resources
+htop
+iostat
+```
+
+### Network Debugging
+
+Debug network issues:
+
+```bash
+# Check port binding
+sudo netstat -tulpn | grep 3000
+
+# Test connectivity
+curl -v http://localhost:3000
+
+# Check DNS
+dig example.com
+nslookup example.com
+```
+
+### Container Debugging
+
+Debug container issues:
+
+```bash
+# Inspect container
+docker inspect <container-name>
+
+# Execute commands in container
+docker exec -it <container-name> /bin/sh
+
+# Check container network
+docker network ls
+docker network inspect bridge
+```
+
+## Best Practices Summary
+
+1. **Use Version Control** - Track configuration changes
+2. **Test in Staging** - Always test before production
+3. **Monitor Health Checks** - Set appropriate intervals
+4. **Backup Configurations** - Regular backups
+5. **Secure Access** - Use HTTPS, configure firewalls
+6. **Optimize Resources** - Monitor and optimize usage
+7. **Document Changes** - Keep deployment logs
+8. **Automate Deployments** - Use CI/CD pipelines
+
+## Next Steps
+
+- Review [Examples](./06-examples.md) for practical use cases
+- Check [Troubleshooting](./07-troubleshooting.md) for common issues
+- Refer to [Configuration Guide](./04-configuration.md) for all options
+
+---
+
+**Previous:** [Troubleshooting](./07-troubleshooting.md) | **Back to:** [README](./README.md)
+

package/docs/english/README.md

@@ -0,0 +1,48 @@
+# Suthep User Guide
+
+Welcome to the Suthep user guide! This comprehensive guide will help you understand and use Suthep to deploy your projects with ease.
+
+## Table of Contents
+
+1. [Introduction](./01-introduction.md)
+2. [Installation](./02-installation.md)
+3. [Quick Start](./03-quick-start.md)
+4. [Configuration Guide](./04-configuration.md)
+5. [Commands Reference](./05-commands.md)
+6. [Examples](./06-examples.md)
+7. [Troubleshooting](./07-troubleshooting.md)
+8. [Advanced Topics](./08-advanced.md)
+
+## What is Suthep?
+
+Suthep is a powerful CLI tool for deploying projects with automatic Nginx reverse proxy setup, HTTPS with Certbot, and zero-downtime deployments. It simplifies the deployment process by automating complex infrastructure tasks.
+
+## Key Features
+
+- ✅ **Automatic Nginx Reverse Proxy** - Configures Nginx automatically for your services
+- ✅ **Automatic HTTPS** - Sets up SSL/TLS certificates with Let's Encrypt via Certbot
+- ✅ **Zero-Downtime Deployment** - Rolling deployment strategy ensures continuous availability
+- ✅ **Docker Support** - Deploy Docker containers or connect to existing containers
+- ✅ **Multiple Domains** - Support for multiple domains and subdomains per service
+- ✅ **Health Checks** - Built-in health check monitoring for service reliability
+- ✅ **YAML Configuration** - Simple, declarative configuration file format
+
+## Quick Navigation
+
+- **New to Suthep?** Start with [Introduction](./01-introduction.md) and [Quick Start](./03-quick-start.md)
+- **Need help with configuration?** Check [Configuration Guide](./04-configuration.md)
+- **Looking for examples?** See [Examples](./06-examples.md)
+- **Having issues?** Visit [Troubleshooting](./07-troubleshooting.md)
+
+## Getting Help
+
+If you encounter any issues or have questions:
+
+1. Check the [Troubleshooting](./07-troubleshooting.md) section
+2. Review the [Examples](./06-examples.md) for common use cases
+3. Consult the [Commands Reference](./05-commands.md) for detailed command documentation
+
+---
+
+**Next:** [Introduction →](./01-introduction.md)
+

package/docs/thai/01-introduction.md

@@ -0,0 +1,84 @@
+# บทนำ Suthep
+
+## Suthep คืออะไร?
+
+Suthep เป็นเครื่องมือ command-line ที่ออกแบบมาเพื่อทำให้การ deploy เว็บแอปพลิเคชันและบริการง่ายขึ้น มันทำให้กระบวนการที่ซับซ้อนของการตั้งค่า reverse proxy, ใบรับรอง SSL, และการจัดการการ deploy แบบ zero downtime เป็นอัตโนมัติ
+
+## ทำไมต้องใช้ Suthep?
+
+### การ Deploy ที่เรียบง่าย
+
+กระบวนการ deploy แบบดั้งเดิมต้องตั้งค่าด้วยตนเอง:
+- กฎ Nginx reverse proxy
+- การจัดการใบรับรอง SSL
+- การจัดการ Docker container orchestration
+- การตรวจสอบ health check
+- กลยุทธ์การ deploy แบบ zero-downtime
+
+Suthep จัดการทั้งหมดนี้ให้อัตโนมัติด้วยไฟล์การตั้งค่า YAML ที่เรียบง่าย
+
+### ประโยชน์หลัก
+
+1. **ประหยัดเวลา** - Deploy ในไม่กี่นาทีแทนที่จะเป็นชั่วโมง
+2. **ลดข้อผิดพลาด** - การตั้งค่าอัตโนมัติลดข้อผิดพลาดของมนุษย์
+3. **Zero Downtime** - การ deploy แบบ rolling ทำให้บริการพร้อมใช้งานอย่างต่อเนื่อง
+4. **จัดการง่าย** - คำสั่งง่ายๆ ในการ deploy, อัปเดต, และจัดการบริการ
+5. **ประหยัดต้นทุน** - รันหลายบริการบนเซิร์ฟเวอร์เดียวอย่างมีประสิทธิภาพ
+
+## วิธีการทำงาน
+
+Suthep ทำงานตามขั้นตอนง่ายๆ:
+
+1. **ตั้งค่า** - สร้างไฟล์การตั้งค่า `suthep.yml`
+2. **Setup** - ติดตั้งสิ่งที่จำเป็น (Nginx, Certbot) ด้วย `suthep setup`
+3. **Deploy** - Deploy บริการของคุณด้วย `suthep deploy`
+
+เบื้องหลัง Suthep:
+- สร้างไฟล์การตั้งค่า Nginx
+- รับใบรับรอง SSL จาก Let's Encrypt
+- จัดการ Docker containers
+- ทำ health checks
+- จัดการการ deploy แบบ zero-downtime
+
+## กรณีการใช้งาน
+
+Suthep เหมาะสำหรับ:
+
+- **แอปพลิเคชันขนาดเล็กถึงกลาง** - Deploy หลายบริการบนเซิร์ฟเวอร์เดียว
+- **Microservices** - จัดการหลายบริการที่มีโดเมนต่างกัน
+- **แอปพลิเคชัน Docker** - Deploy แอปพลิเคชันที่ใช้ container ได้ง่าย
+- **บริการ API** - ตั้งค่า reverse proxy สำหรับ API endpoints
+- **เว็บแอปพลิเคชัน** - Deploy เว็บแอปพร้อม HTTPS อัตโนมัติ
+
+## สิ่งที่คุณจะได้เรียนรู้
+
+ในคู่มือนี้ คุณจะได้เรียนรู้:
+
+- วิธีการติดตั้งและตั้งค่า Suthep
+- วิธีการสร้างและตั้งค่าไฟล์ deployment
+- วิธีการใช้คำสั่งทั้งหมดที่มี
+- วิธีการ deploy ประเภทบริการต่างๆ
+- วิธีการแก้ปัญหาที่พบบ่อย
+- ตัวเลือกการตั้งค่าขั้นสูง
+
+## สิ่งที่ต้องมีก่อนเริ่ม
+
+ก่อนใช้ Suthep คุณควรมี:
+
+- **Node.js 16+** ติดตั้งแล้ว
+- **sudo/administrator access** บนเซิร์ฟเวอร์ของคุณ
+- **ชื่อโดเมน** ที่ชี้ไปที่เซิร์ฟเวอร์ของคุณ (สำหรับ HTTPS)
+- **ความรู้พื้นฐาน** เกี่ยวกับไฟล์การตั้งค่า YAML
+- **Docker** (ไม่บังคับ, ใช้เฉพาะเมื่อ deploy Docker containers)
+
+## ขั้นตอนถัดไป
+
+พร้อมเริ่มต้นแล้วหรือยัง? ไปต่อที่:
+
+- [คู่มือการติดตั้ง](./02-installation.md) - ติดตั้ง Suthep บนระบบของคุณ
+- [คู่มือเริ่มต้นใช้งาน](./03-quick-start.md) - Deploy บริการแรกของคุณ
+
+---
+
+**ก่อนหน้า:** [README](./README.md) | **ถัดไป:** [การติดตั้ง →](./02-installation.md)
+