suthep 0.1.0 → 0.2.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/README.md +172 -71
  2. package/dist/commands/deploy.js +251 -37
  3. package/dist/commands/deploy.js.map +1 -1
  4. package/dist/commands/down.js +179 -0
  5. package/dist/commands/down.js.map +1 -0
  6. package/dist/commands/redeploy.js +59 -0
  7. package/dist/commands/redeploy.js.map +1 -0
  8. package/dist/commands/up.js +213 -0
  9. package/dist/commands/up.js.map +1 -0
  10. package/dist/index.js +36 -1
  11. package/dist/index.js.map +1 -1
  12. package/dist/utils/certbot.js +40 -3
  13. package/dist/utils/certbot.js.map +1 -1
  14. package/dist/utils/config-loader.js +30 -0
  15. package/dist/utils/config-loader.js.map +1 -1
  16. package/dist/utils/deployment.js +49 -16
  17. package/dist/utils/deployment.js.map +1 -1
  18. package/dist/utils/docker.js +396 -25
  19. package/dist/utils/docker.js.map +1 -1
  20. package/dist/utils/nginx.js +167 -8
  21. package/dist/utils/nginx.js.map +1 -1
  22. package/docs/README.md +25 -49
  23. package/docs/english/01-introduction.md +84 -0
  24. package/docs/english/02-installation.md +200 -0
  25. package/docs/english/03-quick-start.md +256 -0
  26. package/docs/english/04-configuration.md +358 -0
  27. package/docs/english/05-commands.md +363 -0
  28. package/docs/english/06-examples.md +456 -0
  29. package/docs/english/07-troubleshooting.md +417 -0
  30. package/docs/english/08-advanced.md +411 -0
  31. package/docs/english/README.md +48 -0
  32. package/docs/thai/01-introduction.md +84 -0
  33. package/docs/thai/02-installation.md +200 -0
  34. package/docs/thai/03-quick-start.md +256 -0
  35. package/docs/thai/04-configuration.md +358 -0
  36. package/docs/thai/05-commands.md +363 -0
  37. package/docs/thai/06-examples.md +456 -0
  38. package/docs/thai/07-troubleshooting.md +417 -0
  39. package/docs/thai/08-advanced.md +411 -0
  40. package/docs/thai/README.md +48 -0
  41. package/example/README.md +286 -53
  42. package/example/suthep-complete.yml +103 -0
  43. package/example/suthep-docker-only.yml +71 -0
  44. package/example/suthep-no-docker.yml +51 -0
  45. package/example/suthep-path-routing.yml +62 -0
  46. package/example/suthep.example.yml +89 -0
  47. package/package.json +1 -1
  48. package/src/commands/deploy.ts +322 -50
  49. package/src/commands/down.ts +240 -0
  50. package/src/commands/redeploy.ts +78 -0
  51. package/src/commands/up.ts +271 -0
  52. package/src/index.ts +62 -1
  53. package/src/types/config.ts +25 -24
  54. package/src/utils/certbot.ts +68 -6
  55. package/src/utils/config-loader.ts +40 -0
  56. package/src/utils/deployment.ts +61 -36
  57. package/src/utils/docker.ts +634 -30
  58. package/src/utils/nginx.ts +187 -4
  59. package/suthep-0.1.0-beta.1.tgz +0 -0
  60. package/suthep-0.1.1.tgz +0 -0
  61. package/suthep.example.yml +34 -0
  62. package/suthep.yml +39 -0
  63. package/test +0 -0
  64. package/docs/api-reference.md +0 -545
  65. package/docs/architecture.md +0 -367
  66. package/docs/commands.md +0 -273
  67. package/docs/configuration.md +0 -347
  68. package/docs/examples.md +0 -537
  69. package/docs/getting-started.md +0 -197
  70. package/docs/troubleshooting.md +0 -441
  71. package/example/docker-compose.yml +0 -72
  72. package/example/suthep.yml +0 -31
