suthep 0.1.0-beta.1

package/docs/th/getting-started.md

@@ -0,0 +1,203 @@
+# เริ่มต้นใช้งาน Suthep
+
+คู่มือนี้จะแนะนำคุณในการติดตั้ง Suthep และ deploy service แรกของคุณ
+
+## การติดตั้ง
+
+### ความต้องการเบื้องต้น
+
+ก่อนติดตั้ง Suthep ตรวจสอบว่าคุณมี:
+
+- **Node.js 16+** - [ดาวน์โหลด Node.js](https://nodejs.org/)
+- **สิทธิ์ sudo** - จำเป็นสำหรับการทำงานของ Nginx และ Certbot
+- **Docker** (ไม่บังคับ) - จำเป็นเฉพาะเมื่อ deploy Docker containers
+
+### ติดตั้ง Suthep
+
+1. Clone หรือดาวน์โหลด repository ของ Suthep:
+   ```bash
+   git clone <repository-url>
+   cd suthep
+   ```
+
+2. ติดตั้ง dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Link CLI tool แบบ global:
+   ```bash
+   npm link
+   ```
+
+   สิ่งนี้ทำให้คำสั่ง `suthep` ใช้งานได้ทั่วทั้งระบบของคุณ
+
+4. ตรวจสอบการติดตั้ง:
+   ```bash
+   suthep --version
+   ```
+
+## คู่มือเริ่มต้นใช้งานอย่างรวดเร็ว
+
+### ขั้นตอนที่ 1: เริ่มต้นการตั้งค่า
+
+สร้างไฟล์ configuration สำหรับโปรเจกต์ของคุณ:
+
+```bash
+suthep init
+```
+
+คำสั่งแบบ interactive นี้จะ:
+- ถามชื่อโปรเจกต์และเวอร์ชัน
+- แนะนำการตั้งค่า services
+- ตั้งค่า domain names
+- ตั้งค่า Docker (ถ้าจำเป็น)
+- ตั้งค่า health checks
+- ตั้งค่าอีเมล Certbot
+
+หรือคุณสามารถคัดลอกไฟล์ configuration ตัวอย่าง:
+
+```bash
+cp suthep.example.yml suthep.yml
+# แก้ไข suthep.yml ด้วยการตั้งค่าของคุณ
+```
+
+### ขั้นตอนที่ 2: ติดตั้ง Prerequisites
+
+ติดตั้งและตั้งค่า Nginx และ Certbot:
+
+```bash
+suthep setup
+```
+
+คำสั่งนี้จะ:
+- ติดตั้ง Nginx (ถ้ายังไม่ได้ติดตั้ง)
+- ติดตั้ง Certbot (ถ้ายังไม่ได้ติดตั้ง)
+- เริ่มและเปิดใช้งาน Nginx service
+
+คุณยังสามารถติดตั้งแยกกันได้:
+
+```bash
+suthep setup --nginx-only    # ติดตั้งเฉพาะ Nginx
+suthep setup --certbot-only  # ติดตั้งเฉพาะ Certbot
+```
+
+### ขั้นตอนที่ 3: Deploy Services ของคุณ
+
+Deploy โปรเจกต์ของคุณ:
+
+```bash
+suthep deploy
+```
+
+สิ่งนี้จะ:
+1. โหลด configuration จาก `suthep.yml`
+2. เริ่ม Docker containers (ถ้าตั้งค่าไว้)
+3. Deploy แต่ละ service
+4. สร้างและเปิดใช้งาน Nginx configurations
+5. ขอใบรับรอง SSL จาก Let's Encrypt
+6. Reload Nginx
+7. ทำ health checks
+
+## การ Deploy ครั้งแรกของคุณ
+
+มาลอง deploy Node.js API service ง่ายๆ:
+
+### 1. สร้าง Service ง่ายๆ
+
+สร้าง Node.js server พื้นฐาน:
+
+```javascript
+// server.js
+const http = require('http');
+
+const server = http.createServer((req, res) => {
+  if (req.url === '/health') {
+    res.writeHead(200, { 'Content-Type': 'application/json' });
+    res.end(JSON.stringify({ status: 'ok' }));
+  } else {
+    res.writeHead(200, { 'Content-Type': 'text/plain' });
+    res.end('Hello from Suthep!');
+  }
+});
+
+server.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+```
+
+### 2. สร้าง Configuration
+
+สร้าง `suthep.yml`:
+
+```yaml
+project:
+  name: my-first-app
+  version: 1.0.0
+
+services:
+  - name: api
+    port: 3000
+    domains:
+      - api.yourdomain.com
+    healthCheck:
+      path: /health
+      interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: your-email@example.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000
+```
+
+### 3. เริ่ม Service ของคุณ
+
+รัน Node.js server ของคุณ:
+
+```bash
+node server.js
+```
+
+### 4. Setup และ Deploy
+
+```bash
+# Setup Nginx และ Certbot
+suthep setup
+
+# Deploy
+suthep deploy
+```
+
+### 5. ตรวจสอบ
+
+เปิด `https://api.yourdomain.com` ในเบราว์เซอร์ของคุณ คุณควรเห็น "Hello from Suthep!" และใบรับรอง SSL ควรจะถูกต้อง
+
+## ขั้นตอนถัดไป
+
+- อ่าน [คู่มืออ้างอิงการตั้งค่า](./configuration.md) เพื่อเรียนรู้เกี่ยวกับตัวเลือกการตั้งค่าทั้งหมด
+- ดู [ตัวอย่าง](../en/examples.md) สำหรับสถานการณ์การ deploy ที่ซับซ้อนมากขึ้น *(English)*
+- ตรวจสอบ [คู่มืออ้างอิงคำสั่ง](./commands.md) สำหรับเอกสารคำสั่งแบบละเอียด
+
+## ปัญหาที่พบบ่อย
+
+หากคุณพบปัญหาระหว่างการตั้งค่า:
+
+1. **Permission denied**: ตรวจสอบว่าคุณมีสิทธิ์ sudo
+2. **Nginx not found**: รัน `suthep setup` เพื่อติดตั้ง
+3. **Domain not resolving**: ตรวจสอบว่า DNS ของ domain ชี้ไปที่ IP ของ server ของคุณ
+4. **SSL certificate failed**: ตรวจสอบว่า domain ของคุณเข้าถึงได้จากสาธารณะและพอร์ต 80 เปิดอยู่
+
+สำหรับความช่วยเหลือในการแก้ไขปัญหามากขึ้น ดู [คู่มือแก้ไขปัญหา](../en/troubleshooting.md) *(English)*
+
+## ภาษาอื่นๆ / Other Languages
+
+- [English](../en/getting-started.md) - English version / เวอร์ชันภาษาอังกฤษ
+- [ไทย](./getting-started.md) - เวอร์ชันภาษาไทย (ปัจจุบัน)
+

package/example/README.md

@@ -0,0 +1,85 @@
+# Local Docker Setup
+
+This directory contains configuration files for running services locally with Docker.
+
+## Files
+
+- `example.yml` - Suthep deployment configuration
+- `docker-compose.yml` - Docker Compose configuration for local development
+
+## Quick Start
+
+To run the services locally with Docker Compose:
+
+```bash
+# Start all services
+docker-compose up -d
+
+# View logs
+docker-compose logs -f
+
+# Stop all services
+docker-compose down
+
+# Stop and remove volumes
+docker-compose down -v
+```
+
+## Services
+
+Based on `example.yml`, this Docker Compose file includes:
+
+1. **webapp** (port 8080)
+   - Image: `nginx:latest`
+   - Container: `webapp-container`
+   - Maps to container port 80
+
+2. **dashboard** (port 5000)
+   - Image: `myapp/dashboard:latest` (you may need to build this)
+   - Container: `dashboard-container`
+   - Environment variables: `DATABASE_URL`, `REDIS_URL`
+
+3. **postgres** (port 5432)
+   - Image: `postgres:latest`
+   - Container: `postgres-container`
+   - Database: `dashboard`
+   - Default credentials: `postgres/postgres`
+
+4. **redis** (port 6379)
+   - Image: `redis:latest`
+   - Container: `redis-container`
+
+## Notes
+
+- The **api** service from `example.yml` is not included here as it's a Node.js service (not Docker-based)
+- All services are connected via a Docker network named `suthep-network`
+- The dashboard service depends on postgres and redis, so they will start in order
+- PostgreSQL data is persisted in a Docker volume
+
+## Building Custom Images
+
+If you need to build the dashboard image:
+
+```bash
+# Build the dashboard image
+docker build -t myapp/dashboard:latest ./path-to-dashboard
+
+# Or update the docker-compose.yml to build from source:
+# dashboard:
+#   build: ./path-to-dashboard
+#   ...
+```
+
+## Accessing Services
+
+Once running, services are available at:
+
+- Webapp: http://localhost:8080
+- Dashboard: http://localhost:5000
+- PostgreSQL: localhost:5432
+- Redis: localhost:6379
+
+
+
+
+

package/example/docker-compose.yml

@@ -0,0 +1,76 @@
+version: "3.8"
+
+services:
+  # Example 2: Docker container service from example.yml
+  webapp:
+    image: nginx:latest
+    container_name: webapp-container
+    ports:
+      - "8080:80"
+    networks:
+      - suthep-network
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost/"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+    restart: unless-stopped
+
+  # Example 3: Multiple subdomains with Docker from example.yml
+  dashboard:
+    image: myapp/dashboard:latest
+    container_name: dashboard-container
+    ports:
+      - "5000:5000"
+    networks:
+      - suthep-network
+    environment:
+      DATABASE_URL: postgresql://postgres:5432/dashboard
+      REDIS_URL: redis://redis:6379
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:5000/api/health"]
+      interval: 60s
+      timeout: 10s
+      retries: 3
+    depends_on:
+      - postgres
+      - redis
+    restart: unless-stopped
+
+  # Database service for database-proxy example
+  postgres:
+    image: postgres:latest
+    container_name: postgres-container
+    ports:
+      - "5432:5432"
+    networks:
+      - suthep-network
+    environment:
+      POSTGRES_DB: dashboard
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    restart: unless-stopped
+
+  # Redis service for dashboard
+  redis:
+    image: redis:latest
+    container_name: redis-container
+    ports:
+      - "6379:6379"
+    networks:
+      - suthep-network
+    restart: unless-stopped
+
+networks:
+  suthep-network:
+    driver: bridge
+
+volumes:
+  postgres-data:
+
+
+
+
+

package/example/docker-ports-example.yml

@@ -0,0 +1,81 @@
+project:
+  name: docker-ports-example
+  version: 1.0.0
+
+services:
+  # Example 1: Same port on host and container (3000:3000)
+  - name: api-same-port
+    port: 3000              # Host port: 3000
+    domains:
+      - api1.example.com
+    docker:
+      image: myapp/api:latest
+      container: api-same-port-container
+      port: 3000            # Container port: 3000
+    healthCheck:
+      path: /health
+      interval: 30
+
+  # Example 2: Different host and container ports (3002:3000)
+  - name: api-different-port
+    port: 3002              # Host port: 3002 (external access)
+    domains:
+      - api2.example.com
+    docker:
+      image: myapp/api:latest
+      container: api-different-port-container
+      port: 3000            # Container port: 3000 (app listens here inside)
+    healthCheck:
+      path: /health
+      interval: 30
+
+  # Example 3: Nginx with port mapping (8080:80)
+  - name: web
+    port: 8080              # Host port: 8080
+    domains:
+      - web.example.com
+    docker:
+      image: nginx:alpine
+      container: web-container
+      port: 80              # Container port: 80 (Nginx listens on 80)
+    healthCheck:
+      path: /
+      interval: 30
+
+  # Example 4: Multiple services with different ports
+  - name: service-a
+    port: 4000              # Host: 4000
+    domains:
+      - service-a.example.com
+    docker:
+      image: myapp/service-a:latest
+      container: service-a-container
+      port: 3000            # Container: 3000
+    healthCheck:
+      path: /health
+      interval: 30
+
+  - name: service-b
+    port: 4001              # Host: 4001
+    domains:
+      - service-b.example.com
+    docker:
+      image: myapp/service-b:latest
+      container: service-b-container
+      port: 3000            # Container: 3000 (can be same, containers are isolated)
+    healthCheck:
+      path: /health
+      interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@example.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000
+

package/example/muacle.yml

@@ -0,0 +1,47 @@
+project:
+  name: muacle-app
+  version: 1.0.0
+
+services:
+  # API service on /api path
+  - name: api
+    port: 3001
+    path: /api
+    domains:
+      - muacle.com
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3001
+    healthCheck:
+      path: /health
+      interval: 30
+    environment:
+      NODE_ENV: production
+
+  # UI service on root path
+  - name: ui
+    port: 3000
+    path: /
+    domains:
+      - muacle.com
+    docker:
+      image: myapp/ui:latest
+      container: ui-container
+      port: 3000
+    healthCheck:
+      path: /
+      interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@muacle.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000
+

package/example/port-binding-example.yml

@@ -0,0 +1,45 @@
+project:
+  name: port-binding-example
+  version: 1.0.0
+
+services:
+  # Example: Bind host port 3002 to container port 3000
+  - name: api
+    port: 3002              # Host port: accessible at localhost:3002
+    path: /api
+    domains:
+      - api.example.com
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3000            # Container port: app listens on 3000 inside container
+    healthCheck:
+      path: /health
+      interval: 30
+
+  # Example: Same port on both host and container
+  - name: web
+    port: 8080              # Host port: 8080
+    path: /
+    domains:
+      - example.com
+    docker:
+      image: nginx:alpine
+      container: web-container
+      port: 80              # Container port: Nginx listens on 80 inside container
+    healthCheck:
+      path: /
+      interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@example.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000
+

package/example/suthep.yml

@@ -0,0 +1,46 @@
+project:
+  name: muacle-app
+  version: 1.0.0
+
+services:
+  # API service on /api path
+  - name: api
+    port: 3001
+    path: /api
+    domains:
+      - muacle.com
+    docker:
+      image: api:latest
+      container: api-container
+      port: 3001
+    # healthCheck:
+    #   path: /health
+    #   interval: 30
+    environment:
+      NODE_ENV: production
+
+  # UI service on root path
+  - name: ui
+    port: 3002
+    path: /
+    domains:
+      - muacle.com
+    docker:
+      image: frontend-api:latest
+      container: ui-container
+      port: 3000
+    # healthCheck:
+    #   path: /
+    #   interval: 30
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@muacle.com
+  staging: false
+
+deployment:
+  strategy: rolling
+  healthCheckTimeout: 30000

package/example/suthep=1.yml

@@ -0,0 +1,46 @@
+project:
+  name: my-app
+  version: 1.0.0
+
+services:
+  # Example 1: Simple Node.js service
+  - name: api
+    port: 3001
+    docker:
+      image: muacle-api:latest
+      container: api
+      port: 3000
+    domains:
+      - x.muacle.com
+    healthCheck:
+      path: /api/v1/health
+      interval: 30
+    environment:
+      NODE_ENV: production
+      PORT: 3001
+
+  # Example 2: Docker container service
+  - name: webapp
+    port: 3000
+    docker:
+      image: muacle-frontend:latest
+      container: frontend
+      port: 3000
+    domains:
+      - x.muacle.com
+    healthCheck:
+      path: /
+      interval: 30
+
+
+nginx:
+  configPath: /etc/nginx/sites-available
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+
+certbot:
+  email: admin@example.com
+  staging: false  # Set to true for testing
+
+deployment:
+  strategy: rolling  # Options: rolling, blue-green
+  healthCheckTimeout: 30000  # milliseconds

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "suthep",
+  "version": "0.1.0-beta.1",
+  "type": "module",
+  "description": "CLI tool for deploying projects with automatic Nginx reverse proxy and HTTPS setup",
+  "main": "dist/index.js",
+  "bin": {
+    "suthep": "dist/index.js"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "test": "npm run build && node dist/index.js --help",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "deploy",
+    "nginx",
+    "certbot",
+    "docker",
+    "cli"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.2",
+    "inquirer": "^13.0.2",
+    "js-yaml": "^4.1.1",
+    "vite": "^7.2.7"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.9",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^24.10.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}