@softtynet/zplus-worker 1.0.0 → 1.0.4

package/README.md

@@ -1,35 +1,32 @@
 # @softtynet/zplus-worker
 
-ZPlus 24/7 Headless Omnichannel Engine & Automation Worker.
+ZPlus 24/7 Headless Automation & Omnichannel Worker Engine.
 
 ---
 
-## 🌟 Tổng Quan (Overview)
+## 🌟 Giới Thiệu (Introduction)
 
-`@softtynet/zplus-worker` là tiến trình chạy nền độc lập 24/7 cho hệ sinh thái ZPlus Enterprise, chịu trách nhiệm:
-
-- **Active-Passive Redundancy & Master Preemption (< 1s)**: Hoạt động song song với ZPlus Desktop Client, tự động đảm nhận điều khiển khi Desktop tắt và ngay lập tức nhường quyền khi Desktop mở lại.
-- **Duy trì kết nối WSS / Webhook liên tục**: Giữ phiên hoạt động cho các tài khoản đa kênh (**Zalo, Facebook Messenger, Telegram, WhatsApp**) thông qua proxy dân cư độc lập (Resident Proxy).
-- **Thực thi kịch bản tự động hóa 24/7**: Phản hồi tin nhắn tự động ban đêm (AI Auto-Reply), phân luồng CSKH, gắn thẻ hội thoại ngay cả khi người dùng tắt máy tính cá nhân.
-- **Delta Sync & Message Staging**: Lưu trữ hàng đợi tin nhắn đêm và đồng bộ lại vào cơ sở dữ liệu cục bộ khi ZPlus Desktop khởi động.
+`@softtynet/zplus-worker` là tiến trình chạy nền độc lập 24/7 cho hệ sinh thái ZPlus Enterprise. Phân hệ chịu trách nhiệm duy trì phiên kết nối mạng xã hội, tiếp nhận tin nhắn và thực thi kịch bản tự động hóa liên tục ngay cả khi người dùng không mở máy tính cá nhân.
 
 ---
 
-## 🚀 Các Phương Thức Triển Khai (Deployment Options)
-
-### Cách 1: Chạy trực tiếp qua NPM / NPX (Zero Config, Siêu Nhẹ)
+## 🚀 Hướng Dẫn Cài Đặt & Sử Dụng (Quickstart)
 
-Không cần cài đặt Docker nặng nề, có thể chạy trên bất kỳ VPS, Raspberry Pi, homelab hoặc máy chủ nào có Node.js >= 18:
+### Cách 1: Chạy trực tiếp qua NPX (Không cần cài đặt)
 
 ```bash
-# 1. Chạy tức thì không cần cài đặt:
 npx @softtynet/zplus-worker
+```
+
+### Cách 2: Cài đặt toàn cục trên máy chủ VPS / Linux
 
-# 2. Hoặc cài đặt global trên VPS / Server:
+```bash
 npm install -g @softtynet/zplus-worker
 zplus-worker
+```
 
-# 3. Chạy nền quản lý tiến trình với PM2 (Khuyên dùng trên VPS Linux):
+#### Khuyên dùng: Quản lý tiến trình nền bằng PM2 trên VPS
+```bash
 npm install -g pm2
 pm2 start zplus-worker --name "zplus-worker" --time
 pm2 save && pm2 startup
@@ -37,30 +34,20 @@ pm2 save && pm2 startup
 
 ---
 
-### Cách 2: Triển khai bằng Docker & Docker Compose
-
-Docker Image được build đa kiến trúc (`linux/amd64`, `linux/arm64`) và lưu trữ chính thức trên GitHub Container Registry (`ghcr.io/softtynet/zplus-worker:latest`):
-
-#### A. Chạy nhanh 1 lệnh:
+### Cách 3: Chạy với Docker & Docker Compose
 
+#### A. Chạy nhanh 1 lệnh Container:
 ```bash
 docker run -d \
   --name zplus-worker \
   --restart always \
   -p 8080:8080 \
-  -e WORKER_ID=vps_singapore_01 \
+  -e WORKER_ID=vps_node_1 \
   -e DESKTOP_SECRET=your_secure_secret \
   ghcr.io/softtynet/zplus-worker:latest
 ```
 
-#### B. Triển khai trọn gói với Docker Compose (kèm Redis Distributed Lock):
-
-```bash
-cd apps/worker
-docker compose up -d
-```
-
-File `docker-compose.yml` mẫu:
+#### B. Khởi chạy trọn gói qua Docker Compose:
 ```yaml
 version: "3.8"
 
@@ -96,41 +83,26 @@ volumes:
   redis_data:
 ```
 
+```bash
+docker compose up -d
+```
+
 ---
 
 ## ⚙️ Biến Môi Trường (Environment Variables)
 
 | Biến | Mặc định | Mô tả |
 | :--- | :--- | :--- |
+| `PORT` | `8080` | Cổng HTTP Ingress & Healthcheck |
 | `WORKER_ID` | `worker_<pid>` | Tên định danh duy nhất của Worker Node |
-| `PORT` | `8080` | Port HTTP Ingress & Healthcheck |
 | `DESKTOP_SECRET` | `zplus_shared_secret_token` | Khóa xác thực an toàn giữa Desktop và Worker |
-| `REDIS_URL` | `undefined` | URL Redis cho Distributed Lock (Tùy chọn) |
-| `DATA_DIR` | `./data` | Thư mục lưu trữ database SQLite và session cache |
-| `HEARTBEAT_INTERVAL_MS` | `30000` | Chu kỳ gửi Heartbeat (ms) |
+| `REDIS_URL` | `undefined` | URL Redis cho Distributed Lock (Tùy chọn khi chạy cụm) |
+| `DATA_DIR` | `./data` | Thư mục lưu trữ database cục bộ và session cache |
 
 ---
 
-## 🚢 Tự Động Hóa Release qua GitHub Actions & GitHub CLI (`gh`)
-
-Hệ thống đã cấu hình 2 luồng CI/CD GitHub Actions:
-1. `.github/workflows/publish-worker-npm.yml` - Tự động test, bundle và publish lên NPM Registry.
-2. `.github/workflows/publish-worker-docker.yml` - Tự động build multi-arch và push lên GitHub Container Registry (`ghcr.io`).
-
-### Cách kích hoạt Release:
+## 🛡️ Bản Quyền & Hỗ Trợ (License & Support)
 
-#### Cách A: Bằng GitHub CLI (`gh`)
-```bash
-# 1. Kích hoạt publish NPM:
-gh workflow run publish-worker-npm.yml
-
-# 2. Kích hoạt build Docker Image lên GHCR:
-gh workflow run publish-worker-docker.yml
-```
-
-#### Cách B: Bằng Git Tag
-```bash
-git tag worker-v1.0.0
-git push origin worker-v1.0.0
-```
-*(Cả 2 workflow NPM và Docker sẽ tự động kích hoạt song song khi tag `worker-v*` được đẩy lên)*.
+Sản phẩm thuộc bản quyền của **SOFTTY.NET COMPANY LIMITED**.  
+Website chính thức: [https://softty.net](https://softty.net)  
+Hỗ trợ kỹ thuật: [support@softty.net](mailto:support@softty.net)