@@ -0,0 +1,200 @@
1
+ # คู่มือการติดตั้ง
2
+
3
+ คู่มือนี้จะแนะนำคุณผ่านการติดตั้ง Suthep บนระบบของคุณ
4
+
5
+ ## ความต้องการของระบบ
6
+
7
+ ก่อนติดตั้ง Suthep ตรวจสอบว่าระบบของคุณตรงตามความต้องการเหล่านี้:
8
+
9
+ - **Node.js** เวอร์ชัน 16 หรือสูงกว่า
10
+ - **npm**, **yarn**, หรือ **pnpm** package manager
11
+ - **สิทธิ์ sudo/administrator** (จำเป็นสำหรับการตั้งค่า Nginx และ Certbot)
12
+ - **ระบบปฏิบัติการ Linux** หรือ **macOS**
13
+
14
+ ## การติดตั้ง Suthep
15
+
16
+ Suthep สามารถติดตั้งแบบ global โดยใช้ package manager ของ Node.js ใดก็ได้
17
+
18
+ ### ใช้ npm
19
+
20
+ ```bash
21
+ npm install -g suthep
22
+ ```
23
+
24
+ ### ใช้ yarn
25
+
26
+ ```bash
27
+ yarn global add suthep
28
+ ```
29
+
30
+ ### ใช้ pnpm
31
+
32
+ ```bash
33
+ pnpm add -g suthep
34
+ ```
35
+
36
+ ## ตรวจสอบการติดตั้ง
37
+
38
+ หลังจากติดตั้ง ตรวจสอบว่า Suthep ติดตั้งถูกต้อง:
39
+
40
+ ```bash
41
+ suthep --version
42
+ ```
43
+
44
+ คุณควรเห็นหมายเลขเวอร์ชัน (เช่น `0.1.0-beta.1`)
45
+
46
+ คุณยังสามารถตรวจสอบเมนูช่วยเหลือ:
47
+
48
+ ```bash
49
+ suthep --help
50
+ ```
51
+
52
+ ## การติดตั้งสิ่งที่จำเป็น
53
+
54
+ Suthep ต้องการ Nginx และ Certbot เพื่อทำงาน คุณสามารถติดตั้งสิ่งเหล่านี้โดยอัตโนมัติโดยใช้คำสั่ง `setup`:
55
+
56
+ ```bash
57
+ suthep setup
58
+ ```
59
+
60
+ คำสั่งนี้จะ:
61
+ - ติดตั้ง Nginx (หากยังไม่ได้ติดตั้ง)
62
+ - ติดตั้ง Certbot (หากยังไม่ได้ติดตั้ง)
63
+ - ตั้งค่าการพึ่งพาระบบ
64
+
65
+ ### การติดตั้งด้วยตนเอง (ไม่บังคับ)
66
+
67
+ หากคุณต้องการติดตั้งสิ่งที่จำเป็นด้วยตนเอง:
68
+
69
+ #### การติดตั้ง Nginx
70
+
71
+ **Ubuntu/Debian:**
72
+ ```bash
73
+ sudo apt-get update
74
+ sudo apt-get install -y nginx
75
+ ```
76
+
77
+ **CentOS/RHEL:**
78
+ ```bash
79
+ sudo yum install -y nginx
80
+ ```
81
+
82
+ **macOS:**
83
+ ```bash
84
+ brew install nginx
85
+ ```
86
+
87
+ #### การติดตั้ง Certbot
88
+
89
+ **Ubuntu/Debian:**
90
+ ```bash
91
+ sudo apt-get update
92
+ sudo apt-get install -y certbot python3-certbot-nginx
93
+ ```
94
+
95
+ **CentOS/RHEL:**
96
+ ```bash
97
+ sudo yum install -y certbot python3-certbot-nginx
98
+ ```
99
+
100
+ **macOS:**
101
+ ```bash
102
+ brew install certbot
103
+ ```
104
+
105
+ ## Docker (ไม่บังคับ)
106
+
107
+ หากคุณวางแผนจะ deploy Docker containers ติดตั้ง Docker:
108
+
109
+ **Ubuntu/Debian:**
110
+ ```bash
111
+ sudo apt-get update
112
+ sudo apt-get install -y docker.io
113
+ sudo systemctl start docker
114
+ sudo systemctl enable docker
115
+ ```
116
+
117
+ **macOS:**
118
+ ```bash
119
+ brew install docker
120
+ ```
121
+
122
+ หรือดาวน์โหลด Docker Desktop จาก [docker.com](https://www.docker.com/products/docker-desktop)
123
+
124
+ ## หลังการติดตั้ง
125
+
126
+ หลังจากติดตั้ง คุณพร้อมที่จะ:
127
+
128
+ 1. **เริ่มต้นการตั้งค่าแรก:**
129
+ ```bash
130
+ suthep init
131
+ ```
132
+
133
+ 2. **หรือไปต่อที่คู่มือเริ่มต้นใช้งาน:**
134
+ ดู [คู่มือเริ่มต้นใช้งาน](./03-quick-start.md)
135
+
136
+ ## การแก้ปัญหาการติดตั้ง
137
+
138
+ ### Command Not Found
139
+
140
+ หากคุณได้รับข้อผิดพลาด "command not found":
141
+
142
+ 1. **ตรวจสอบการติดตั้ง Node.js:**
143
+ ```bash
144
+ node --version
145
+ npm --version
146
+ ```
147
+
148
+ 2. **ตรวจสอบ global bin path:**
149
+ ```bash
150
+ npm config get prefix
151
+ ```
152
+
153
+ 3. **เพิ่ม npm global bin ไปที่ PATH** (หากจำเป็น):
154
+ ```bash
155
+ export PATH="$PATH:$(npm config get prefix)/bin"
156
+ ```
157
+
158
+ ### ข้อผิดพลาดสิทธิ์
159
+
160
+ หากคุณพบข้อผิดพลาดสิทธิ์:
161
+
162
+ 1. **ใช้ sudo สำหรับการติดตั้งแบบ global:**
163
+ ```bash
164
+ sudo npm install -g suthep
165
+ ```
166
+
167
+ 2. **หรือตั้งค่า npm ให้ใช้ไดเรกทอรีอื่น:**
168
+ ```bash
169
+ mkdir ~/.npm-global
170
+ npm config set prefix '~/.npm-global'
171
+ export PATH=~/.npm-global/bin:$PATH
172
+ ```
173
+
174
+ ### ปัญหาการติดตั้ง Nginx/Certbot
175
+
176
+ หาก `suthep setup` ล้มเหลว:
177
+
178
+ 1. **ตรวจสอบ package manager ของคุณ:**
179
+ - Ubuntu/Debian: ตรวจสอบว่า `apt-get` พร้อมใช้งาน
180
+ - CentOS/RHEL: ตรวจสอบว่า `yum` พร้อมใช้งาน
181
+ - macOS: ตรวจสอบว่า Homebrew ติดตั้งแล้ว
182
+
183
+ 2. **รัน setup พร้อม verbose output:**
184
+ ```bash
185
+ suthep setup --verbose
186
+ ```
187
+
188
+ 3. **ติดตั้งสิ่งที่จำเป็นด้วยตนเอง** (ดูการติดตั้งด้วยตนเองด้านบน)
189
+
190
+ ## ขั้นตอนถัดไป
191
+
192
+ ตอนนี้ Suthep ติดตั้งแล้ว:
193
+
194
+ - [คู่มือเริ่มต้นใช้งาน](./03-quick-start.md) - Deploy บริการแรกของคุณ
195
+ - [คู่มือการตั้งค่า](./04-configuration.md) - เรียนรู้เกี่ยวกับตัวเลือกการตั้งค่า
196
+
197
+ ---
198
+
199
+ **ก่อนหน้า:** [บทนำ](./01-introduction.md) | **ถัดไป:** [เริ่มต้นใช้งาน →](./03-quick-start.md)
200
+
@@ -0,0 +1,256 @@
1
+ # คู่มือเริ่มต้นใช้งาน
2
+
3
+ คู่มือนี้จะช่วยให้คุณ deploy บริการแรกของคุณด้วย Suthep ในไม่กี่นาที
4
+
5
+ ## ขั้นตอนที่ 1: เริ่มต้นการตั้งค่า
6
+
7
+ สร้างไฟล์การตั้งค่าใหม่แบบโต้ตอบ:
8
+
9
+ ```bash
10
+ suthep init
11
+ ```
12
+
13
+ คำสั่งนี้จะถามคุณเกี่ยวกับ:
14
+ - ชื่อและเวอร์ชันโปรเจกต์
15
+ - รายละเอียดบริการ (ชื่อ, พอร์ต, โดเมน)
16
+ - การตั้งค่า Docker (หากจำเป็น)
17
+ - การตั้งค่า health check
18
+ - อีเมลสำหรับใบรับรอง SSL
19
+
20
+ หรือคุณสามารถคัดลอกการตั้งค่าตัวอย่าง:
21
+
22
+ ```bash
23
+ cp suthep.example.yml suthep.yml
24
+ ```
25
+
26
+ จากนั้นแก้ไข `suthep.yml` ด้วยการตั้งค่าของคุณ
27
+
28
+ ## ขั้นตอนที่ 2: ตั้งค่าสิ่งที่จำเป็น
29
+
30
+ ติดตั้งและตั้งค่า Nginx และ Certbot:
31
+
32
+ ```bash
33
+ suthep setup
34
+ ```
35
+
36
+ สิ่งนี้จะ:
37
+ - ติดตั้ง Nginx (หากยังไม่ได้ติดตั้ง)
38
+ - ติดตั้ง Certbot (หากยังไม่ได้ติดตั้ง)
39
+ - ตั้งค่าการพึ่งพาระบบ
40
+
41
+ **หมายเหตุ:** คำสั่งนี้ต้องการสิทธิ์ sudo
42
+
43
+ ## ขั้นตอนที่ 3: Deploy บริการของคุณ
44
+
45
+ Deploy โปรเจกต์ของคุณ:
46
+
47
+ ```bash
48
+ suthep deploy
49
+ ```
50
+
51
+ คำสั่งนี้จะ:
52
+ 1. ตั้งค่า Nginx reverse proxy สำหรับบริการทั้งหมด
53
+ 2. รับใบรับรอง SSL ผ่าน Certbot (หากเปิดใช้งาน)
54
+ 3. Deploy บริการด้วยกลยุทธ์ zero-downtime
55
+
56
+ ## ตัวอย่าง: Deploy API แบบง่าย
57
+
58
+ มาดูการ deploy บริการ API Node.js:
59
+
60
+ ### 1. สร้างการตั้งค่า
61
+
62
+ สร้าง `suthep.yml`:
63
+
64
+ ```yaml
65
+ project:
66
+ name: my-api
67
+ version: 1.0.0
68
+
69
+ services:
70
+ - name: api
71
+ port: 3000
72
+ domains:
73
+ - api.example.com
74
+ healthCheck:
75
+ path: /health
76
+ interval: 30
77
+ environment:
78
+ NODE_ENV: production
79
+
80
+ nginx:
81
+ configPath: /etc/nginx/sites-available
82
+ reloadCommand: sudo nginx -t && sudo systemctl reload nginx
83
+
84
+ certbot:
85
+ email: admin@example.com
86
+ staging: false
87
+
88
+ deployment:
89
+ strategy: rolling
90
+ healthCheckTimeout: 30000
91
+ ```
92
+
93
+ ### 2. ตั้งค่าสิ่งที่จำเป็น
94
+
95
+ ```bash
96
+ suthep setup
97
+ ```
98
+
99
+ ### 3. Deploy
100
+
101
+ ```bash
102
+ suthep deploy
103
+ ```
104
+
105
+ ### 4. ตรวจสอบการ Deploy
106
+
107
+ หลังจาก deploy Suthep จะแสดง URL บริการ:
108
+
109
+ ```
110
+ 📋 Service URLs:
111
+ api: https://api.example.com
112
+ ```
113
+
114
+ เยี่ยมชม URL ในเบราว์เซอร์ของคุณเพื่อตรวจสอบว่าบริการทำงานอยู่
115
+
116
+ ## ตัวอย่าง: Deploy Docker Container
117
+
118
+ เพื่อ deploy Docker container:
119
+
120
+ ```yaml
121
+ services:
122
+ - name: webapp
123
+ port: 8080
124
+ docker:
125
+ image: nginx:latest
126
+ container: webapp-container
127
+ port: 80
128
+ domains:
129
+ - example.com
130
+ - www.example.com
131
+ ```
132
+
133
+ จากนั้นรัน:
134
+
135
+ ```bash
136
+ suthep deploy
137
+ ```
138
+
139
+ ## คำสั่งทั่วไป
140
+
141
+ ### ตรวจสอบสถานะบริการ
142
+
143
+ ```bash
144
+ # ดูการตั้งค่า Nginx
145
+ sudo nginx -t
146
+
147
+ # ตรวจสอบ containers ที่กำลังรัน
148
+ docker ps
149
+
150
+ # ดู logs บริการ
151
+ docker logs <container-name>
152
+ ```
153
+
154
+ ### อัปเดตการตั้งค่า
155
+
156
+ 1. แก้ไข `suthep.yml`
157
+ 2. Redeploy:
158
+ ```bash
159
+ suthep redeploy
160
+ ```
161
+
162
+ ### หยุดบริการ
163
+
164
+ ```bash
165
+ # หยุดบริการเฉพาะ
166
+ suthep down <service-name>
167
+
168
+ # หยุดบริการทั้งหมด
169
+ suthep down --all
170
+ ```
171
+
172
+ ### เริ่มบริการ
173
+
174
+ ```bash
175
+ # เริ่มบริการเฉพาะ
176
+ suthep up <service-name>
177
+
178
+ # เริ่มบริการทั้งหมด
179
+ suthep up --all
180
+ ```
181
+
182
+ ## สิ่งที่เกิดขึ้นระหว่างการ Deploy?
183
+
184
+ เมื่อคุณรัน `suthep deploy`, Suthep จะ:
185
+
186
+ 1. **โหลดการตั้งค่า** - อ่านไฟล์ `suthep.yml` ของคุณ
187
+ 2. **เริ่ม Docker Containers** - หากตั้งค่า Docker แล้ว จะเริ่ม containers
188
+ 3. **ตั้งค่า Nginx** - สร้างและเขียนไฟล์การตั้งค่า Nginx
189
+ 4. **เปิดใช้งาน Sites** - สร้าง symlinks เพื่อเปิดใช้งาน Nginx sites
190
+ 5. **รับใบรับรอง SSL** - ขอใบรับรองจาก Let's Encrypt
191
+ 6. **อัปเดต Nginx สำหรับ HTTPS** - เพิ่มการตั้งค่า SSL ไปที่ Nginx
192
+ 7. **Reload Nginx** - ใช้การเปลี่ยนแปลงทั้งหมด
193
+ 8. **ทำ Health Checks** - ตรวจสอบว่าบริการทำงานถูกต้อง
194
+
195
+ ## การแก้ปัญหาเริ่มต้นใช้งาน
196
+
197
+ ### โดเมนไม่ resolve
198
+
199
+ ตรวจสอบว่าโดเมนของคุณชี้ไปที่เซิร์ฟเวอร์ของคุณ:
200
+
201
+ ```bash
202
+ # ตรวจสอบ DNS
203
+ nslookup api.example.com
204
+
205
+ # ตรวจสอบว่า IP เซิร์ฟเวอร์ตรงกัน
206
+ curl -I http://api.example.com
207
+ ```
208
+
209
+ ### พอร์ตถูกใช้งานอยู่แล้ว
210
+
211
+ หากคุณได้รับข้อผิดพลาด "port already in use":
212
+
213
+ 1. **ค้นหาสิ่งที่ใช้พอร์ต:**
214
+ ```bash
215
+ sudo lsof -i :3000
216
+ ```
217
+
218
+ 2. **หยุดบริการที่ขัดแย้ง** หรือ **เปลี่ยนพอร์ต** ใน `suthep.yml`
219
+
220
+ ### ปัญหาใบรับรอง SSL
221
+
222
+ หากการสร้างใบรับรอง SSL ล้มเหลว:
223
+
224
+ 1. **ตรวจสอบ DNS โดเมน** - ตรวจสอบว่าโดเมนชี้ไปที่เซิร์ฟเวอร์ของคุณ
225
+ 2. **ใช้โหมด staging** สำหรับการทดสอบ:
226
+ ```yaml
227
+ certbot:
228
+ staging: true
229
+ ```
230
+
231
+ 3. **ตรวจสอบ firewall** - ตรวจสอบว่าพอร์ต 80 และ 443 เปิดอยู่
232
+
233
+ ### ข้อผิดพลาดการตั้งค่า Nginx
234
+
235
+ หาก Nginx reload ล้มเหลว:
236
+
237
+ ```bash
238
+ # ทดสอบการตั้งค่า Nginx
239
+ sudo nginx -t
240
+
241
+ # ตรวจสอบ error logs ของ Nginx
242
+ sudo tail -f /var/log/nginx/error.log
243
+ ```
244
+
245
+ ## ขั้นตอนถัดไป
246
+
247
+ ตอนนี้คุณได้ deploy บริการแรกของคุณแล้ว:
248
+
249
+ - [คู่มือการตั้งค่า](./04-configuration.md) - เรียนรู้เกี่ยวกับตัวเลือกการตั้งค่าทั้งหมด
250
+ - [คำสั่งอ้างอิง](./05-commands.md) - สำรวจคำสั่งทั้งหมดที่มี
251
+ - [ตัวอย่าง](./06-examples.md) - ดูตัวอย่างการ deploy เพิ่มเติม
252
+
253
+ ---
254
+
255
+ **ก่อนหน้า:** [การติดตั้ง](./02-installation.md) | **ถัดไป:** [คู่มือการตั้งค่า →](./04-configuration.md)
256
+