suthep 0.1.0-beta.1

package/docs/th/README.md

@@ -0,0 +1,64 @@
+# เอกสารประกอบ Suthep
+
+ยินดีต้อนรับสู่เอกสารประกอบ Suthep! คู่มือนี้จะช่วยให้คุณเข้าใจและใช้งาน Suthep ซึ่งเป็นเครื่องมือ CLI ที่ทรงพลังสำหรับการ deploy โปรเจกต์พร้อมการตั้งค่า Nginx reverse proxy อัตโนมัติ, HTTPS ด้วย Certbot, และการ deploy แบบ zero-downtime
+
+## สารบัญ
+
+### เอกสารสำหรับผู้ใช้
+
+1. [เริ่มต้นใช้งาน](./getting-started.md) - คู่มือการติดตั้งและเริ่มต้นใช้งาน
+2. [คู่มือการตั้งค่า](./configuration.md) - คู่มืออ้างอิงไฟล์ configuration ฉบับสมบูรณ์
+3. [คู่มือคำสั่ง](./commands.md) - เอกสารคำสั่งแบบละเอียด
+
+### เอกสารสำหรับนักพัฒนา
+
+4. [คู่มือนักพัฒนา](../en/developer-guide.md) - คู่มือฉบับสมบูรณ์สำหรับนักพัฒนาและผู้มีส่วนร่วม *(English)*
+5. [สถาปัตยกรรม](../en/architecture.md) - วิธีการทำงานของ Suthep *(English)*
+6. [อ้างอิง API](../en/api-reference.md) - ฟังก์ชันและ utilities ภายใน *(English)*
+
+## Suthep คืออะไร?
+
+Suthep เป็นเครื่องมืออัตโนมัติสำหรับการ deploy ที่ทำให้กระบวนการ deploy web services ง่ายขึ้นด้วย:
+
+- ✅ **การตั้งค่า Nginx reverse proxy อัตโนมัติ** - ไม่ต้องตั้งค่า Nginx ด้วยตนเอง
+- ✅ **HTTPS อัตโนมัติด้วย Certbot** - ใบรับรอง SSL ฟรีจาก Let's Encrypt
+- ✅ **การ deploy แบบ zero-downtime** - กลยุทธ์การ deploy แบบ Rolling และ Blue-Green
+- ✅ **รองรับ Docker container** - Deploy แอปพลิเคชันที่ใช้ container ได้ง่าย
+- ✅ **รองรับหลาย domain/subdomain** - หนึ่ง service, หลาย domains
+- ✅ **Health check** - ตรวจสอบว่า services ทำงานปกติก่อนเปิดใช้งาน
+- ✅ **การตั้งค่าแบบ YAML** - การตั้งค่าที่เรียบง่ายและชัดเจน
+
+## เริ่มต้นใช้งานอย่างรวดเร็ว
+
+```bash
+# ติดตั้ง dependencies
+npm install
+npm link
+
+# เริ่มต้นการตั้งค่า
+suthep init
+
+# ติดตั้ง prerequisites
+suthep setup
+
+# Deploy services ของคุณ
+suthep deploy
+```
+
+## ความต้องการของระบบ
+
+- Node.js 16+
+- Nginx (ติดตั้งผ่าน `suthep setup`)
+- Certbot (ติดตั้งผ่าน `suthep setup`)
+- Docker (ไม่บังคับ, สำหรับ services ที่ใช้ Docker)
+- สิทธิ์ sudo (สำหรับการทำงานของ Nginx และ Certbot)
+
+## ภาษาอื่นๆ / Other Languages
+
+- [English](../en/README.md) - English documentation / เอกสารภาษาอังกฤษ
+- [ไทย](./README.md) - เอกสารภาษาไทย (ปัจจุบัน)
+- [กลับไปหน้าหลัก](../README.md) - Return to language selection
+
+## สิทธิ์การใช้งาน
+
+[MIT](../../LICENSE)

package/docs/th/commands.md

