feat: add xui-deploy skill with lessons learned

- SKILL.md v1.1: full deployment workflow for 3x-ui on VPS via SSH - Covers Docker/native install, Nginx+TLS, Xray inbound config - references/xray-inbound-config.md: VLESS+WS+TLS and Reality configs - references/lessons-learned.md: lessons from first real deployment - /app/x-ui binary vs shell wrapper in Docker - correct API path: panel/api/inbounds/add - subPath-only DB write (subURI causes blank settings page) - --network host port exposure workaround - Agent prompt and eval configs included
2026-04-25 14:07:55 +08:00
parent c0d14c6ac1
commit b6e3cef844
11 changed files with 877 additions and 0 deletions
@@ -0,0 +1,49 @@
+# xui-deploy
+
+Automates installing and configuring [3x-ui](https://github.com/MHSanaei/3x-ui) (Xray panel) on a remote VPS over SSH.
+
+## Architecture
+![Architecture](assets/xui-deploy-architecture.svg)
+
+## Workflow
+![Workflow](assets/xui-deploy-workflow.svg)
+
+## When to Use
+
+Activate this skill when the user wants to:
+- Deploy or install x-ui / 3x-ui on a VPS
+- Set up an Xray proxy panel
+- Update an existing x-ui installation
+- Configure panel port, credentials, or base path
+
+Trigger phrases: `deploy x-ui`, `install x-ui`, `setup xui`, `install 3x-ui`, `xray panel`, `部署x-ui`, `安装x-ui`, `搭建xui`, `xray面板`
+
+## How It Works
+
+1. Collects VPS host, SSH credentials, and panel settings from the user
+2. Tests SSH connectivity and checks OS compatibility
+3. Runs the official 3x-ui one-line installer (handles fresh install and updates)
+4. Configures panel port, username, password, and web base path via `x-ui` CLI
+5. Restarts the service and verifies it is running
+6. Opens the panel port in the system firewall (ufw or firewalld)
+7. Reports the panel URL and credentials
+
+## File Structure
+
+```
+xui-deploy/
+├── SKILL.md          # Instructions for the agent
+├── evals/
+│   └── evals.json    # 4 test cases
+└── assets/
+    ├── architecture.puml
+    ├── xui-deploy-architecture.svg
+    ├── workflow.puml
+    └── xui-deploy-workflow.svg
+```
+
+## Evals
+
+```bash
+python scripts/run_evals.py xui-deploy
+```