Skip to content

Commit b45df8b

Browse files
tanviet12claude
andcommitted
docs: add app URL setting docs + separate version update page
- Add "URL ứng dụng" section to general-settings.md with priority fallback explanation - Add info boxes in notifications.md linking to app URL config - Create dedicated guide/updates.md page (moved from installation.md) - Update sidebar config and installation.md "next steps" Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 99fcc43 commit b45df8b

5 files changed

Lines changed: 70 additions & 35 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ export default defineConfig({
2525
{ text: 'Cài đặt', link: '/guide/installation' },
2626
{ text: 'Tên miền & SSL', link: '/guide/domain-ssl' },
2727
{ text: 'Thiết lập ban đầu', link: '/guide/initial-setup' },
28+
{ text: 'Cập nhật phiên bản', link: '/guide/updates' },
2829
],
2930
},
3031
{

docs/guide/installation.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -108,39 +108,6 @@ docker compose logs app -f # Chỉ xem app
108108
docker compose logs nginx -f # Chỉ xem nginx
109109
```
110110

111-
## Cập nhật phiên bản mới
112-
113-
```bash
114-
cd /opt/cqa
115-
docker compose pull
116-
docker compose up -d
117-
```
118-
119-
## Tự động cập nhật (tùy chọn)
120-
121-
Thêm [Watchtower](https://containrrr.dev/watchtower/) để VPS tự động pull image mới và restart khi có bản cập nhật.
122-
123-
Chạy lệnh sau trên VPS để cập nhật file docker-compose.yml (đã bao gồm Watchtower + label):
124-
125-
```bash
126-
cd /opt/cqa
127-
curl -sfL https://raw.githubusercontent.com/tanviet12/chat-quality-agent/main/docker-compose.hub.yml -o docker-compose.yml
128-
docker compose up -d
129-
```
130-
131-
::: info Lệnh trên an toàn
132-
File `.env` (chứa secrets, database password) không bị ảnh hưởng. Dữ liệu MySQL nằm trong Docker volume, không bị mất.
133-
:::
134-
135-
Watchtower sẽ kiểm tra Docker Hub mỗi 5 phút. Khi phát hiện image mới, tự pull và restart container **app + nginx** (có label). MySQL không có label nên không bị update, dữ liệu an toàn.
136-
137-
::: tip Xem log Watchtower
138-
```bash
139-
docker compose logs watchtower -f
140-
```
141-
Thấy dòng `Found new ...` nghĩa là đã tự cập nhật thành công.
142-
:::
143-
144111
## Gỡ cài đặt
145112

146113
```bash
@@ -157,3 +124,4 @@ rm -rf /opt/cqa
157124

158125
- [Tên miền & SSL](/guide/domain-ssl) — Trỏ domain và bật HTTPS
159126
- [Thiết lập ban đầu](/guide/initial-setup) — Tạo admin, cấu hình AI
127+
- [Cập nhật phiên bản](/guide/updates) — Cập nhật thủ công hoặc tự động

docs/guide/updates.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Cập nhật phiên bản
2+
3+
## Thông báo trên giao diện
4+
5+
CQA tự động kiểm tra phiên bản mới mỗi khi bạn đăng nhập (cache 1 giờ). Khi có bản cập nhật:
6+
7+
- **Chip phiên bản** ở header chuyển sang màu vàng (bình thường là xanh)
8+
- **Banner thông báo** hiện bên dưới header với link đến changelog
9+
10+
Bấm vào chip phiên bản để xem chi tiết thay đổi trong bản mới.
11+
12+
## Cập nhật thủ công
13+
14+
```bash
15+
cd /opt/cqa
16+
docker compose pull
17+
docker compose up -d
18+
```
19+
20+
Lệnh trên sẽ pull image mới từ Docker Hub và restart container. Dữ liệu MySQL không bị ảnh hưởng.
21+
22+
## Tự động cập nhật (tùy chọn)
23+
24+
Thêm [Watchtower](https://containrrr.dev/watchtower/) để VPS tự động pull image mới và restart khi có bản cập nhật.
25+
26+
Chạy lệnh sau trên VPS để cập nhật file docker-compose.yml (đã bao gồm Watchtower + label):
27+
28+
```bash
29+
cd /opt/cqa
30+
curl -sfL https://raw.githubusercontent.com/tanviet12/chat-quality-agent/main/docker-compose.hub.yml -o docker-compose.yml
31+
docker compose up -d
32+
```
33+
34+
::: info Lệnh trên an toàn
35+
File `.env` (chứa secrets, database password) không bị ảnh hưởng. Dữ liệu MySQL nằm trong Docker volume, không bị mất.
36+
:::
37+
38+
Watchtower sẽ kiểm tra Docker Hub mỗi 5 phút. Khi phát hiện image mới, tự pull và restart container **app + nginx** (có label). MySQL không có label nên không bị update, dữ liệu an toàn.
39+
40+
::: tip Xem log Watchtower
41+
```bash
42+
docker compose logs watchtower -f
43+
```
44+
Thấy dòng `Found new ...` nghĩa là đã tự cập nhật thành công.
45+
:::

docs/usage/general-settings.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cấu hình chung
22

3-
Vào menu **Cài đặt** (icon bánh răng ở sidebar) > tab **Cấu hình chung**.
3+
Vào menu **Cài đặt** (icon bánh răng ở sidebar) > tab **Chung**.
44

55
![Cấu hình chung](/screenshots/cau-hinh-chung.png)
66

@@ -12,6 +12,7 @@ Vào menu **Cài đặt** (icon bánh răng ở sidebar) > tab **Cấu hình chu
1212
| **Múi giờ** | Ảnh hưởng đến thời gian hiển thị và lịch chạy công việc | Asia/Ho_Chi_Minh |
1313
| **Ngôn ngữ** | Giao diện Tiếng Việt hoặc English | Tiếng Việt |
1414
| **Tỉ giá USD → VND** | Dùng để quy đổi chi phí AI sang VND | 26,000 |
15+
| **URL ứng dụng** | URL truy cập CQA, dùng để tạo link trong thông báo Telegram/Email | (không có) |
1516

1617
## Tỉ giá USD → VND
1718

@@ -21,6 +22,22 @@ Chi phí AI (Claude, Gemini) được tính bằng USD. CQA quy đổi sang VND
2122
- Bạn có thể cập nhật theo tỉ giá thực tế
2223
- Ảnh hưởng đến hiển thị trong **Dashboard****Chi phí AI**
2324

25+
## URL ứng dụng
26+
27+
Cấu hình URL để hệ thống gửi link chính xác qua [Telegram và Email](/usage/notifications).
28+
29+
- Nhập URL truy cập CQA của bạn, ví dụ: `https://cqa.sepay.vn`
30+
- URL phải bắt đầu bằng `http://` hoặc `https://`, không có dấu `/` ở cuối
31+
- Link trong thông báo sẽ dẫn thẳng đến trang kết quả trên CQA
32+
33+
::: tip Thứ tự ưu tiên
34+
1. **URL ứng dụng** trong Cài đặt (ưu tiên cao nhất)
35+
2. Biến môi trường `APP_URL` trong file `.env`
36+
3. Fallback: `http://localhost:8080`
37+
38+
Nếu bạn đã cấu hình domain + SSL, hãy nhập URL ở đây để link trong thông báo trỏ đúng.
39+
:::
40+
2441
## Lưu cấu hình
2542

2643
Bấm **Lưu cấu hình** sau khi thay đổi. Cấu hình có hiệu lực ngay lập tức, không cần khởi động lại.

docs/usage/notifications.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ Bot sẽ gửi tin nhắn vào group gồm:
3737
- Danh sách vấn đề phát hiện (nếu có)
3838
- Link xem chi tiết trên CQA
3939

40+
::: info Cấu hình link
41+
Link trong thông báo dùng URL từ **Cài đặt > Chung > [URL ứng dụng](/usage/general-settings#url-ung-dung)**. Nếu chưa cấu hình, link sẽ trỏ về localhost.
42+
:::
43+
4044
## Email
4145

4246
### Thiết lập
@@ -80,7 +84,7 @@ Bạn có thể viết template riêng thay vì dùng mặc định:
8084
| `failed` | Số cuộc chat không đạt |
8185
| `issues` | Số vấn đề phát hiện |
8286
| `content` | Nội dung đánh giá chi tiết |
83-
| `link` | URL xem kết quả trên hệ thống |
87+
| `link` | URL xem kết quả trên hệ thống (dùng [URL ứng dụng](/usage/general-settings#url-ung-dung) đã cấu hình) |
8488

8589
Cú pháp dùng trong template: bọc tên biến trong dấu ngoặc nhọn kép, ví dụ: `{` `{job_name}` `}`
8690

0 commit comments

Comments
 (0)