@@ -0,0 +1,202 @@
+# คู่มืออ้างอิงคำสั่ง
+
+Suthep มีคำสั่งหลักสามคำสั่งสำหรับการจัดการ deployments เอกสารนี้อธิบายแต่ละคำสั่งแบบละเอียด
+
+## `suthep init`
+
+เริ่มต้นไฟล์ configuration สำหรับการ deploy ใหม่
+
+### การใช้งาน
+
+```bash
+suthep init [options]
+```
+
+### ตัวเลือก
+
+| ตัวเลือก | ตัวย่อ | คำอธิบาย | ค่าเริ่มต้น |
+|---------|--------|----------|-----------|
+| `--file` | `-f` | Path ของไฟล์ configuration | `suthep.yml` |
+
+### คำอธิบาย
+
+คำสั่ง `init` จะสร้างไฟล์ configuration `suthep.yml` แบบ interactive โดยจะ:
+
+1. ถามชื่อโปรเจกต์และเวอร์ชัน
+2. แนะนำการตั้งค่า services หนึ่งหรือหลายตัว
+3. ถามเกี่ยวกับการตั้งค่า Docker สำหรับแต่ละ service
+4. ตั้งค่า health check endpoints
+5. ตั้งค่าอีเมล Certbot และโหมด staging
+6. บันทึก configuration ไปยังไฟล์ที่ระบุ
+
+### ตัวอย่าง
+
+```bash
+# สร้าง suthep.yml เริ่มต้น
+suthep init
+
+# สร้างไฟล์ configuration แบบกำหนดเอง
+suthep init -f production.yml
+```
+
+### คำถามแบบ Interactive
+
+คำสั่งจะถามคุณ:
+
+1. **Project name**: ชื่อโปรเจกต์ของคุณ
+2. **Project version**: หมายเลขเวอร์ชัน
+3. **Service name**: ตัวระบุเฉพาะสำหรับ service
+4. **Service port**: พอร์ตที่ service รัน (1-65535)
+5. **Domain names**: รายการ domains แยกด้วยเครื่องหมายจุลภาค
+6. **Use Docker?**: ต้องการใช้ Docker หรือไม่
+7. **Docker image**: Image ที่จะใช้ (ไม่บังคับ, สำหรับ containers ใหม่)
+8. **Container name**: ชื่อ Docker container
+9. **Container port**: พอร์ตภายใน container
+10. **Add health check?**: ต้องการตั้งค่า health checks หรือไม่
+11. **Health check path**: HTTP path สำหรับ health endpoint
+12. **Health check interval**: ช่วงเวลาการตรวจสอบ (วินาที)
+13. **Add another service?**: ต้องการตั้งค่า services เพิ่มเติมหรือไม่
+14. **Email for SSL certificates**: อีเมลสำหรับ Let's Encrypt
+15. **Use Certbot staging?**: ใช้ staging environment สำหรับการทดสอบ
+
+## `suthep setup`
+
+ตั้งค่า Nginx และ Certbot บนระบบ
+
+### การใช้งาน
+
+```bash
+suthep setup [options]
+```
+
+### ตัวเลือก
+
+| ตัวเลือก | คำอธิบาย |
+|---------|----------|
+| `--nginx-only` | ตั้งค่าเฉพาะ Nginx (ข้าม Certbot) |
+| `--certbot-only` | ตั้งค่าเฉพาะ Certbot (ข้าม Nginx) |
+
+### คำอธิบาย
+
+คำสั่ง `setup` จะติดตั้งและตั้งค่า prerequisites สำหรับ Suthep:
+
+1. **การติดตั้ง Nginx**:
+   - ตรวจสอบว่า Nginx ติดตั้งแล้วหรือยัง
+   - ติดตั้ง Nginx โดยใช้ package manager ที่เหมาะสม:
+     - `apt-get` บน Debian/Ubuntu
+     - `yum` บน RHEL/CentOS
+     - `brew` บน macOS
+   - เริ่มและเปิดใช้งาน Nginx service
+
+2. **การติดตั้ง Certbot**:
+   - ตรวจสอบว่า Certbot ติดตั้งแล้วหรือยัง
+   - ติดตั้ง Certbot และ Nginx plugin:
+     - `certbot` และ `python3-certbot-nginx` บน Linux
+     - `certbot` บน macOS ผ่าน Homebrew
+
+### ตัวอย่าง
+
+```bash
+# ตั้งค่าทั้ง Nginx และ Certbot
+suthep setup
+
+# ตั้งค่าเฉพาะ Nginx
+suthep setup --nginx-only
+
+# ตั้งค่าเฉพาะ Certbot
+suthep setup --certbot-only
+```
+
+## `suthep deploy`
+
+Deploy services ตาม configuration ที่กำหนด
+
+### การใช้งาน
+
+```bash
+suthep deploy [options]
+```
+
+### ตัวเลือก
+
+| ตัวเลือก | ตัวย่อ | คำอธิบาย | ค่าเริ่มต้น |
+|---------|--------|----------|-----------|
+| `--file` | `-f` | Path ของไฟล์ configuration | `suthep.yml` |
+| `--nginx` | | เปิดใช้งานการตั้งค่า Nginx | `true` |
+| `--no-nginx` | | ปิดการใช้งานการตั้งค่า Nginx | |
+| `--https` | | เปิดใช้งาน HTTPS และขอใบรับรอง SSL | `false` |
+| `--no-https` | | ปิดการใช้งาน HTTPS | |
+
+### คำอธิบาย
+
+คำสั่ง `deploy` จะ deploy services ทั้งหมดตาม configuration:
+
+1. **โหลด Configuration**: โหลดและตรวจสอบไฟล์ `suthep.yml`
+2. **จัดการ Docker Containers**:
+   - ตรวจสอบว่า container มีอยู่หรือไม่
+   - ลบและสร้างใหม่ถ้าจำเป็น (สำหรับการ redeploy)
+   - Pull image ล่าสุด
+   - สร้างและเริ่ม container
+3. **Deploy Services**: ใช้กลยุทธ์การ deploy ที่กำหนด
+4. **Health Checks**: ตรวจสอบว่า services ทำงานปกติ
+5. **สร้าง Nginx Configs**: สร้างไฟล์ configuration สำหรับแต่ละ domain
+6. **เปิดใช้งาน Sites**: สร้าง symbolic links ใน `sites-enabled`
+7. **ขอใบรับรอง SSL**: ขอใบรับรองจาก Let's Encrypt (ถ้าเปิดใช้งาน HTTPS)
+8. **Reload Nginx**: ทดสอบและ reload Nginx configuration
+
+### ตัวอย่าง
+
+```bash
+# Deploy พร้อม Nginx (ไม่มี HTTPS)
+suthep deploy
+
+# Deploy พร้อม HTTPS
+suthep deploy --https
+
+# Deploy โดยไม่ใช้ Nginx
+suthep deploy --no-nginx
+
+# Deploy โดยใช้ไฟล์ configuration แบบกำหนดเอง
+suthep deploy -f production.yml --https
+```
+
+### กระบวนการ Deploy
+
+คำสั่ง `deploy` จะ:
+
+1. **Group Services by Domain**: จัดกลุ่ม services ตาม domain
+2. **Deploy Each Service**:
+   - เริ่ม Docker container (ถ้าตั้งค่าไว้)
+   - Deploy service
+   - ทำ health check
+3. **Configure Nginx**:
+   - สร้าง configuration สำหรับแต่ละ domain
+   - Services หลายตัวบน domain เดียวจะใช้ไฟล์ config เดียวกัน
+   - เปิดใช้งาน site
+4. **Setup HTTPS** (ถ้าเปิดใช้งาน):
+   - ตรวจสอบว่าใบรับรองมีอยู่แล้วหรือไม่
+   - ขอใบรับรองใหม่ถ้ายังไม่มี
+   - อัปเดต Nginx configs ด้วย HTTPS
+5. **Reload Nginx**: ทดสอบและ reload configuration
+
+### ข้อความแสดงผล
+
+คำสั่งจะแสดง:
+
+- ✅ สีเขียว: การดำเนินการสำเร็จ
+- 🔄 สีเหลือง: การดำเนินการที่กำลังทำ
+- ❌ สีแดง: ข้อผิดพลาด
+- 📋 สีฟ้า: ข้อมูล
+
+### ข้อผิดพลาดที่พบบ่อย
+
+- **Port already in use**: พอร์ตถูกใช้งานโดย container อื่น
+- **Container name already in use**: ชื่อ container ถูกใช้งานแล้ว
+- **SSL certificate failed**: ไม่สามารถขอใบรับรอง SSL ได้
+- **Nginx config test failed**: การตั้งค่า Nginx ไม่ถูกต้อง
+
+## ภาษาอื่นๆ / Other Languages
+
+- [English](../en/commands.md) - English version / เวอร์ชันภาษาอังกฤษ
+- [ไทย](./commands.md) - เวอร์ชันภาษาไทย (ปัจจุบัน)
+

package/docs/th/configuration.md

@@ -0,0 +1,325 @@
+# คู่มืออ้างอิงการตั้งค่า
+
+Suthep ใช้ไฟล์ configuration แบบ YAML (ค่าเริ่มต้น: `suthep.yml`) เพื่อกำหนดการ deploy ของคุณ เอกสารนี้อธิบายตัวเลือกการตั้งค่าทั้งหมดที่มีให้
+
+## โครงสร้างไฟล์ Configuration
+
+```yaml
+project:
+  name: string
+  version: string
+
+services:
+  - name: string
+    port: number
+    domains: string[]
+    docker?: DockerConfig
+    healthCheck?: HealthCheckConfig
+    environment?: Record<string, string>
+
+nginx:
+  configPath: string
+  reloadCommand: string
+
+certbot:
+  email: string
+  staging: boolean
+
+deployment:
+  strategy: 'rolling' | 'blue-green'
+  healthCheckTimeout: number
+```
+
+## การตั้งค่าโปรเจกต์
+
+### `project.name`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: ชื่อโปรเจกต์ของคุณ
+
+```yaml
+project:
+  name: my-awesome-app
+```
+
+### `project.version`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: เวอร์ชันของโปรเจกต์ของคุณ
+
+```yaml
+project:
+  version: 1.0.0
+```
+
+## การตั้งค่า Service
+
+แต่ละ service แทนแอปพลิเคชันหรือ service ที่จะถูก deploy และเปิดเผยผ่าน Nginx
+
+### `services[].name`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: ชื่อเฉพาะสำหรับ service ใช้สำหรับไฟล์ configuration ของ Nginx และ Docker containers
+
+```yaml
+services:
+  - name: api
+```
+
+### `services[].port`
+
+- **ประเภท**: `number`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: หมายเลขพอร์ตที่ service กำลังฟัง (1-65535)
+
+```yaml
+services:
+  - name: api
+    port: 3000
+```
+
+### `services[].domains`
+
+- **ประเภท**: `string[]`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: รายการ domain names ที่ service นี้จะถูกเข้าถึง
+
+```yaml
+services:
+  - name: api
+    domains:
+      - api.example.com
+      - www.api.example.com
+```
+
+### `services[].path`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ไม่
+- **ค่าเริ่มต้น**: `/`
+- **คำอธิบาย**: Path prefix สำหรับ service นี้ (เช่น '/api', '/'). ใช้สำหรับ routing หลาย services บน domain เดียวกัน
+
+```yaml
+services:
+  - name: api
+    path: /api
+    domains:
+      - example.com
+  - name: ui
+    path: /
+    domains:
+      - example.com
+```
+
+### `services[].docker`
+
+- **ประเภท**: `DockerConfig`
+- **จำเป็น**: ไม่
+- **คำอธิบาย**: การตั้งค่า Docker สำหรับ service นี้
+
+```yaml
+services:
+  - name: api
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3000
+```
+
+#### `docker.image`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ไม่ (จำเป็นถ้าต้องการสร้าง container ใหม่)
+- **คำอธิบาย**: Docker image ที่จะใช้
+
+#### `docker.container`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: ชื่อ container
+
+#### `docker.port`
+
+- **ประเภท**: `number`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: พอร์ตภายใน container ที่แอปพลิเคชันฟัง
+
+**หมายเหตุ**: `service.port` คือพอร์ตบน host (ที่ Nginx เชื่อมต่อ) และ `docker.port` คือพอร์ตภายใน container
+
+### `services[].healthCheck`
+
+- **ประเภท**: `HealthCheckConfig`
+- **จำเป็น**: ไม่
+- **คำอธิบาย**: การตั้งค่า health check สำหรับ service
+
+```yaml
+services:
+  - name: api
+    healthCheck:
+      path: /health
+      interval: 30
+```
+
+#### `healthCheck.path`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: Path ของ health check endpoint
+
+#### `healthCheck.interval`
+
+- **ประเภท**: `number`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: ช่วงเวลาระหว่าง health checks (วินาที)
+
+### `services[].environment`
+
+- **ประเภท**: `Record<string, string>`
+- **จำเป็น**: ไม่
+- **คำอธิบาย**: ตัวแปรสภาพแวดล้อมที่จะส่งไปยัง Docker container
+
+```yaml
+services:
+  - name: api
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3000
+    environment:
+      NODE_ENV: production
+      DATABASE_URL: postgresql://localhost:5432/mydb
+```
+
+## การตั้งค่า Nginx
+
+### `nginx.configPath`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: Path ไปยังไดเรกทอรีที่เก็บไฟล์ configuration ของ Nginx
+
+```yaml
+nginx:
+  configPath: /etc/nginx/sites-available
+```
+
+### `nginx.reloadCommand`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: คำสั่งสำหรับ reload Nginx configuration
+
+```yaml
+nginx:
+  reloadCommand: sudo nginx -t && sudo systemctl reload nginx
+```
+
+## การตั้งค่า Certbot
+
+### `certbot.email`
+
+- **ประเภท**: `string`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: อีเมลที่ใช้สำหรับการลงทะเบียนกับ Let's Encrypt
+
+```yaml
+certbot:
+  email: admin@example.com
+```
+
+### `certbot.staging`
+
+- **ประเภท**: `boolean`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: ใช้ staging environment ของ Let's Encrypt (แนะนำสำหรับการทดสอบ)
+
+```yaml
+certbot:
+  staging: false
+```
+
+## การตั้งค่า Deployment
+
+### `deployment.strategy`
+
+- **ประเภท**: `'rolling' | 'blue-green'`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: กลยุทธ์การ deploy ที่จะใช้
+
+```yaml
+deployment:
+  strategy: rolling
+```
+
+- **`rolling`**: แทนที่ instances เก่าด้วยใหม่ทีละน้อย
+- **`blue-green`**: รักษาสภาพแวดล้อมสองชุดและสลับระหว่างกัน
+
+### `deployment.healthCheckTimeout`
+
+- **ประเภท**: `number`
+- **จำเป็น**: ใช่
+- **คำอธิบาย**: เวลาสูงสุดในการรอ health check (มิลลิวินาที)
+
+```yaml
+deployment:
+  healthCheckTimeout: 30000
+```
+
+## ตัวอย่างการตั้งค่าที่สมบูรณ์
+
+```yaml
+project:
+  name: my-awesome-app
+  version: 1.0.0
+
+services:
+  - name: api
+    port: 3001
+    path: /api
+    domains:
+      - api.example.com
+    docker:
+      image: myapp/api:latest
+      container: api-container
+      port: 3001
+    healthCheck:
+      path: /health
+      interval: 30
+    environment:
+      NODE_ENV: production
+
+  - name: ui
+    port: 3000
+    path: /
+    domains:
+      - example.com
+      - www.example.com
+    docker:
+      image: myapp/ui:latest
+      container: ui-container
+      port: 80
+    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
+```
+
+## ภาษาอื่นๆ / Other Languages
+
+- [English](../en/configuration.md) - English version / เวอร์ชันภาษาอังกฤษ
+- [ไทย](./configuration.md) - เวอร์ชันภาษาไทย (ปัจจุบัน)
+