cleanup: remove dead code and duplicate docs
- Remove session-ses_2f27.md (161KB raw session log) - Remove 49 ROOT_* duplicate files across REFERENCE/ - Remove 14 duplicate files between REFERENCE/ root and history/ - Remove asr_legacy.rs (dead code, replaced by asr.rs) - Remove src/core/worker/ (duplicate JobWorker) - Remove src/core/layers/ (empty directory) - Remove 4 .bak files in src/ - Remove 7 dead private methods in worker/processor.rs - Remove backup directory from git tracking
This commit is contained in:
@@ -1,449 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "AI Agent 文檔系統使用指南"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "agent"
|
||||
- "文檔系統使用指南"
|
||||
ai_query_hints:
|
||||
- "查詢 AI Agent 文檔系統使用指南 的內容"
|
||||
- "AI Agent 文檔系統使用指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 AI Agent 文檔系統使用指南?"
|
||||
---
|
||||
|
||||
# AI Agent 文檔系統使用指南
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔為 AI Agent 提供 Momentry 維護紀錄管理系統的使用指南,旨在最大化 AI Agent 的操作效率和自動化能力。
|
||||
|
||||
## 核心設計原則
|
||||
|
||||
### 1. 雙重格式設計
|
||||
- **YAML Frontmatter**: 結構化元數據,AI Agent 優先讀取
|
||||
- **Markdown 表格**: 人類可讀格式,AI Agent 備用解析
|
||||
- **保持同步**: 兩部分數據應保持一致
|
||||
|
||||
### 2. 標準化查詢模式
|
||||
- 使用一致的字段名稱和值域
|
||||
- 預定義查詢模板和篩選條件
|
||||
- 支持複雜查詢邏輯
|
||||
|
||||
### 3. 自動化工作流
|
||||
- 狀態變更觸發目錄移動
|
||||
- 嚴重等級觸發通知
|
||||
- 時間基於的自動歸檔
|
||||
|
||||
## 文件結構解析
|
||||
|
||||
### 文件名模式
|
||||
```
|
||||
{前綴}_{服務}_{問題}_{日期}.md
|
||||
```
|
||||
- **前綴**: `RCA_`, `INCIDENT_`, `CHANGE_`, `MAINTENANCE_`
|
||||
- **服務**: 大寫英文,如 `WORDPRESS`, `POSTGRESQL`
|
||||
- **問題**: 大寫英文+下劃線,如 `TIMEOUT_EXTERNAL_ACCESS`
|
||||
- **日期**: `YYYY_MM_DD`
|
||||
|
||||
### 目錄結構
|
||||
```
|
||||
maintenance_records/
|
||||
├── rca/ # 根本原因分析
|
||||
├── incidents/ # 事件報告
|
||||
├── changes/ # 變更紀錄
|
||||
├── plans/ # 維護計畫
|
||||
├── templates/ # 模板文件
|
||||
├── _active/ # 進行中項目(各類型子目錄)
|
||||
├── _completed/ # 已完成項目(各類型子目錄)
|
||||
└── _archived/ # 已歸檔項目(各類型子目錄)
|
||||
```
|
||||
|
||||
## YAML Frontmatter 規範
|
||||
|
||||
### 通用字段
|
||||
```yaml
|
||||
---
|
||||
document_type: "rca" | "incident" | "change" | "maintenance"
|
||||
service: "服務名稱"
|
||||
problem: "問題簡述"
|
||||
date: "YYYY-MM-DD"
|
||||
severity: "P0" | "P1" | "P2" | "P3" | "P4"
|
||||
status: "active" | "completed" | "archived"
|
||||
current_state: "pending" | "investigating" | "resolving" | "resolved" | "closed"
|
||||
owner: "負責人姓名"
|
||||
created_by: "創建者姓名"
|
||||
created_at: "YYYY-MM-DD HH:MM"
|
||||
version: "版本號"
|
||||
tags:
|
||||
- "標籤1"
|
||||
- "標籤2"
|
||||
related_documents:
|
||||
- "相關文件1.md"
|
||||
- "相關文件2.md"
|
||||
ai_query_hints:
|
||||
- "查詢提示1"
|
||||
- "查詢提示2"
|
||||
---
|
||||
```
|
||||
|
||||
### 類型特定字段
|
||||
|
||||
#### RCA (根本原因分析)
|
||||
```yaml
|
||||
rca_type: "technical" | "process" | "human_error"
|
||||
root_cause: "根本原因描述"
|
||||
resolution: "解決方案描述"
|
||||
prevention: "預防措施"
|
||||
```
|
||||
|
||||
#### Incident (事件報告)
|
||||
```yaml
|
||||
incident_type: "服務中斷" | "性能問題" | "安全事件" | "數據問題"
|
||||
detection_method: "監控警報" | "用戶報告" | "系統日誌"
|
||||
impact_level: "高" | "中" | "低"
|
||||
affected_users: "受影響用戶數量"
|
||||
downtime: "停機時間(分鐘)"
|
||||
```
|
||||
|
||||
#### Change (變更紀錄)
|
||||
```yaml
|
||||
change_type: "配置變更" | "版本升級" | "架構調整" | "安全修補"
|
||||
risk_level: "低" | "中" | "高" | "緊急"
|
||||
approval_status: "pending" | "approved" | "rejected"
|
||||
implementation_status: "planned" | "implementing" | "completed" | "rolled_back"
|
||||
```
|
||||
|
||||
## 查詢語言規範
|
||||
|
||||
### 基本查詢語法
|
||||
```
|
||||
字段名: "值" [AND|OR] 字段名: "值"
|
||||
```
|
||||
|
||||
### 查詢示例
|
||||
```yaml
|
||||
# 查詢所有 P0/P1 級別的活躍事件
|
||||
document_type: "incident" AND severity: ("P0" OR "P1") AND status: "active"
|
||||
|
||||
# 查詢特定服務的所有 RCA
|
||||
document_type: "rca" AND service: "n8n"
|
||||
|
||||
# 查詢需要審核的變更
|
||||
document_type: "change" AND approval_status: "pending"
|
||||
|
||||
# 查詢本週創建的文件
|
||||
date: ">=2026-03-20" AND date: "<=2026-03-27"
|
||||
```
|
||||
|
||||
### 複雜查詢
|
||||
```yaml
|
||||
# 查詢已解決但未歸檔的 P2+ 事件
|
||||
document_type: "incident" AND
|
||||
severity: (>= "P2") AND
|
||||
current_state: "resolved" AND
|
||||
status: "active"
|
||||
|
||||
# 查詢特定負責人的進行中項目
|
||||
owner: "Warren" AND
|
||||
status: "active" AND
|
||||
current_state: ("investigating" OR "resolving")
|
||||
```
|
||||
|
||||
## 自動化工作流
|
||||
|
||||
### 1. 文件創建工作流
|
||||
```
|
||||
1. 識別需要創建的文檔類型
|
||||
2. 選擇對應模板
|
||||
3. 填充 YAML frontmatter
|
||||
4. 生成 Markdown 內容
|
||||
5. 保存到正確目錄 (_active/)
|
||||
6. 發送創建通知
|
||||
```
|
||||
|
||||
### 2. 狀態更新工作流
|
||||
```
|
||||
1. 讀取文件 YAML frontmatter
|
||||
2. 更新 current_state 字段
|
||||
3. 如果狀態變為 "resolved" 或 "closed":
|
||||
- 更新完成時間
|
||||
- 移動文件到 _completed/
|
||||
- 發送完成通知
|
||||
4. 保存更新後的文件
|
||||
```
|
||||
|
||||
### 3. 定期歸檔工作流
|
||||
```
|
||||
每日執行:
|
||||
1. 掃描 _completed/ 目錄
|
||||
2. 檢查文件的創建日期
|
||||
3. 如果超過保留期限 (RCA: 30天,事件: 30天,變更: 90天)
|
||||
4. 移動文件到 _archived/
|
||||
5. 更新 status: "archived"
|
||||
```
|
||||
|
||||
### 4. 通知觸發工作流
|
||||
```
|
||||
事件觸發時:
|
||||
1. 檢查 severity 字段
|
||||
- P0: 立即通知 (即時通訊+電話)
|
||||
- P1: 1小時內通知技術團隊
|
||||
- P2: 2小時內通知相關人員
|
||||
- P3/P4: 工作日內通知
|
||||
2. 根據通知配置發送警報
|
||||
```
|
||||
|
||||
## AI Agent 最佳實踐
|
||||
|
||||
### 數據提取
|
||||
```python
|
||||
import yaml
|
||||
import re
|
||||
|
||||
def extract_document_metadata(file_path):
|
||||
"""從文件中提取 YAML frontmatter"""
|
||||
with open(file_path, 'r', encoding='utf-8') as f:
|
||||
content = f.read()
|
||||
|
||||
# 提取 YAML frontmatter (位於 --- 之間)
|
||||
yaml_match = re.search(r'^---\n(.*?)\n---\n', content, re.DOTALL | re.MULTILINE)
|
||||
|
||||
if yaml_match:
|
||||
try:
|
||||
metadata = yaml.safe_load(yaml_match.group(1))
|
||||
return metadata
|
||||
except yaml.YAMLError as e:
|
||||
print(f"YAML 解析錯誤: {e}")
|
||||
|
||||
# 備用:解析文件名
|
||||
metadata = parse_filename_metadata(file_path)
|
||||
return metadata
|
||||
|
||||
def parse_filename_metadata(file_path):
|
||||
"""從文件名解析元數據"""
|
||||
filename = os.path.basename(file_path)
|
||||
# 解析: PREFIX_SERVICE_PROBLEM_DATE.md
|
||||
pattern = r'^([A-Z]+)_([A-Z]+)_([A-Z_]+)_(\d{4}_\d{2}_\d{2})\.md$'
|
||||
match = re.match(pattern, filename)
|
||||
|
||||
if match:
|
||||
return {
|
||||
'document_type': match.group(1).lower(),
|
||||
'service': match.group(2),
|
||||
'problem': match.group(3),
|
||||
'date': match.group(4).replace('_', '-')
|
||||
}
|
||||
|
||||
return {}
|
||||
```
|
||||
|
||||
### 文件搜索
|
||||
```python
|
||||
import os
|
||||
import glob
|
||||
|
||||
def search_documents(query_filters, base_dir="docs/maintenance_records"):
|
||||
"""根據查詢條件搜索文件"""
|
||||
results = []
|
||||
|
||||
# 遍歷所有子目錄
|
||||
for root, dirs, files in os.walk(base_dir):
|
||||
for file in files:
|
||||
if file.endswith('.md'):
|
||||
file_path = os.path.join(root, file)
|
||||
metadata = extract_document_metadata(file_path)
|
||||
|
||||
# 應用查詢過濾器
|
||||
if matches_filters(metadata, query_filters):
|
||||
results.append({
|
||||
'path': file_path,
|
||||
'metadata': metadata
|
||||
})
|
||||
|
||||
return results
|
||||
|
||||
def matches_filters(metadata, filters):
|
||||
"""檢查元數據是否匹配查詢條件"""
|
||||
for key, expected_value in filters.items():
|
||||
if key not in metadata:
|
||||
return False
|
||||
|
||||
actual_value = metadata[key]
|
||||
|
||||
# 支持範圍查詢 (>=, <=, >, <)
|
||||
if isinstance(expected_value, str) and expected_value.startswith(('>=', '<=', '>', '<')):
|
||||
if not evaluate_range(actual_value, expected_value):
|
||||
return False
|
||||
elif actual_value != expected_value:
|
||||
return False
|
||||
|
||||
return True
|
||||
```
|
||||
|
||||
### 自動化更新
|
||||
```python
|
||||
def update_document_status(file_path, new_state, new_status=None):
|
||||
"""更新文件狀態"""
|
||||
with open(file_path, 'r', encoding='utf-8') as f:
|
||||
content = f.read()
|
||||
|
||||
# 更新 YAML frontmatter
|
||||
def update_yaml(match):
|
||||
yaml_content = match.group(1)
|
||||
metadata = yaml.safe_load(yaml_content)
|
||||
|
||||
metadata['current_state'] = new_state
|
||||
if new_status:
|
||||
metadata['status'] = new_status
|
||||
|
||||
# 如果是狀態變更,更新時間戳
|
||||
if new_state in ['resolved', 'closed']:
|
||||
metadata['resolved_at'] = datetime.now().isoformat()
|
||||
|
||||
updated_yaml = yaml.dump(metadata, allow_unicode=True, default_flow_style=False)
|
||||
return f"---\n{updated_yaml}---\n"
|
||||
|
||||
# 替換 YAML 部分
|
||||
updated_content = re.sub(
|
||||
r'^---\n(.*?)\n---\n',
|
||||
update_yaml,
|
||||
content,
|
||||
flags=re.DOTALL | re.MULTILINE
|
||||
)
|
||||
|
||||
# 寫回文件
|
||||
with open(file_path, 'w', encoding='utf-8') as f:
|
||||
f.write(updated_content)
|
||||
|
||||
# 根據狀態移動文件
|
||||
move_to_correct_directory(file_path, new_status)
|
||||
```
|
||||
|
||||
## 目錄管理規則
|
||||
|
||||
### 文件移動邏輯
|
||||
```python
|
||||
def move_to_correct_directory(file_path, status):
|
||||
"""根據狀態移動文件到正確目錄"""
|
||||
base_dir = "docs/maintenance_records"
|
||||
filename = os.path.basename(file_path)
|
||||
|
||||
# 確定文件類型 (從文件名或元數據)
|
||||
doc_type = determine_document_type(filename)
|
||||
|
||||
target_dir = os.path.join(base_dir, doc_type)
|
||||
|
||||
if status == "active":
|
||||
target_dir = os.path.join(target_dir, "_active")
|
||||
elif status == "completed":
|
||||
target_dir = os.path.join(target_dir, "_completed")
|
||||
elif status == "archived":
|
||||
target_dir = os.path.join(target_dir, "_archived")
|
||||
|
||||
# 確保目標目錄存在
|
||||
os.makedirs(target_dir, exist_ok=True)
|
||||
|
||||
# 移動文件
|
||||
target_path = os.path.join(target_dir, filename)
|
||||
os.rename(file_path, target_path)
|
||||
|
||||
return target_path
|
||||
```
|
||||
|
||||
## 錯誤處理與日誌
|
||||
|
||||
### 錯誤代碼
|
||||
```yaml
|
||||
ERROR_CODES:
|
||||
FILE_NOT_FOUND: "E001"
|
||||
YAML_PARSE_ERROR: "E002"
|
||||
INVALID_FILENAME: "E003"
|
||||
MISSING_REQUIRED_FIELD: "E004"
|
||||
DIRECTORY_PERMISSION: "E005"
|
||||
```
|
||||
|
||||
### 日誌格式
|
||||
```python
|
||||
import logging
|
||||
|
||||
logging.basicConfig(
|
||||
level=logging.INFO,
|
||||
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
||||
handlers=[
|
||||
logging.FileHandler('ai_agent_docs.log'),
|
||||
logging.StreamHandler()
|
||||
]
|
||||
)
|
||||
|
||||
logger = logging.getLogger('ai_docs_agent')
|
||||
```
|
||||
|
||||
## 性能優化建議
|
||||
|
||||
### 1. 緩存策略
|
||||
- 緩存經常訪問的文件元數據
|
||||
- 實現增量更新檢測
|
||||
- 使用內存緩存熱點數據
|
||||
|
||||
### 2. 批量操作
|
||||
- 合併相似的文件操作
|
||||
- 使用事務性更新
|
||||
- 實現操作隊列
|
||||
|
||||
### 3. 索引優化
|
||||
- 建立文件元數據索引
|
||||
- 定期重建索引
|
||||
- 支持全文搜索
|
||||
|
||||
## 測試與驗證
|
||||
|
||||
### 單元測試示例
|
||||
```python
|
||||
def test_extract_metadata():
|
||||
"""測試元數據提取"""
|
||||
test_file = "test_rca.md"
|
||||
metadata = extract_document_metadata(test_file)
|
||||
|
||||
assert metadata['document_type'] == 'rca'
|
||||
assert metadata['severity'] == 'P2'
|
||||
assert 'service' in metadata
|
||||
|
||||
def test_search_documents():
|
||||
"""測試文檔搜索"""
|
||||
results = search_documents({'severity': 'P0', 'status': 'active'})
|
||||
assert len(results) > 0
|
||||
for result in results:
|
||||
assert result['metadata']['severity'] == 'P0'
|
||||
```
|
||||
|
||||
## 附錄
|
||||
|
||||
### 保留期限對照表
|
||||
| 文件類型 | 活躍期 | 完成保留期 | 總保留期 |
|
||||
|----------|--------|------------|----------|
|
||||
| RCA | P0: 7天, P1: 14天, P2-4: 30天 | 30天 | 2年 |
|
||||
| 事件報告 | P0: 3天, P1: 7天, P2-4: 14天 | 30天 | 1年 |
|
||||
| 變更紀錄 | 實施期間 | 90天 | 3年 |
|
||||
| 維護計畫 | 計畫期間 | 30天 | 1年 |
|
||||
|
||||
### 嚴重等級定義
|
||||
| 等級 | 響應時間 | 通知要求 | 文件要求 |
|
||||
|------|----------|----------|----------|
|
||||
| P0 | 立即 | 即時通訊+電話 | 必須創建 RCA |
|
||||
| P1 | 2小時內 | 1小時內通知團隊 | 建議創建 RCA |
|
||||
| P2 | 4小時內 | 2小時內通知 | 可選創建 RCA |
|
||||
| P3 | 1工作日 | 工作日內通知 | 事件報告即可 |
|
||||
| P4 | 3工作日 | 無需緊急通知 | 簡單紀錄 |
|
||||
|
||||
---
|
||||
|
||||
**最後更新**: 2026-03-27
|
||||
**版本**: V1.0
|
||||
**適用對象**: 所有 AI Agent 和自動化工具
|
||||
|
||||
**注意**: 本文檔應與實際模板文件結合使用,定期更新以反映系統變更。
|
||||
@@ -1,571 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry API 使用說明 (curl 範例)"
|
||||
date: "2026-03-26"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "使用說明"
|
||||
- "momentry"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry API 使用說明 (curl 範例) 的內容"
|
||||
- "Momentry API 使用說明 (curl 範例) 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry API 使用說明 (curl 範例)?"
|
||||
---
|
||||
|
||||
# Momentry API 使用說明 (curl 範例)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V1.4 |
|
||||
| 日期 | 2026-03-26 |
|
||||
| Base URL | `http://localhost:3002` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.4 | 2026-03-26 | 新增: 任務管理端點 (`/api/v1/jobs`, `/api/v1/jobs/:uuid`),更新註冊端點回應格式 | OpenCode | deepseek-reasoner |
|
||||
| V1.3 | 2026-03-25 | 更新: n8n 搜尋回傳 `file_path` 取代 `media_url`,新增 API Key 驗證說明 | OpenCode | deepseek-reasoner |
|
||||
| V1.2 | 2026-03-23 | 建立 curl 範例文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-18 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
> **狀態說明**:
|
||||
> - ✅ **已實作**: 健康檢查、搜尋、影片管理、視覺搜索、人臉識別、人物身份
|
||||
> - 🔧 **CLI**: API Key 管理需使用命令列工具
|
||||
|
||||
---
|
||||
|
||||
## 目錄
|
||||
|
||||
1. [已實作端點](#1-已實作端點)
|
||||
2. [API Key 管理](#2-api-key-管理)
|
||||
3. [影片管理](#3-影片管理)
|
||||
4. [查詢與搜索](#4-查詢與搜索)
|
||||
5. [系統狀態](#5-系統狀態)
|
||||
|
||||
---
|
||||
|
||||
## URL 選擇指南
|
||||
|
||||
### 兩種 URL 的使用情境
|
||||
|
||||
| 環境 | URL | 說明 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 直接訪問 API,繞過反向代理 |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | 通過 Caddy 反向代理訪問,需網路可達 |
|
||||
|
||||
### 何時使用 localhost:3002
|
||||
|
||||
- ✅ 開發/測試環境
|
||||
- ✅ 直接在伺服器上操作
|
||||
- ✅ 當 Caddy/反向代理有問題時
|
||||
- ✅ 需要快速除錯時
|
||||
|
||||
### 何時使用 api.momentry.ddns.net
|
||||
|
||||
- ✅ n8n workflow 中呼叫 API
|
||||
- ✅ 外部系統整合
|
||||
- ✅ 生產環境
|
||||
- ✅ 從其他機器訪問
|
||||
|
||||
### 快速切換範例
|
||||
|
||||
```bash
|
||||
# 本地測試
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 外部測試(功能相同)
|
||||
curl https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
### 常見問題
|
||||
|
||||
**Q: 為什麼有兩個 URL?**
|
||||
A: `localhost:3002` 是直接訪問,`api.momentry.ddns.net` 通過 Caddy 反向代理。
|
||||
|
||||
**Q: 兩者功能相同嗎?**
|
||||
A: 是的,所有端點和功能完全相同。
|
||||
|
||||
**Q: 502 錯誤時怎麼辦?**
|
||||
A: 如果 `api.momentry.ddns.net` 返回 502,檢查 Momentry API 服務是否運行:
|
||||
```bash
|
||||
launchctl list | grep momentry.api
|
||||
# 如果未運行
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 認證
|
||||
|
||||
所有 `/api/v1/*` 端點(除了健康檢查)都需要 API Key 認證。請在請求標頭中加入:
|
||||
|
||||
```
|
||||
-H "X-API-Key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
**目前示範使用的 API Key**: `muser_68600856036340bcafc01930eb4bd839`
|
||||
|
||||
> **注意**: 正式環境請使用安全的 API Key 管理機制。
|
||||
|
||||
---
|
||||
|
||||
## 1. 已實作端點
|
||||
|
||||
### 健康檢查
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 詳細健康檢查
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. API Key 管理
|
||||
|
||||
> API Key 管理透過 CLI 工具操作,詳細設計請參考 [API_KEY_DESIGN.md](../REFERENCE/API_KEY_DESIGN.md)。
|
||||
|
||||
### 2.1 建立 API Key
|
||||
|
||||
```bash
|
||||
momentry api-key create --name "my-service-key" --type service --ttl 90d
|
||||
```
|
||||
|
||||
### 2.2 列出所有 API Keys
|
||||
|
||||
```bash
|
||||
momentry api-key list
|
||||
```
|
||||
|
||||
### 2.3 撤銷 API Key
|
||||
|
||||
```bash
|
||||
momentry api-key revoke <key_id>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 影片管理
|
||||
|
||||
### 3.1 註冊影片 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"video_id": 1,
|
||||
"job_id": 123,
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"already_exists": false
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 列出所有影片 ✅
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 3.3 查詢影片 ✅
|
||||
|
||||
```bash
|
||||
# 依 UUID 查詢
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?uuid=a1b2c3d4e5f6g7h8"
|
||||
|
||||
# 依路徑查詢
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?path=/path/to/video.mp4"
|
||||
```
|
||||
|
||||
### 3.4 處理影片 🔧 *(CLI - 非 API)*
|
||||
|
||||
影片處理需要使用 CLI 命令:
|
||||
|
||||
```bash
|
||||
# 處理影片(生成 ASR, CUT, YOLO, OCR, Face, Pose 資料)
|
||||
cargo run --bin momentry -- process <uuid>
|
||||
|
||||
# 或處理多個影片
|
||||
cargo run --bin momentry -- process <uuid1> <uuid2> <uuid3>
|
||||
```
|
||||
|
||||
### 3.5 取得處理進度 ✅
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/progress/<uuid>
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"overall_progress": 75,
|
||||
"processors": [
|
||||
{
|
||||
"name": "asr",
|
||||
"status": "complete",
|
||||
"current": 100,
|
||||
"total": 100,
|
||||
"progress": 100,
|
||||
"message": "7 segments"
|
||||
},
|
||||
{
|
||||
"name": "cut",
|
||||
"status": "complete",
|
||||
"current": 134,
|
||||
"total": 134,
|
||||
"progress": 100,
|
||||
"message": "134 scenes"
|
||||
},
|
||||
{
|
||||
"name": "yolo",
|
||||
"status": "progress",
|
||||
"current": 5000,
|
||||
"total": 14315,
|
||||
"progress": 35,
|
||||
"message": "frame 5000"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 3.6 任務管理 ✅
|
||||
|
||||
```bash
|
||||
# 列出所有任務
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/jobs
|
||||
|
||||
# 取得特定任務詳情
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/jobs/<uuid>
|
||||
```
|
||||
|
||||
**任務列表回應範例**:
|
||||
```json
|
||||
{
|
||||
"jobs": [
|
||||
{
|
||||
"id": 123,
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"status": "pending",
|
||||
"current_processor": null,
|
||||
"progress_current": 0,
|
||||
"progress_total": 100,
|
||||
"created_at": "2026-03-26 10:30:00",
|
||||
"started_at": null
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**任務詳情回應範例**:
|
||||
```json
|
||||
{
|
||||
"id": 123,
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"status": "processing",
|
||||
"current_processor": "asr",
|
||||
"progress_current": 50,
|
||||
"progress_total": 100,
|
||||
"processors": [
|
||||
{
|
||||
"processor_type": "asr",
|
||||
"status": "complete",
|
||||
"started_at": "2026-03-26 10:30:00",
|
||||
"completed_at": "2026-03-26 10:35:00",
|
||||
"duration_secs": 300.5,
|
||||
"error_message": null
|
||||
},
|
||||
{
|
||||
"processor_type": "cut",
|
||||
"status": "pending",
|
||||
"started_at": null,
|
||||
"completed_at": null,
|
||||
"duration_secs": null,
|
||||
"error_message": null
|
||||
}
|
||||
],
|
||||
"created_at": "2026-03-26 10:30:00",
|
||||
"started_at": "2026-03-26 10:30:00",
|
||||
"updated_at": "2026-03-26 10:35:00"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 查詢與搜索
|
||||
|
||||
### 4.1 語意搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"chunk_id": "sentence_0006",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.526
|
||||
}
|
||||
],
|
||||
"query": "測試關鍵字"
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 n8n 格式搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "測試關鍵字",
|
||||
"count": 2,
|
||||
"hits": [
|
||||
{
|
||||
"id": "c_001",
|
||||
"vid": "a1b2c3d4e5f6g7h8",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0006",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.3 混合搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/hybrid \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 系統狀態
|
||||
|
||||
### 5.1 健康檢查 ✅
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 5.2 詳細健康檢查 ✅
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"status":"ok",
|
||||
"version":"0.1.0",
|
||||
"uptime_ms":123456,
|
||||
"services":{
|
||||
"postgres":{"status":"ok","latency_ms":42,"error":null},
|
||||
"redis":{"status":"ok","latency_ms":0,"error":null},
|
||||
"qdrant":{"status":"ok","latency_ms":15,"error":null}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. n8n Webhook 測試
|
||||
|
||||
### 測試 n8n Workflow
|
||||
|
||||
**重要**: 測試前請先在 n8n UI 中點擊 "Execute workflow" 按鈕
|
||||
|
||||
```bash
|
||||
# 測試 Video RAG Workflow (Test Mode)
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
|
||||
# 帶有 UUID 過濾的搜尋
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"woody","limit":5,"uuid":"a1b10138a6bbb0cd"}'
|
||||
```
|
||||
|
||||
### 生產環境 Webhook
|
||||
|
||||
**注意**: 工作流程必須處於 Active 狀態
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:5678/webhook/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
### n8n Webhook 常見問題
|
||||
|
||||
**Q: webhook-test 返回 404**
|
||||
A: 需要在 n8n UI 中點擊 "Execute workflow" 按鈕後才能使用 test webhook
|
||||
|
||||
**Q: webhook (生產環境) 返回 404**
|
||||
A: 需要將工作流程切換為 Active 狀態 (右上角開關)
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. 服務 URL 列表
|
||||
|
||||
| 服務 | URL |
|
||||
|------|-----|
|
||||
| Momentry API (本地) | `http://localhost:3002` |
|
||||
| Momentry API (外部) | `https://api.momentry.ddns.net` |
|
||||
| n8n Web UI | `https://n8n.momentry.ddns.net` |
|
||||
| n8n Webhook Test | `http://localhost:5678/webhook-test/{workflow-name}` |
|
||||
| n8n Webhook Prod | `http://localhost:5678/webhook/{workflow-name}` |
|
||||
|
||||
### B. 所有可用端點
|
||||
|
||||
| 端點 | 方法 | 狀態 | 說明 |
|
||||
|------|------|------|------|
|
||||
| `/health` | GET | ✅ | 健康檢查 |
|
||||
| `/health/detailed` | GET | ✅ | 詳細健康檢查 |
|
||||
| `/api/v1/register` | POST | ✅ | 註冊影片 |
|
||||
| `/api/v1/search` | POST | ✅ | 語意搜尋 |
|
||||
| `/api/v1/n8n/search` | POST | ✅ | n8n 格式搜尋 |
|
||||
| `/api/v1/search/hybrid` | POST | ✅ | 混合搜尋 |
|
||||
| `/api/v1/lookup` | GET | ✅ | 查詢影片 |
|
||||
| `/api/v1/videos` | GET | ✅ | 列出所有影片 |
|
||||
| `/api/v1/progress/:uuid` | GET | ✅ | 處理進度 |
|
||||
| `/api/v1/jobs` | GET | ✅ | 任務列表 |
|
||||
| `/api/v1/jobs/:uuid` | GET | ✅ | 任務詳情 |
|
||||
| `/api/v1/api-keys` | * | ⚠️ | API Key 管理 (規劃中) |
|
||||
|
||||
### C. 常見錯誤
|
||||
|
||||
| HTTP 狀態 | 說明 | 解決方式 |
|
||||
|-----------|------|----------|
|
||||
| 200 | 成功 | - |
|
||||
| 400 | 請求格式錯誤 | 檢查 JSON 格式 |
|
||||
| 404 | 端點不存在或資源未找到 | 確認端點 URL 正確 |
|
||||
| 500 | 伺服器內部錯誤 | 檢查 API 服務日誌 |
|
||||
| **502** | **Bad Gateway** | **API 服務未啟動,見下方說明** |
|
||||
|
||||
#### 502 Bad Gateway 錯誤
|
||||
|
||||
**問題**: 外部 URL `https://api.momentry.ddns.net` 返回 502
|
||||
|
||||
**原因**: Momentry Core API 服務未啟動
|
||||
|
||||
**解決方式**:
|
||||
|
||||
```bash
|
||||
# 1. 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 2. 如果未啟動,手動啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 3. 或使用本地測試(繞過反向代理)
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 4. 檢查日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
### D. 範例腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# api_test.sh - API 測試腳本
|
||||
|
||||
API_URL="http://localhost:3002"
|
||||
|
||||
# 健康檢查
|
||||
echo "=== Health Check ==="
|
||||
curl -s "$API_URL/health" | jq .
|
||||
|
||||
# 搜尋
|
||||
echo -e "\n=== Search ==="
|
||||
curl -s -X POST "$API_URL/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "test", "limit": 3}' | jq .
|
||||
|
||||
# 列出影片
|
||||
echo -e "\n=== Videos ==="
|
||||
curl -s -H "X-API-Key: YOUR_API_KEY" "$API_URL/api/v1/videos" | jq '.videos | length'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_REFERENCE.md](../REFERENCE/API_REFERENCE.md) - 完整 API 參考
|
||||
- [API_INDEX.md](../REFERENCE/API_INDEX.md) - 文件總覽
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 使用範例
|
||||
- [API_WORDPRESS_GUIDE.md](./API_WORDPRESS_GUIDE.md) - WordPress 使用範例
|
||||
- [API_KEY_DESIGN.md](../REFERENCE/API_KEY_DESIGN.md) - API Key 設計文件
|
||||
@@ -1,790 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry Core API 使用範例總覽"
|
||||
date: "2026-03-26"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "使用範例總覽"
|
||||
- "momentry"
|
||||
- "core"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry Core API 使用範例總覽 的內容"
|
||||
- "Momentry Core API 使用範例總覽 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry Core API 使用範例總覽?"
|
||||
---
|
||||
|
||||
# Momentry Core API 使用範例總覽
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V2.1 |
|
||||
| 日期 | 2026-03-26 |
|
||||
| Base URL (本地) | `http://localhost:3002` |
|
||||
| Base URL (外部) | `https://api.momentry.ddns.net` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V2.0 | 2026-03-25 | 創建完整範例總覽 | OpenCode |
|
||||
| V2.1 | 2026-03-26 | 更新API回應格式 (media_url→file_path) 與認證標頭 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 快速參考
|
||||
|
||||
### 環境 URL 選擇
|
||||
|
||||
| 環境 | URL | 用途 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 開發/測試,直接訪問 API |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | n8n、WordPress、curl 生產環境 |
|
||||
|
||||
### 所有可用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| GET | `/health/detailed` | 詳細健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋(標準格式) |
|
||||
| POST | `/api/v1/n8n/search` | 語意搜尋(n8n 格式) |
|
||||
| POST | `/api/v1/search/hybrid` | 混合搜尋 |
|
||||
| POST | `/api/v1/register` | 註冊影片 |
|
||||
| POST | `/api/v1/probe` | 探測影片資訊 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 |
|
||||
|
||||
---
|
||||
|
||||
## 認證
|
||||
|
||||
### API Key
|
||||
|
||||
所有 `/api/v1/*` 端點需要 API Key 認證。
|
||||
|
||||
```bash
|
||||
# 添加 API Key Header
|
||||
curl -H "X-API-Key: your-api-key" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 範例
|
||||
curl -H "X-API-Key: muser_f08e13ba967e4d8ea8fc542ad9f99ac8_1774416728_90472a35" \
|
||||
http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 響應狀態
|
||||
|
||||
| 狀態碼 | 說明 |
|
||||
|--------|------|
|
||||
| 200 | 成功 |
|
||||
| 401 | 未授權(缺少或無效 API Key) |
|
||||
| 500 | 伺服器錯誤 |
|
||||
|
||||
### 建立 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key create "My Key" --key-type user
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 1. curl 範例
|
||||
|
||||
### 基本語法
|
||||
|
||||
```bash
|
||||
# 格式
|
||||
curl [OPTIONS] URL
|
||||
|
||||
# 常用選項
|
||||
-X METHOD # HTTP 方法 (GET, POST, etc.)
|
||||
-H HEADER # 添加 HTTP 標頭
|
||||
-d DATA # POST 請求體
|
||||
-s # 靜默模式
|
||||
-w FORMAT # 輸出額外信息
|
||||
```
|
||||
|
||||
### 1.1 健康檢查
|
||||
|
||||
```bash
|
||||
# 基本健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 1.2 語意搜尋
|
||||
|
||||
```bash
|
||||
# 標準格式搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
|
||||
# n8n 格式搜尋(推薦)
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
|
||||
# 混合搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search/hybrid \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
```
|
||||
|
||||
**標準格式回應**:
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "sentence_0001",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92
|
||||
}
|
||||
],
|
||||
"query": "charade"
|
||||
}
|
||||
```
|
||||
|
||||
**n8n 格式回應**:
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0001",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0001",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 1.3 影片管理
|
||||
|
||||
```bash
|
||||
# 列出所有影片
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 查詢特定影片(依 UUID)
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?uuid=a1b10138a6bbb0cd"
|
||||
|
||||
# 查詢特定影片(依路徑)
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?path=/path/to/video.mp4"
|
||||
|
||||
# 取得處理進度
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/progress/a1b10138a6bbb0cd
|
||||
|
||||
# 探測影片(不註冊)
|
||||
curl -X POST http://localhost:3002/api/v1/probe \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
|
||||
# 註冊影片
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
```
|
||||
|
||||
### 1.4 批次測試腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# api_test.sh - API 測試腳本
|
||||
|
||||
API_URL="http://localhost:3002"
|
||||
|
||||
echo "=== 健康檢查 ==="
|
||||
curl -s "$API_URL/health" | jq .
|
||||
|
||||
echo -e "\n=== 語意搜尋 ==="
|
||||
curl -s -X POST "$API_URL/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}' | jq .
|
||||
|
||||
echo -e "\n=== 影片列表 ==="
|
||||
curl -s -H "X-API-Key: YOUR_API_KEY" "$API_URL/api/v1/videos" | jq '.videos | length'
|
||||
```
|
||||
|
||||
### 1.5 外部 URL 範例
|
||||
|
||||
```bash
|
||||
# 使用外部 URL(需網路可達)
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 外部搜尋
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. n8n 範例
|
||||
|
||||
### 2.1 HTTP Request Node 設定
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit || 10 }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 2.2 基本搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Video Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Search Video API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.3 Webhook 動態搜尋
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Dynamic Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {
|
||||
"httpMethod": "POST",
|
||||
"path": "search",
|
||||
"responseMode": "lastNode"
|
||||
},
|
||||
"name": "Webhook",
|
||||
"type": "n8n-nodes-base.webhook",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "={{ JSON.stringify($json.body.query) }}",
|
||||
"limit": "={{ $json.body.limit || 5 }}"
|
||||
}
|
||||
},
|
||||
"name": "Search API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Webhook": {
|
||||
"main": [[{"node": "Search API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 測試 Webhook
|
||||
|
||||
```bash
|
||||
# 測試模式(需先在 n8n UI 點擊 Execute)
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
|
||||
# 生產環境(需 workflow 為 Active 狀態)
|
||||
curl -X POST http://localhost:5678/webhook/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
### 2.5 健康檢查 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Health Check",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/health",
|
||||
"method": "GET"
|
||||
},
|
||||
"name": "Health Check",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Health Check"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.6 錯誤處理
|
||||
|
||||
| 錯誤 | 原因 | 解決 |
|
||||
|------|------|------|
|
||||
| 502 Bad Gateway | API 服務未啟動 | `sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist` |
|
||||
| "Your request is invalid" | Body 格式設定錯誤 | 確認 Content Type: JSON,Body 為有效 JSON |
|
||||
| 404 on webhook-test | 未執行 workflow | 在 n8n UI 點擊 "Execute workflow" |
|
||||
|
||||
---
|
||||
|
||||
## 3. WordPress 範例
|
||||
|
||||
### 3.1 PHP 基本用法
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 搜尋影片
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/n8n/search';
|
||||
|
||||
$data = [
|
||||
'query' => 'charade',
|
||||
'limit' => 10
|
||||
];
|
||||
|
||||
$response = wp_remote_post($api_url, [
|
||||
'headers' => ['Content-Type' => 'application/json'],
|
||||
'body' => json_encode($data),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
echo '錯誤: ' . $response->get_error_message();
|
||||
} else {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
print_r($body['hits']);
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.2 列出影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/videos';
|
||||
|
||||
$response = wp_remote_get($api_url, ['timeout' => 30]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
foreach ($body['videos'] as $video) {
|
||||
echo $video['file_name'] . "\n";
|
||||
}
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.3 查詢特定影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$uuid = 'a1b10138a6bbb0cd';
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/lookup?uuid=' . $uuid;
|
||||
|
||||
$response = wp_remote_get($api_url, ['timeout' => 30]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$video = json_decode(wp_remote_retrieve_body($response), true);
|
||||
echo '檔案: ' . $video['file_name'] . "\n";
|
||||
echo '時長: ' . $video['duration'] . ' 秒';
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.4 JavaScript fetch
|
||||
|
||||
```javascript
|
||||
// 搜尋影片
|
||||
async function searchVideos(query, limit = 10) {
|
||||
const response = await fetch('https://api.momentry.ddns.net/api/v1/n8n/search', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ query, limit })
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error('API 請求失敗');
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
// 使用範例
|
||||
searchVideos('charade', 5)
|
||||
.then(data => {
|
||||
data.hits.forEach(hit => {
|
||||
console.log(`${hit.text} (score: ${hit.score})`);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### 3.5 WordPress Shortcode
|
||||
|
||||
在 `functions.php` 中註冊短碼:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 將文件路徑轉換為可訪問的 URL
|
||||
function convert_file_path_to_url($file_path) {
|
||||
// 範例: 將 SFTPGo 文件路徑轉換為 web URL
|
||||
// /Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
// → https://sftpgo.example.com/demo/video.mp4
|
||||
|
||||
// 移除基本路徑
|
||||
$base_path = '/Users/accusys/momentry/var/sftpgo/data/';
|
||||
if (strpos($file_path, $base_path) === 0) {
|
||||
$relative_path = substr($file_path, strlen($base_path));
|
||||
// 替換為實際的 SFTPGo web URL
|
||||
return 'https://sftpgo.example.com/' . $relative_path;
|
||||
}
|
||||
|
||||
// 如果無法轉換,返回原始路徑
|
||||
return $file_path;
|
||||
}
|
||||
|
||||
// 註冊短碼
|
||||
add_shortcode('momentry_search', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'query' => '',
|
||||
'limit' => '10'
|
||||
], $atts);
|
||||
|
||||
if (empty($atts['query'])) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$response = wp_remote_post('https://api.momentry.ddns.net/api/v1/n8n/search', [
|
||||
'headers' => [
|
||||
'Content-Type' => 'application/json',
|
||||
'X-API-Key' => 'YOUR_API_KEY' // 替換為實際的 API Key
|
||||
],
|
||||
'body' => json_encode([
|
||||
'query' => $atts['query'],
|
||||
'limit' => (int)$atts['limit']
|
||||
]),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return '<p>搜尋服務暫時無法使用</p>';
|
||||
}
|
||||
|
||||
$data = json_decode(wp_remote_retrieve_body($response), true);
|
||||
|
||||
if (empty($data['hits'])) {
|
||||
return '<p>找不到相關結果</p>';
|
||||
}
|
||||
|
||||
$output = '<ul class="momentry-results">';
|
||||
foreach ($data['hits'] as $hit) {
|
||||
// 注意: API 現在返回 file_path 而非 media_url
|
||||
// 需要將文件路徑轉換為可訪問的 URL
|
||||
$file_path = $hit['file_path'];
|
||||
$video_url = convert_file_path_to_url($file_path); // 需要實作此函數
|
||||
|
||||
$output .= sprintf(
|
||||
'<li>%s <a href="%s?start=%s">播放</a></li>',
|
||||
esc_html($hit['text']),
|
||||
$video_url,
|
||||
$hit['start']
|
||||
);
|
||||
}
|
||||
$output .= '</ul>';
|
||||
|
||||
return $output;
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```
|
||||
[momentry_search query="charade" limit="5"]
|
||||
```
|
||||
|
||||
### 3.6 WordPress REST API Endpoint
|
||||
|
||||
在 WordPress REST API 中註冊自定義端點:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 註冊 REST API 端點
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'POST',
|
||||
'callback' => function($request) {
|
||||
$response = wp_remote_post(
|
||||
'https://api.momentry.ddns.net/api/v1/n8n/search',
|
||||
[
|
||||
'headers' => ['Content-Type' => 'application/json'],
|
||||
'body' => json_encode([
|
||||
'query' => $request->get_param('query'),
|
||||
'limit' => $request->get_param('limit', 10)
|
||||
])
|
||||
]
|
||||
);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return new WP_Error('api_error', 'API 請求失敗');
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response));
|
||||
}
|
||||
]);
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**呼叫方式**:
|
||||
```
|
||||
POST /wp-json/momentry/v1/search
|
||||
Body: {"query": "charade", "limit": 5}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 回應格式說明
|
||||
|
||||
### 4.1 n8n 格式 (`/api/v1/n8n/search`)
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 10,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0001",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0001",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 標準格式 (`/api/v1/search`)
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "sentence_0001",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92
|
||||
}
|
||||
],
|
||||
"query": "charade"
|
||||
}
|
||||
```
|
||||
|
||||
### 4.3 健康檢查
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "0.1.0",
|
||||
"uptime_ms": 123456
|
||||
}
|
||||
```
|
||||
|
||||
### 4.4 詳細健康檢查
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "0.1.0",
|
||||
"uptime_ms": 123456,
|
||||
"services": {
|
||||
"postgres": {"status": "ok", "latency_ms": 42, "error": null},
|
||||
"redis": {"status": "ok", "latency_ms": 0, "error": null},
|
||||
"qdrant": {"status": "ok", "latency_ms": 15, "error": null},
|
||||
"mongodb": {"status": "ok", "latency_ms": 0, "error": null}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4.5 處理進度
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"overall_progress": 75,
|
||||
"processors": [
|
||||
{"name": "asr", "status": "complete", "progress": 100},
|
||||
{"name": "cut", "status": "complete", "progress": 100},
|
||||
{"name": "yolo", "status": "progress", "progress": 35}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.6 Probe 回應
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"fps": 30.0,
|
||||
"cached": false,
|
||||
"format": {
|
||||
"filename": "/path/to/video.mp4",
|
||||
"format_name": "mov,mp4,m4a,3gp,3g2,mj2",
|
||||
"duration": "120.5",
|
||||
"size": "12345678",
|
||||
"bit_rate": "819200"
|
||||
},
|
||||
"streams": [
|
||||
{
|
||||
"index": 0,
|
||||
"codec_name": "h264",
|
||||
"codec_type": "video",
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"r_frame_rate": "30/1",
|
||||
"duration": "120.5"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. HTTP 狀態碼
|
||||
|
||||
| 狀態 | 說明 | 解決 |
|
||||
|------|------|------|
|
||||
| 200 | 成功 | - |
|
||||
| 400 | 請求格式錯誤 | 檢查 JSON 格式 |
|
||||
| 404 | 端點或資源不存在 | 確認 URL 正確 |
|
||||
| 500 | 伺服器內部錯誤 | 檢查 API 服務日誌 |
|
||||
| 502 | API 服務未啟動 | 見下方說明 |
|
||||
|
||||
### 502 Bad Gateway 解決
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 啟動服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 或使用本地測試
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 常見問題
|
||||
|
||||
### Q: 為什麼有兩個 URL?
|
||||
|
||||
| URL | 用途 |
|
||||
|-----|------|
|
||||
| `localhost:3002` | 直接訪問,繞過反向代理 |
|
||||
| `api.momentry.ddns.net` | 通過 Caddy 反向代理 |
|
||||
|
||||
### Q: 兩者功能相同嗎?
|
||||
|
||||
是的,所有端點和功能完全相同。
|
||||
|
||||
### Q: n8n webhook-test 返回 404?
|
||||
|
||||
需在 n8n UI 中點擊 "Execute workflow" 按鈕後才能使用測試 Webhook。
|
||||
|
||||
### Q: 生產環境 webhook 返回 404?
|
||||
|
||||
需將 workflow 切換為 Active 狀態(右上角開關)。
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 詳細指南
|
||||
- [API_WORDPRESS_GUIDE.md](./API_WORDPRESS_GUIDE.md) - WordPress 詳細指南
|
||||
@@ -1,255 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "API Key Management Integration Tests"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "management"
|
||||
- "integration"
|
||||
- "tests"
|
||||
ai_query_hints:
|
||||
- "查詢 API Key Management Integration Tests 的內容"
|
||||
- "API Key Management Integration Tests 的主要目的是什麼?"
|
||||
- "如何操作或實施 API Key Management Integration Tests?"
|
||||
---
|
||||
|
||||
# API Key Management Integration Tests
|
||||
|
||||
## Test Environment Setup
|
||||
|
||||
### Prerequisites
|
||||
|
||||
```bash
|
||||
# Start services
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
|
||||
# Set environment variables
|
||||
export DATABASE_URL="postgres://accusys@localhost:5432/momentry"
|
||||
export REDIS_URL="redis://:accusys@localhost:6379"
|
||||
export GITEA_URL="http://localhost:3000"
|
||||
export N8N_URL="https://n8n.momentry.ddns.net"
|
||||
```
|
||||
|
||||
### Run Tests
|
||||
|
||||
```bash
|
||||
# Run all unit tests
|
||||
cargo test --lib
|
||||
|
||||
# Run API key specific tests
|
||||
cargo test --lib api_key
|
||||
|
||||
# Run with output
|
||||
cargo test --lib -- --nocapture
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Test Cases
|
||||
|
||||
### 1. API Key Creation
|
||||
|
||||
```bash
|
||||
# Test: Create a service key
|
||||
momentry api-key create test-key --key-type service --ttl 90
|
||||
|
||||
# Expected Output:
|
||||
# ✅ API Key created successfully!
|
||||
# Key ID: msvc_...
|
||||
# API Key: msvc_...
|
||||
# Expires: 2026-06-19
|
||||
```
|
||||
|
||||
### 2. API Key Validation
|
||||
|
||||
```bash
|
||||
# Test: Validate the created key
|
||||
momentry api-key validate --key "msvc_..."
|
||||
|
||||
# Expected Output:
|
||||
# ✅ API Key is valid
|
||||
# Key ID: msvc_...
|
||||
# Name: test-key
|
||||
# Type: service
|
||||
```
|
||||
|
||||
### 3. API Key Listing
|
||||
|
||||
```bash
|
||||
# Test: List all keys
|
||||
momentry api-key list
|
||||
|
||||
# Expected Output:
|
||||
# 📋 API Key List
|
||||
# ┌────────────────────────────────────────────────────────────────────────────┐
|
||||
# │ Status │ Name │ Type │ Usage │ Last Used │
|
||||
# ├────────────────────────────────────────────────────────────────────────────┤
|
||||
# │ ✓ active │ test-key │ "service" │ 0 │ never │
|
||||
# └────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 4. API Key Statistics
|
||||
|
||||
```bash
|
||||
# Test: Show statistics
|
||||
momentry api-key stats
|
||||
|
||||
# Expected Output:
|
||||
# 📊 API Key Statistics
|
||||
# ┌─────────────────────────────────────────┐
|
||||
# │ Total Keys: 1 │
|
||||
# │ Active Keys: 1 │
|
||||
# │ Expired Keys: 0 │
|
||||
# └─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 5. Gitea Token Creation
|
||||
|
||||
```bash
|
||||
# Test: Create Gitea token
|
||||
momentry gitea create \
|
||||
--username admin \
|
||||
--password "Test3200Test3200Test3200" \
|
||||
--token-name "test-token" \
|
||||
--scopes "read:repository,write:repository"
|
||||
|
||||
# Expected Output:
|
||||
# ✅ Gitea Token created successfully!
|
||||
# Token ID: ...
|
||||
# SHA1: ...
|
||||
```
|
||||
|
||||
### 6. n8n API Key Creation
|
||||
|
||||
```bash
|
||||
# Test: Create n8n API key
|
||||
momentry n8n create \
|
||||
--api-key "existing-n8n-key" \
|
||||
--label "test-key" \
|
||||
--expires-in-days 90
|
||||
|
||||
# Expected Output:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# Key ID: ...
|
||||
# API Key: ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Automated Test Script
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# integration_test.sh
|
||||
|
||||
set -e
|
||||
|
||||
echo "=== API Key Integration Tests ==="
|
||||
|
||||
# 1. Create API key
|
||||
echo "1. Testing API key creation..."
|
||||
momentry api-key create integration-test --key-type service --ttl 30
|
||||
echo "✅ API key created"
|
||||
|
||||
# 2. List keys
|
||||
echo "2. Testing API key listing..."
|
||||
momentry api-key list
|
||||
echo "✅ API key list OK"
|
||||
|
||||
# 3. Show stats
|
||||
echo "3. Testing statistics..."
|
||||
momentry api-key stats
|
||||
echo "✅ Statistics OK"
|
||||
|
||||
# 4. Test Gitea integration
|
||||
echo "4. Testing Gitea integration..."
|
||||
GITEA_URL="http://localhost:3000" \
|
||||
momentry gitea list --username admin --password "Test3200Test3200Test3200"
|
||||
echo "✅ Gitea integration OK"
|
||||
|
||||
echo ""
|
||||
echo "=== All Tests Passed ==="
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Unit Test Coverage
|
||||
|
||||
| Module | Tests | Status |
|
||||
|--------|-------|--------|
|
||||
| `models.rs` | 0 | ✅ |
|
||||
| `service.rs` | 5 | ✅ |
|
||||
| `validator.rs` | 2 | ✅ |
|
||||
| `gitea.rs` | 3 | ✅ |
|
||||
| `n8n.rs` | 2 | ✅ |
|
||||
| `rotation.rs` | 4 | ✅ |
|
||||
| `anomaly.rs` | 0 | ✅ |
|
||||
| `blacklist.rs` | 5 | ✅ |
|
||||
| `encryption.rs` | 2 | ✅ |
|
||||
| `webhook.rs` | 2 | ✅ |
|
||||
| `error.rs` | 3 | ✅ |
|
||||
| `report.rs` | 1 | ✅ |
|
||||
| `cleanup.rs` | 1 | ✅ |
|
||||
| **Total** | **30** | **✅** |
|
||||
|
||||
---
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions / Gitea Actions
|
||||
|
||||
```yaml
|
||||
name: API Key Tests
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:15
|
||||
env:
|
||||
POSTGRES_USER: accusys
|
||||
POSTGRES_DB: momentry_test
|
||||
ports:
|
||||
- 5432:5432
|
||||
redis:
|
||||
image: redis:7
|
||||
ports:
|
||||
- 6379:6379
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo test --lib api_key
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Database connection failed**
|
||||
```bash
|
||||
# Check PostgreSQL status
|
||||
pg_isready -h localhost -p 5432
|
||||
```
|
||||
|
||||
2. **Redis connection failed**
|
||||
```bash
|
||||
# Check Redis status
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
3. **Gitea authentication failed**
|
||||
```bash
|
||||
# Verify credentials
|
||||
curl -u admin:password http://localhost:3000/api/v1/user
|
||||
```
|
||||
@@ -1,713 +0,0 @@
|
||||
# Momentry API Key 管理系統設計
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-21 |
|
||||
| 文件版本 | V1.2 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-18 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-20 | 新增 Key 類型與管理流程 | Warren | OpenCode |
|
||||
| V1.2 | 2026-03-21 | 更新 API Key 格式與驗證流程 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
**狀態**: 開發中
|
||||
|
||||
---
|
||||
|
||||
## 1. 概述
|
||||
|
||||
### 1.1 目標
|
||||
|
||||
建立安全的 API Key 管理機制,支援:
|
||||
- 多類型 API Key(系統、用戶、服務)
|
||||
- 自動過期與輪換
|
||||
- 異常使用偵測
|
||||
- 強制更新機制
|
||||
- 完整審計日誌
|
||||
- Gitea Token 整合
|
||||
- n8n API Key 整合
|
||||
|
||||
### 1.2 設計原則
|
||||
|
||||
| 原則 | 說明 |
|
||||
|------|------|
|
||||
| 最小權限 | 每個 Key 僅授予必要權限 |
|
||||
| 定期輪換 | 自動過期強制更新 |
|
||||
| 追蹤可審 | 所有操作都有日誌 |
|
||||
| 分離儲存 | Key 與使用者資料分離 |
|
||||
|
||||
---
|
||||
|
||||
## 2. API Key 類型
|
||||
|
||||
### 2.1 Key 類型矩陣
|
||||
|
||||
| 類型 | 前綴 | 用途 | 預設有效期 | 輪換方式 |
|
||||
|------|------|------|------------|----------|
|
||||
| `system` | `msys_` | 系統內部服務 | 365 天 | 手動 |
|
||||
| `user` | `muser_` | 個人用戶 | 90 天 | 自動 |
|
||||
| `service` | `msvc_` | 服務間通訊 | 180 天 | 自動 |
|
||||
| `integration` | `mint_` | 第三方整合 | 30 天 | 強制更新 |
|
||||
| `emergency` | `memg_` | 緊急存取 | 24 小時 | 一次性 |
|
||||
|
||||
### 2.2 Key 格式
|
||||
|
||||
```
|
||||
{prefix}{uuid_v4}_{timestamp}_{checksum}
|
||||
```
|
||||
|
||||
**範例:**
|
||||
```
|
||||
msys_a1b2c3d4-e5f6-7890-abcd-ef1234567890_1710998400_sha256
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 資料庫 Schema
|
||||
|
||||
### 3.1 api_keys 表
|
||||
|
||||
```sql
|
||||
CREATE TABLE api_keys (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
key_id VARCHAR(64) UNIQUE NOT NULL, -- 公開 Key ID
|
||||
key_hash VARCHAR(128) NOT NULL, -- SHA256 哈希
|
||||
key_prefix VARCHAR(8) NOT NULL, -- Key 前綴
|
||||
name VARCHAR(128) NOT NULL, -- Key 名稱
|
||||
key_type VARCHAR(32) NOT NULL, -- system/user/service/integration/emergency
|
||||
user_id BIGINT, -- 關聯用戶 (nullable for system)
|
||||
service_name VARCHAR(64), -- 服務名稱 (for service keys)
|
||||
permissions JSONB NOT NULL DEFAULT '[]', -- 權限列表
|
||||
expires_at TIMESTAMP, -- 過期時間
|
||||
last_used_at TIMESTAMP, -- 最後使用時間
|
||||
last_used_ip VARCHAR(45), -- 最後使用 IP
|
||||
usage_count BIGINT DEFAULT 0, -- 使用次數
|
||||
status VARCHAR(16) DEFAULT 'active', -- active/suspended/expired/revoked
|
||||
rotation_required BOOLEAN DEFAULT FALSE, -- 強制輪換標記
|
||||
rotation_reason VARCHAR(256), -- 輪換原因
|
||||
created_at TIMESTAMP DEFAULT NOW(),
|
||||
updated_at TIMESTAMP DEFAULT NOW()
|
||||
);
|
||||
|
||||
CREATE INDEX idx_api_keys_key_id ON api_keys(key_id);
|
||||
CREATE INDEX idx_api_keys_user_id ON api_keys(user_id);
|
||||
CREATE INDEX idx_api_keys_type ON api_keys(key_type);
|
||||
CREATE INDEX idx_api_keys_status ON api_keys(status);
|
||||
CREATE INDEX idx_api_keys_expires ON api_keys(expires_at);
|
||||
```
|
||||
|
||||
### 3.2 api_key_audit_log 表
|
||||
|
||||
```sql
|
||||
CREATE TABLE api_key_audit_log (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
key_id VARCHAR(64) NOT NULL,
|
||||
action VARCHAR(32) NOT NULL, -- created/used/rotated/revoked/expired/suspended
|
||||
actor VARCHAR(64), -- 操作者 (user_id or 'system')
|
||||
ip_address VARCHAR(45),
|
||||
user_agent VARCHAR(512),
|
||||
request_path VARCHAR(256),
|
||||
response_code INTEGER,
|
||||
details JSONB,
|
||||
created_at TIMESTAMP DEFAULT NOW()
|
||||
);
|
||||
|
||||
CREATE INDEX idx_audit_key_id ON api_key_audit_log(key_id);
|
||||
CREATE INDEX idx_audit_action ON api_key_audit_log(action);
|
||||
CREATE INDEX idx_audit_created ON api_key_audit_log(created_at);
|
||||
```
|
||||
|
||||
### 3.3 api_key_rotation_log 表
|
||||
|
||||
```sql
|
||||
CREATE TABLE api_key_rotation_log (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
key_id VARCHAR(64) NOT NULL,
|
||||
old_key_id VARCHAR(64),
|
||||
new_key_id VARCHAR(64),
|
||||
rotation_type VARCHAR(32) NOT NULL, -- scheduled/manual/forced/emergency
|
||||
reason VARCHAR(256),
|
||||
triggered_by VARCHAR(64), -- system/user/scheduler
|
||||
grace_period_end TIMESTAMP, -- 寬限期結束時間
|
||||
created_at TIMESTAMP DEFAULT NOW()
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. API Key 狀態機
|
||||
|
||||
```
|
||||
┌──────────────┐
|
||||
│ created │
|
||||
└──────┬───────┘
|
||||
│
|
||||
▼
|
||||
┌────────────────────┐
|
||||
│ active │◄─────────────┐
|
||||
└─────────┬──────────┘ │
|
||||
│ │
|
||||
┌─────────────┼─────────────┐ │
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ │
|
||||
┌──────────┐ ┌──────────┐ ┌──────────┐ │
|
||||
│ suspended │ │ expired │ │ revoked │─────┘
|
||||
└──────────┘ └──────────┘ └──────────┘
|
||||
```
|
||||
|
||||
### 狀態轉換規則
|
||||
|
||||
| 從 | 到 | 觸發條件 |
|
||||
|----|----|----------|
|
||||
| created | active | 啟用 Key |
|
||||
| active | suspended | 異常使用偵測 |
|
||||
| active | expired | 達到過期時間 |
|
||||
| active | revoked | 手動撤銷 |
|
||||
| suspended | active | 解除鎖定 |
|
||||
| suspended | revoked | 確認異常 |
|
||||
| expired | active | 重新啟用 |
|
||||
|
||||
---
|
||||
|
||||
## 5. 異常偵測機制
|
||||
|
||||
### 5.1 異常指標
|
||||
|
||||
| 指標 | 閾值 | 處置 |
|
||||
|------|------|------|
|
||||
| 每分鐘請求數 | > 1000 | 警告 |
|
||||
| 每小時請求數 | > 10000 | 鎖定 |
|
||||
| 錯誤率 | > 50% | 警告 |
|
||||
| 不同 IP 數 | > 5/小時 | 警告 |
|
||||
| 非工作時間使用 | 深夜請求 | 警告 |
|
||||
| 異常模式 | 暴力破解 | 鎖定 |
|
||||
|
||||
### 5.2 異常處理流程
|
||||
|
||||
```
|
||||
異常偵測
|
||||
│
|
||||
▼
|
||||
┌─────────┐
|
||||
│ 分析 │──→ 排除正常流量
|
||||
└────┬────┘
|
||||
│
|
||||
▼
|
||||
┌─────────┐
|
||||
│ 評估 │──→ 輕微 → 警告
|
||||
└────┬────┘
|
||||
│
|
||||
▼
|
||||
┌─────────┐
|
||||
│ 處置 │──→ 嚴重 → 鎖定 + 輪換
|
||||
└─────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 強制更新機制
|
||||
|
||||
### 6.1 觸發條件
|
||||
|
||||
| 條件 | 嚴重性 | 動作 |
|
||||
|------|--------|------|
|
||||
| 疑似洩露 | 高 | 立即停用 + 強制輪換 |
|
||||
| 異常使用 | 中 | 警告 + 建議輪換 |
|
||||
| 計劃性維護 | 低 | 通知 + 排程輪換 |
|
||||
| 政策要求 | 高 | 強制輪換 |
|
||||
| 過期 | 低 | 停用 + 通知 |
|
||||
|
||||
### 6.2 強制輪換流程
|
||||
|
||||
```
|
||||
1. 系統偵測到需要強制更新
|
||||
│
|
||||
▼
|
||||
2. 建立新 Key(保留舊 Key 在寬限期內)
|
||||
│
|
||||
▼
|
||||
3. 發送通知(Email/Slack/Redis PubSub)
|
||||
│
|
||||
▼
|
||||
4. 寬限期開始(預設 24 小時)
|
||||
│
|
||||
├── 在寬限期內更新 → 完成輪換
|
||||
│
|
||||
└── 寬限期結束 → 舊 Key 停用
|
||||
```
|
||||
|
||||
### 6.3 寬限期配置
|
||||
|
||||
| Key 類型 | 寬限期 |
|
||||
|----------|--------|
|
||||
| system | 72 小時 |
|
||||
| user | 24 小時 |
|
||||
| service | 48 小時 |
|
||||
| integration | 24 小時 |
|
||||
| emergency | 0 小時 |
|
||||
|
||||
---
|
||||
|
||||
## 7. CLI 管理命令
|
||||
|
||||
### 7.1 命令列表
|
||||
|
||||
```bash
|
||||
# Key 管理
|
||||
momentry api-key create --name "My Key" --type user --permissions read,write
|
||||
momentry api-key list --type user
|
||||
momentry api-key info <key_id>
|
||||
momentry api-key revoke <key_id> --reason "安全原因"
|
||||
|
||||
# 輪換管理
|
||||
momentry api-key rotate <key_id> # 正常輪換
|
||||
momentry api-key force-rotate <key_id> # 強制輪換
|
||||
momentry api-key rotation-status <key_id> # 查看輪換狀態
|
||||
|
||||
# 異常管理
|
||||
momentry api-key suspend <key_id> --reason "異常使用"
|
||||
momentry api-key unsuspend <key_id>
|
||||
momentry api-key blacklist <key_id> # 列入黑名單
|
||||
|
||||
# 審計
|
||||
momentry api-key audit <key_id> --since 7d
|
||||
momentry api-key stats --type service --period 30d
|
||||
```
|
||||
|
||||
### 7.2 輸出範例
|
||||
|
||||
```bash
|
||||
$ momentry api-key list --type service
|
||||
|
||||
┌────────────────────────────────────┬─────────┬──────────────┬────────────────┐
|
||||
│ Key ID │ Name │ Status │ Expires │
|
||||
├────────────────────────────────────┼─────────┼──────────────┼────────────────┤
|
||||
│ msvc_a1b2c3d4_1710998400_sha256 │ N8N │ active │ 2026-09-21 │
|
||||
│ msvc_e5f6g7h8_1713600000_sha256 │ OpenCode│ rotation_req │ 2026-09-21 │
|
||||
└────────────────────────────────────┴─────────┴──────────────┴────────────────┘
|
||||
|
||||
⚠️ 1 個 Key 需要輪換
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. 實現計畫
|
||||
|
||||
### Phase 1: 核心功能
|
||||
- [ ] 資料庫 Schema
|
||||
- [ ] Key 生成與哈希
|
||||
- [ ] 基本 CRUD API
|
||||
- [ ] 過期檢查
|
||||
|
||||
### Phase 2: 安全機制
|
||||
- [ ] 異常偵測
|
||||
- [ ] 自動鎖定
|
||||
- [ ] 強制輪換
|
||||
- [ ] 寬限期管理
|
||||
|
||||
### Phase 3: 管理工具
|
||||
- [ ] CLI 命令
|
||||
- [ ] 審計日誌
|
||||
- [ ] 統計報表
|
||||
- [ ] 通知系統
|
||||
|
||||
### Phase 4: 自動化
|
||||
- [ ] 定時輪換排程
|
||||
- [ ] Prometheus 指標
|
||||
- [ ] Alertmanager 整合
|
||||
- [ ] 自動化回應
|
||||
|
||||
---
|
||||
|
||||
## 9. 安全考量
|
||||
|
||||
### 9.1 Key 儲存
|
||||
- 明文 Key 只顯示一次(創建時)
|
||||
- 儲存時使用 SHA256 哈希
|
||||
- 使用 Fernet 對稱加密敏感配置
|
||||
|
||||
### 9.2 傳輸安全
|
||||
- 所有 API 必須使用 HTTPS
|
||||
- Key 在 Header 中傳輸(X-API-Key)
|
||||
- 避免 Key 在 URL 中
|
||||
|
||||
### 9.3 存取控制
|
||||
- 只有管理員可創建/撤銷 Key
|
||||
- 用戶只能管理自己的 Key
|
||||
- 系統 Key 需要特殊權限
|
||||
|
||||
---
|
||||
|
||||
## 10. 環境變數配置
|
||||
|
||||
```bash
|
||||
# API Key 管理
|
||||
MOMENTRY_API_KEY_GRACE_PERIOD=86400 # 寬限期(秒)
|
||||
MOMENTRY_API_KEY_MAX_PER_USER=5 # 每用戶最大 Key 數
|
||||
MOMENTRY_API_KEY_ROTATION_DAYS=90 # 自動輪換天數
|
||||
|
||||
# 異常偵測
|
||||
MOMENTRY_API_KEY_RATE_LIMIT=1000 # 每分鐘限制
|
||||
MOMENTRY_API_KEY_ERROR_THRESHOLD=0.5 # 錯誤率閾值
|
||||
MOMENTRY_API_KEY_IP_LIMIT=5 # 每小時 IP 限制
|
||||
|
||||
# 通知
|
||||
MOMENTRY_API_KEY_ALERT_WEBHOOK= # 異常通知 webhook
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. Gitea API Token 整合
|
||||
|
||||
### 11.1 概述
|
||||
|
||||
支援透過 API Key 管理系統建立和管理 Gitea Personal Access Tokens,採用「建立時納管」模式。
|
||||
|
||||
### 11.2 納管模式
|
||||
|
||||
```
|
||||
使用者提供帳號密碼 → 呼叫 Gitea API 建立 Token → 明文只顯示一次 → 同步儲存至管理系統
|
||||
```
|
||||
|
||||
**特點:**
|
||||
- Token 明文僅在建立時取得
|
||||
- 管理系統記錄 Token 元數據(不含明文)
|
||||
- 支援本地查詢和刪除
|
||||
|
||||
### 11.3 資料庫結構
|
||||
|
||||
```sql
|
||||
CREATE TABLE gitea_tokens (
|
||||
id SERIAL PRIMARY KEY,
|
||||
gitea_token_id BIGINT NOT NULL, -- Gitea 內部 Token ID
|
||||
gitea_user VARCHAR(128) NOT NULL, -- Gitea 用戶名
|
||||
token_name VARCHAR(128) NOT NULL, -- Token 名稱
|
||||
token_last_eight VARCHAR(8) NOT NULL, -- SHA1 最後 8 碼(顯示用)
|
||||
scopes JSONB DEFAULT '[]', -- 權限範圍
|
||||
api_key_id VARCHAR(48), -- 關聯的 API Key ID(可選)
|
||||
last_verified TIMESTAMP, -- 最後驗證時間
|
||||
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
UNIQUE(gitea_user, token_name)
|
||||
);
|
||||
```
|
||||
|
||||
### 11.4 Token 權限範圍
|
||||
|
||||
| 範圍 | 說明 |
|
||||
|------|------|
|
||||
| `read:repository` | 讀取倉庫 |
|
||||
| `write:repository` | 寫入倉庫 |
|
||||
| `read:issue` | 讀取議題 |
|
||||
| `write:issue` | 寫入議題 |
|
||||
| `read:user` | 讀取用戶資訊 |
|
||||
| `write:write` | 修改用戶資訊 |
|
||||
| `read:organization` | 讀取組織 |
|
||||
| `write:organization` | 修改組織 |
|
||||
| `read:package` | 讀取套件 |
|
||||
| `write:package` | 發布套件 |
|
||||
| `read:notification` | 讀取通知 |
|
||||
| `write:notification` | 修改通知 |
|
||||
| `read:admin` | 管理員讀取 |
|
||||
| `write:admin` | 管理員寫入 |
|
||||
|
||||
### 11.5 CLI 命令
|
||||
|
||||
#### 建立 Token
|
||||
|
||||
```bash
|
||||
# 基本用法
|
||||
momentry gitea create \
|
||||
--username <gitea_user> \
|
||||
--password <gitea_password> \
|
||||
--token-name <token_name> \
|
||||
--scopes "read:repository,write:repository"
|
||||
|
||||
# 範例:建立整合用 Token
|
||||
momentry gitea create \
|
||||
--username admin \
|
||||
--password "MyPassword123" \
|
||||
--token-name "ci-pipeline" \
|
||||
--scopes "read:repository,write:repository,read:issue,write:issue"
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
✅ Gitea Token created successfully!
|
||||
|
||||
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||
│ ⚠️ IMPORTANT: Save this token now - it will not be shown again! │
|
||||
└─────────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
Token ID: 9
|
||||
Token Name: ci-pipeline
|
||||
SHA1: 9a4f282e9ba817b430082e6bff2c18e2ae38e480
|
||||
Last 8: ae38e480
|
||||
|
||||
Authorization Header:
|
||||
Authorization: token 9a4f282e9ba817b430082e6bff2c18e2ae38e480
|
||||
```
|
||||
|
||||
#### 列出 Token
|
||||
|
||||
```bash
|
||||
# 列出用戶的所有 Token
|
||||
momentry gitea list \
|
||||
--username <gitea_user> \
|
||||
--password <gitea_password>
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
📋 Gitea Tokens for user: admin
|
||||
|
||||
┌────────────────────────────────────────────────────────────────────────────┐
|
||||
│ ID │ Name │ Last 8 │ Registered │
|
||||
├────────────────────────────────────────────────────────────────────────────┤
|
||||
│ 9 │ ci-pipeline │ ae38e480 │ ✓ │
|
||||
│ 8 │ dev-token │ 1234abcd │ - │
|
||||
└────────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
Total: 2 token(s)
|
||||
```
|
||||
|
||||
#### 刪除 Token
|
||||
|
||||
```bash
|
||||
# 刪除指定 Token
|
||||
momentry gitea delete \
|
||||
--username <gitea_user> \
|
||||
--password <gitea_password> \
|
||||
--token-name <token_name>
|
||||
```
|
||||
|
||||
#### 查詢本地記錄
|
||||
|
||||
```bash
|
||||
# 查詢已納管的 Token 記錄
|
||||
momentry gitea verify --token-name <token_name>
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
📋 Gitea Token: ci-pipeline
|
||||
User: admin
|
||||
Token ID: 9
|
||||
Last 8: ae38e480
|
||||
Scopes: ["read:repository","write:repository"]
|
||||
Created: 2026-03-21 06:44:55.577586 UTC
|
||||
Last Verified: never
|
||||
```
|
||||
|
||||
### 11.6 使用範圍
|
||||
|
||||
#### 適用場景
|
||||
|
||||
| 場景 | 說明 |
|
||||
|------|------|
|
||||
| CI/CD 整合 | 建立專用 Token 用於自動化流程 |
|
||||
| 服務間通訊 | 建立 Token 供其他服務存取 Gitea API |
|
||||
| 開發環境 | 為開發者建立短期 Token |
|
||||
| 監控整合 | 建立只讀 Token 用於監控和報告 |
|
||||
|
||||
#### 限制
|
||||
|
||||
| 限制 | 說明 |
|
||||
|------|------|
|
||||
| 明文 Token | 僅在建立時取得,無法再次查詢 |
|
||||
| 管理 API | 需要帳號密碼(BasicAuth) |
|
||||
| Token 驗證 | 只能透過 API 呼叫驗證有效性 |
|
||||
| 同步刪除 | 本地刪除不會自動同步到 Gitea |
|
||||
|
||||
### 11.7 環境變數
|
||||
|
||||
```bash
|
||||
# Gitea 連線設定
|
||||
GITEA_URL=http://localhost:3000 # Gitea API URL
|
||||
```
|
||||
|
||||
### 11.8 安全考量
|
||||
|
||||
| 項目 | 措施 |
|
||||
|------|------|
|
||||
| 密碼傳輸 | 僅在 CLI 命令中使用,不儲存 |
|
||||
| Token 儲存 | 本地僅存元數據,不含明文 |
|
||||
| 權限最小化 | 建議僅授予必要權限 |
|
||||
| 定期輪換 | 建議定期更新 Token |
|
||||
|
||||
---
|
||||
|
||||
## 12. n8n API Key 整合
|
||||
|
||||
### 12.1 概述
|
||||
|
||||
支援透過 API Key 管理系統建立和管理 n8n API Keys,採用「建立時納管」模式。
|
||||
|
||||
### 12.2 納管模式
|
||||
|
||||
```
|
||||
使用者提供現有 n8n API Key → 呼叫 n8n API 建立新 Key → 明文只顯示一次 → 同步儲存至管理系統
|
||||
```
|
||||
|
||||
**特點:**
|
||||
- 需要一個現有的 n8n API Key 作為管理憑證
|
||||
- API Key 明文僅在建立時取得
|
||||
- 管理系統記錄 Key 元數據(不含明文)
|
||||
- 支援本地查詢和刪除
|
||||
|
||||
### 12.3 資料庫結構
|
||||
|
||||
```sql
|
||||
CREATE TABLE n8n_api_keys (
|
||||
id SERIAL PRIMARY KEY,
|
||||
n8n_key_id VARCHAR(64) UNIQUE NOT NULL, -- n8n 內部 Key ID
|
||||
label VARCHAR(100) NOT NULL, -- Key 標籤
|
||||
api_key_last_eight VARCHAR(8) NOT NULL, -- API Key 最後 8 碼(顯示用)
|
||||
momentry_api_key_id VARCHAR(48), -- 關聯的 API Key ID(可選)
|
||||
expires_at TIMESTAMP WITH TIME ZONE, -- 過期時間
|
||||
last_verified TIMESTAMP WITH TIME ZONE, -- 最後驗證時間
|
||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
```
|
||||
|
||||
### 12.4 認證方式
|
||||
|
||||
n8n 使用 JWT-based API Key,透過 `X-N8N-API-KEY` Header 認證:
|
||||
|
||||
```bash
|
||||
curl -H "X-N8N-API-KEY: <your-api-key>" https://n8n.example.com/api/v1/workflows
|
||||
```
|
||||
|
||||
### 12.5 CLI 命令
|
||||
|
||||
#### 建立 API Key
|
||||
|
||||
```bash
|
||||
# 基本用法
|
||||
momentry n8n create \
|
||||
--api-key <existing_n8n_api_key> \
|
||||
--label <key_label> \
|
||||
--expires-in-days <days>
|
||||
|
||||
# 範例:建立 CI/CD 用 Key
|
||||
momentry n8n create \
|
||||
--api_key "n8n_api_xxxxxxxxxxxx" \
|
||||
--label "ci-pipeline" \
|
||||
--expires-in-days 90
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
✅ n8n API Key created successfully!
|
||||
|
||||
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||
│ ⚠️ IMPORTANT: Save this API key now - it will not be shown again! │
|
||||
└─────────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
Key ID: abc123-def456
|
||||
Label: ci-pipeline
|
||||
API Key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
||||
|
||||
Usage:
|
||||
curl -H 'X-N8N-API-KEY: eyJhbGciOiJIUz...' https://n8n.momentry.ddns.net/api/v1/workflows
|
||||
```
|
||||
|
||||
#### 列出 API Keys
|
||||
|
||||
```bash
|
||||
# 列出所有 API Keys
|
||||
momentry n8n list --api-key <existing_n8n_api_key>
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
📋 n8n API Keys
|
||||
|
||||
┌────────────────────────────────────────────────────────────────────────────┐
|
||||
│ Label │ ID │
|
||||
├────────────────────────────────────────────────────────────────────────────┤
|
||||
│ ci-pipeline │ abc123-def456-789 │
|
||||
│ monitoring │ xyz789-abc123-456 │
|
||||
└────────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
Total: 2 key(s)
|
||||
```
|
||||
|
||||
#### 刪除 API Key
|
||||
|
||||
```bash
|
||||
# 刪除指定 API Key
|
||||
momentry n8n delete \
|
||||
--api-key <existing_n8n_api_key> \
|
||||
--label <key_label>
|
||||
```
|
||||
|
||||
#### 查詢本地記錄
|
||||
|
||||
```bash
|
||||
# 查詢已納管的 API Key 記錄
|
||||
momentry n8n verify --label <key_label>
|
||||
```
|
||||
|
||||
**輸出範例:**
|
||||
```
|
||||
📋 n8n API Key: ci-pipeline
|
||||
Key ID: abc123-def456
|
||||
Last 8: ...JVCJ9
|
||||
Created: 2026-03-21 06:44:55.577586 UTC
|
||||
Expires: 2026-06-19 06:44:55.577586 UTC
|
||||
Last Verified: never
|
||||
```
|
||||
|
||||
### 12.6 使用範圍
|
||||
|
||||
#### 適用場景
|
||||
|
||||
| 場景 | 說明 |
|
||||
|------|------|
|
||||
| CI/CD 整合 | 建立專用 Key 用於自動化流程 |
|
||||
| 監控整合 | 建立只讀 Key 用於監控工作流狀態 |
|
||||
| 服務間通訊 | 建立 Key 供其他服務呼叫 n8n API |
|
||||
| 開發環境 | 為開發者建立短期 Key |
|
||||
|
||||
#### 限制
|
||||
|
||||
| 限制 | 說明 |
|
||||
|------|------|
|
||||
| 明文 API Key | 僅在建立時取得,無法再次查詢 |
|
||||
| 管理憑證 | 需要一個現有的 n8n API Key |
|
||||
| 本地刪除 | 不會自動同步到 n8n |
|
||||
| 權限範圍 | 非 Enterprise 版無細粒度權限 |
|
||||
|
||||
### 12.7 環境變數
|
||||
|
||||
```bash
|
||||
# n8n 連線設定
|
||||
N8N_URL=https://n8n.momentry.ddns.net # n8n API URL
|
||||
```
|
||||
|
||||
### 12.8 安全考量
|
||||
|
||||
| 項目 | 措施 |
|
||||
|------|------|
|
||||
| 管理 Key | 需妥善保管,作為管理其他 Key 的憑證 |
|
||||
| API Key 儲存 | 本地僅存元數據,不含明文 |
|
||||
| 過期機制 | 建議設定過期時間 |
|
||||
| 定期輪換 | 建議定期更新 Key |
|
||||
|
||||
---
|
||||
|
||||
## 13. 參考文檔
|
||||
|
||||
- PostgreSQL Schema
|
||||
- Redis Key 設計( MOMENTRY_CORE_REDIS_KEYS.md)
|
||||
- 監控系統(MOMENTRY_CORE_MONITORING.md)
|
||||
- Gitea 安裝指南(INSTALL_GITEA.md)
|
||||
- n8n API 文件(https://docs.n8n.io/api/authentication/)
|
||||
@@ -1,399 +0,0 @@
|
||||
# API Key Management 優化計畫
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V1.0 |
|
||||
| 日期 | 2026-03-21 |
|
||||
| 狀態 | 規劃中 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-21 | 創建優化計畫 | OpenCode | - |
|
||||
|
||||
---
|
||||
|
||||
## 任務編碼規則
|
||||
|
||||
```
|
||||
AKO-{類別}-{序號}
|
||||
AKO = API Key Optimization
|
||||
類別:
|
||||
- CODE = 程式碼品質
|
||||
- PERF = 效能優化
|
||||
- SEC = 安全性
|
||||
- FEAT = 功能增強
|
||||
- DOC = 文件
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: 程式碼品質 (CODE)
|
||||
|
||||
| 編碼 | 任務 | 描述 | 優先級 | 預估工時 | 狀態 |
|
||||
|------|------|------|--------|----------|------|
|
||||
| AKO-CODE-01 | 修復 from_str 警告 | 重命名為 `parse_scope` 或實作 `FromStr` trait | 🔴 高 | 0.5h | ⏳ 待辦 |
|
||||
| AKO-CODE-02 | 函數參數重構 | 使用 Config struct 減少參數數量 | 🔴 高 | 1h | ⏳ 待辦 |
|
||||
| AKO-CODE-03 | 抽象 CRUD Trait | 建立 `ExternalTokenStore` trait 統一 Gitea/n8n | 🟡 中 | 3h | ⏳ 待辦 |
|
||||
| AKO-CODE-04 | 錯誤處理統一 | 使用 `thiserror` 定義自訂錯誤類型 | 🟡 中 | 2h | ⏳ 待辦 |
|
||||
|
||||
### AKO-CODE-01 細節
|
||||
|
||||
```rust
|
||||
// Before
|
||||
impl GiteaScope {
|
||||
pub fn from_str(s: &str) -> Option<Self> { ... }
|
||||
}
|
||||
|
||||
// After: Option A - Rename
|
||||
impl GiteaScope {
|
||||
pub fn parse(s: &str) -> Option<Self> { ... }
|
||||
}
|
||||
|
||||
// After: Option B - Implement FromStr
|
||||
impl std::str::FromStr for GiteaScope {
|
||||
type Err = ();
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> { ... }
|
||||
}
|
||||
```
|
||||
|
||||
### AKO-CODE-02 細節
|
||||
|
||||
```rust
|
||||
// Before
|
||||
pub async fn create_api_key(
|
||||
&self,
|
||||
key_id: &str,
|
||||
key_hash: &str,
|
||||
key_prefix: &str,
|
||||
name: &str,
|
||||
key_type: &str,
|
||||
user_id: Option<i64>,
|
||||
service_name: Option<&str>,
|
||||
permissions: &serde_json::Value,
|
||||
expires_at: Option<DateTime<Utc>>,
|
||||
) -> Result<i64>
|
||||
|
||||
// After
|
||||
pub struct CreateApiKeyConfig<'a> {
|
||||
pub key_id: &'a str,
|
||||
pub key_hash: &'a str,
|
||||
pub key_prefix: &'a str,
|
||||
pub name: &'a str,
|
||||
pub key_type: &'a str,
|
||||
pub user_id: Option<i64>,
|
||||
pub service_name: Option<&'a str>,
|
||||
pub permissions: &'a serde_json::Value,
|
||||
pub expires_at: Option<DateTime<Utc>>,
|
||||
}
|
||||
|
||||
pub async fn create_api_key(&self, config: CreateApiKeyConfig<'_>) -> Result<i64>
|
||||
```
|
||||
|
||||
### AKO-CODE-03 細節
|
||||
|
||||
```rust
|
||||
#[async_trait]
|
||||
pub trait ExternalTokenStore<T> {
|
||||
async fn create(&self, record: T) -> Result<i64>;
|
||||
async fn get_by_label(&self, label: &str) -> Result<Option<T>>;
|
||||
async fn list(&self) -> Result<Vec<T>>;
|
||||
async fn delete(&self, label: &str) -> Result<()>;
|
||||
async fn update_verification(&self, label: &str) -> Result<()>;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: 效能優化 (PERF)
|
||||
|
||||
| 編碼 | 任務 | 描述 | 優先級 | 預估工時 | 狀態 |
|
||||
|------|------|------|--------|----------|------|
|
||||
| AKO-PERF-01 | 連線池配置外部化 | 使用環境變數控制 max_connections | 🟡 中 | 0.5h | ⏳ 待辦 |
|
||||
| AKO-PERF-02 | API Key 驗證快取 | 使用 Moka 快取減少資料庫查詢 | 🔴 高 | 2h | ⏳ 待辦 |
|
||||
| AKO-PERF-03 | 批次查詢優化 | 合併多次查詢為單一 SQL | 🟡 中 | 1h | ⏳ 待辦 |
|
||||
| AKO-PERF-04 | 非同步日誌寫入 | 使用 channel 非同步寫入審計日誌 | 🟢 低 | 2h | ⏳ 待辦 |
|
||||
|
||||
### AKO-PERF-01 細節
|
||||
|
||||
```rust
|
||||
// Before
|
||||
let pool_options = PgPoolOptions::new()
|
||||
.max_connections(10)
|
||||
.acquire_timeout(std::time::Duration::from_secs(60));
|
||||
|
||||
// After
|
||||
let max_conn = std::env::var("DB_MAX_CONNECTIONS")
|
||||
.unwrap_or_else(|_| "10".to_string())
|
||||
.parse()
|
||||
.unwrap_or(10);
|
||||
|
||||
let pool_options = PgPoolOptions::new()
|
||||
.max_connections(max_conn)
|
||||
.acquire_timeout(std::time::Duration::from_secs(60));
|
||||
```
|
||||
|
||||
### AKO-PERF-02 細節
|
||||
|
||||
```rust
|
||||
use moka::future::Cache;
|
||||
use std::time::Duration;
|
||||
|
||||
pub struct ApiKeyCache {
|
||||
cache: Cache<String, CachedApiKey>,
|
||||
}
|
||||
|
||||
pub struct CachedApiKey {
|
||||
pub record: ApiKeyRecord,
|
||||
pub cached_at: chrono::DateTime<chrono::Utc>,
|
||||
}
|
||||
|
||||
impl ApiKeyCache {
|
||||
pub fn new(ttl_seconds: u64, max_capacity: u64) -> Self {
|
||||
Self {
|
||||
cache: Cache::builder()
|
||||
.time_to_live(Duration::from_secs(ttl_seconds))
|
||||
.max_capacity(max_capacity)
|
||||
.build(),
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn get(&self, key_hash: &str) -> Option<ApiKeyRecord> {
|
||||
self.cache.get(key_hash).await.map(|c| c.record)
|
||||
}
|
||||
|
||||
pub async fn insert(&self, key_hash: String, record: ApiKeyRecord) {
|
||||
self.cache.insert(key_hash, CachedApiKey {
|
||||
record,
|
||||
cached_at: chrono::Utc::now(),
|
||||
}).await;
|
||||
}
|
||||
|
||||
pub async fn invalidate(&self, key_hash: &str) {
|
||||
self.cache.invalidate(key_hash).await;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: 安全性 (SEC)
|
||||
|
||||
| 編碼 | 任務 | 描述 | 優先級 | 預估工時 | 狀態 |
|
||||
|------|------|------|--------|----------|------|
|
||||
| AKO-SEC-01 | Constant-time 比較 | 使用 `subtle` crate 防止 timing attack | 🔴 高 | 0.5h | ⏳ 待辦 |
|
||||
| AKO-SEC-02 | Rate Limiter | 限制驗證失敗重試次數 | 🔴 高 | 2h | ⏳ 待辦 |
|
||||
| AKO-SEC-03 | IP 黑名單 | 支援封鎖特定 IP | 🟡 中 | 1.5h | ⏳ 待辦 |
|
||||
| AKO-SEC-04 | 審計日誌加密 | 敏感欄位加密儲存 | 🟡 中 | 2h | ⏳ 待辦 |
|
||||
| AKO-SEC-05 | Key 強度檢查 | 驗證建立的 Key 符合強度要求 | 🟢 低 | 1h | ⏳ 待辦 |
|
||||
|
||||
### AKO-SEC-01 細節
|
||||
|
||||
```rust
|
||||
use subtle::ConstantTimeEq;
|
||||
|
||||
// Before
|
||||
if stored_hash == computed_hash {
|
||||
// valid
|
||||
}
|
||||
|
||||
// After
|
||||
if bool::from(stored_hash.as_bytes().ct_eq(computed_hash.as_bytes())) {
|
||||
// valid
|
||||
}
|
||||
```
|
||||
|
||||
### AKO-SEC-02 細節
|
||||
|
||||
```rust
|
||||
use moka::future::Cache;
|
||||
|
||||
pub struct RateLimiter {
|
||||
attempts: Cache<String, AttemptInfo>,
|
||||
max_attempts: u32,
|
||||
window_seconds: u64,
|
||||
}
|
||||
|
||||
pub struct AttemptInfo {
|
||||
pub count: u32,
|
||||
pub first_attempt: chrono::DateTime<chrono::Utc>,
|
||||
pub locked_until: Option<chrono::DateTime<chrono::Utc>>,
|
||||
}
|
||||
|
||||
impl RateLimiter {
|
||||
pub async fn check(&self, identifier: &str) -> Result<()> {
|
||||
if let Some(info) = self.attempts.get(identifier).await {
|
||||
if let Some(locked_until) = info.locked_until {
|
||||
if chrono::Utc::now() < locked_until {
|
||||
anyhow::bail!("Account locked until {}", locked_until);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn record_failure(&self, identifier: &str) -> Result<()> {
|
||||
let mut info = self.attempts.get(identifier).await
|
||||
.unwrap_or(AttemptInfo {
|
||||
count: 0,
|
||||
first_attempt: chrono::Utc::now(),
|
||||
locked_until: None,
|
||||
});
|
||||
|
||||
info.count += 1;
|
||||
|
||||
if info.count >= self.max_attempts {
|
||||
info.locked_until = Some(
|
||||
chrono::Utc::now() + chrono::Duration::seconds(self.window_seconds as i64)
|
||||
);
|
||||
}
|
||||
|
||||
self.attempts.insert(identifier.to_string(), info).await;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn record_success(&self, identifier: &str) {
|
||||
self.attempts.invalidate(identifier).await;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: 功能增強 (FEAT)
|
||||
|
||||
| 編碼 | 任務 | 描述 | 優先級 | 預估工時 | 狀態 |
|
||||
|------|------|------|--------|----------|------|
|
||||
| AKO-FEAT-01 | 批量建立 Key | 支援 JSON 檔案批量匯入 | 🟡 中 | 3h | ⏳ 待辦 |
|
||||
| AKO-FEAT-02 | 批量撤銷 Key | 支援條件式批量撤銷 | 🟡 中 | 2h | ⏳ 待辦 |
|
||||
| AKO-FEAT-03 | Key 匯出 | 匯出 Key 列表(不含明文) | 🟢 低 | 1.5h | ⏳ 待辦 |
|
||||
| AKO-FEAT-04 | Key 匯入 | 匯入 Key 元數據 | 🟢 低 | 1.5h | ⏳ 待辦 |
|
||||
| AKO-FEAT-05 | Webhook 通知 | 異常發生時發送 Webhook | 🟡 中 | 3h | ⏳ 待辦 |
|
||||
| AKO-FEAT-06 | Email 通知 | Key 到期前提醒 | 🟢 低 | 4h | ⏳ 待辦 |
|
||||
| AKO-FEAT-07 | 統計報表 | 生成使用統計報表 | 🟢 低 | 2h | ⏳ 待辦 |
|
||||
| AKO-FEAT-08 | 清理過期記錄 | 自動清理過期的 Key 記錄 | 🟢 低 | 1h | ⏳ 待辦 |
|
||||
|
||||
### AKO-FEAT-01 細節
|
||||
|
||||
```json
|
||||
// keys.json
|
||||
{
|
||||
"keys": [
|
||||
{
|
||||
"name": "ci-service-1",
|
||||
"key_type": "service",
|
||||
"permissions": ["read", "write"],
|
||||
"ttl_days": 90
|
||||
},
|
||||
{
|
||||
"name": "ci-service-2",
|
||||
"key_type": "service",
|
||||
"permissions": ["read"],
|
||||
"ttl_days": 180
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
momentry api-key batch-create --file keys.json
|
||||
```
|
||||
|
||||
### AKO-FEAT-05 細節
|
||||
|
||||
```rust
|
||||
pub struct WebhookConfig {
|
||||
pub url: String,
|
||||
pub secret: String,
|
||||
pub events: Vec<WebhookEvent>,
|
||||
}
|
||||
|
||||
pub enum WebhookEvent {
|
||||
KeyCreated,
|
||||
KeyRevoked,
|
||||
KeyExpired,
|
||||
AnomalyDetected,
|
||||
RotationRequired,
|
||||
}
|
||||
|
||||
pub struct WebhookNotifier {
|
||||
client: Client,
|
||||
config: WebhookConfig,
|
||||
}
|
||||
|
||||
impl WebhookNotifier {
|
||||
pub async fn notify(&self, event: WebhookEvent, payload: serde_json::Value) -> Result<()> {
|
||||
if !self.config.events.contains(&event) {
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
let signature = self.sign(&payload);
|
||||
|
||||
self.client.post(&self.config.url)
|
||||
.header("X-Webhook-Signature", signature)
|
||||
.json(&serde_json::json!({
|
||||
"event": event,
|
||||
"timestamp": chrono::Utc::now(),
|
||||
"payload": payload,
|
||||
}))
|
||||
.send()
|
||||
.await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: 文件 (DOC)
|
||||
|
||||
| 編碼 | 任務 | 描述 | 優先級 | 預估工時 | 狀態 |
|
||||
|------|------|------|--------|----------|------|
|
||||
| AKO-DOC-01 | API 文件自動生成 | 使用 `utoipa` 生成 OpenAPI | 🟢 低 | 3h | ⏳ 待辦 |
|
||||
| AKO-DOC-02 | CHANGELOG.md | 建立變更日誌 | 🟢 低 | 1h | ⏳ 待辦 |
|
||||
| AKO-DOC-03 | 架構圖 | 添加系統架構圖 | 🟢 低 | 2h | ⏳ 待辦 |
|
||||
| AKO-DOC-04 | 整合測試文件 | 記錄整合測試流程 | 🟢 低 | 1h | ⏳ 待辦 |
|
||||
|
||||
---
|
||||
|
||||
## 總工時估算
|
||||
|
||||
| Phase | 工時 | 任務數 |
|
||||
|-------|------|--------|
|
||||
| CODE | 6.5h | 4 |
|
||||
| PERF | 5.5h | 4 |
|
||||
| SEC | 7h | 5 |
|
||||
| FEAT | 18h | 8 |
|
||||
| DOC | 7h | 4 |
|
||||
| **總計** | **44h** | **25** |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
```bash
|
||||
# 效能
|
||||
DB_MAX_CONNECTIONS=10
|
||||
CACHE_TTL_SECONDS=300
|
||||
CACHE_MAX_CAPACITY=10000
|
||||
|
||||
# 安全
|
||||
RATE_LIMIT_MAX_ATTEMPTS=5
|
||||
RATE_LIMIT_WINDOW_SECONDS=900
|
||||
|
||||
# 通知
|
||||
WEBHOOK_URL=https://example.com/webhook
|
||||
WEBHOOK_SECRET=your-secret
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 參考文件
|
||||
|
||||
- `docs/API_KEY_MANAGEMENT.md` - API Key 管理系統設計
|
||||
- `docs/PENDING_ISSUES.md` - 待解決問題追蹤
|
||||
- `src/core/api_key/` - API Key 模組
|
||||
@@ -1,239 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n 呼叫 Momentry API 指南"
|
||||
date: "2026-03-23"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
ai_query_hints:
|
||||
- "查詢 n8n 呼叫 Momentry API 指南 的內容"
|
||||
- "n8n 呼叫 Momentry API 指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 n8n 呼叫 Momentry API 指南?"
|
||||
---
|
||||
|
||||
# n8n 呼叫 Momentry API 指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-26 | 新增 API Key 驗證說明,更新 HTTP Request Node 設定 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
**用途**: 在 n8n workflow 中呼叫 Momentry API
|
||||
|
||||
---
|
||||
|
||||
## API URL
|
||||
|
||||
在 n8n HTTP Request Node 中,**請使用外部 URL**:
|
||||
|
||||
```
|
||||
https://api.momentry.ddns.net
|
||||
```
|
||||
|
||||
> ⚠️ **不要使用** `localhost:3002`,因為 n8n 需要從外部訪問 API。
|
||||
|
||||
---
|
||||
|
||||
## 常用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/n8n/search` | 語意搜尋(推薦) |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 |
|
||||
|
||||
---
|
||||
|
||||
## HTTP Request Node 設定
|
||||
|
||||
### 語意搜尋(推薦)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit || 10 }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 測試用(固定關鍵字)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Send Body: ✓
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "charade",
|
||||
│ "limit": 3
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 完整 Workflow 範例
|
||||
|
||||
### 基本搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Video Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Search Video API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 動態查詢 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Dynamic Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {
|
||||
"httpMethod": "POST",
|
||||
"path": "search",
|
||||
"responseMode": "lastNode"
|
||||
},
|
||||
"name": "Webhook",
|
||||
"type": "n8n-nodes-base.webhook",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "={{ JSON.stringify($json.body.query) }}",
|
||||
"limit": "={{ $json.body.limit || 5 }}"
|
||||
}
|
||||
},
|
||||
"name": "Search API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Webhook": {
|
||||
"main": [[{"node": "Search API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤
|
||||
|
||||
### 錯誤: 502 Bad Gateway
|
||||
|
||||
**原因**: API 服務未啟動
|
||||
|
||||
**解決**:
|
||||
```bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
### 錯誤: "Your request is invalid"
|
||||
|
||||
**原因**: Body 格式設定錯誤
|
||||
|
||||
**正確設定**:
|
||||
- `Content Type`: JSON
|
||||
- `Body`: 必須是有效的 JSON 物件
|
||||
|
||||
---
|
||||
|
||||
## curl 測試
|
||||
|
||||
在終端機中測試 API:
|
||||
|
||||
> **注意**: 所有 `/api/v1/*` 端點都需要 API Key 驗證。請設定環境變數或直接替換 API Key。
|
||||
|
||||
```bash
|
||||
# 設定環境變數(使用您的 API Key)
|
||||
export MOMENTRY_API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
```
|
||||
|
||||
```bash
|
||||
# 健康檢查
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 搜尋測試 (需要 API Key)
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: $MOMENTRY_API_KEY" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [N8N_HTTP_REQUEST_GUIDE.md](./N8N_HTTP_REQUEST_GUIDE.md) - HTTP Request 詳細設定
|
||||
@@ -1,391 +0,0 @@
|
||||
# Momentry Core API 教育訓練手冊
|
||||
|
||||
> **對象**: marcom 團隊
|
||||
> **版本**: V1.4 | **日期**: 2026-03-25
|
||||
|
||||
---
|
||||
|
||||
## 1. 快速開始
|
||||
|
||||
### 基本資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| API 網址 | `https://api.momentry.ddns.net` |
|
||||
| 認證方式 | Header `X-API-Key` |
|
||||
| 格式 | JSON |
|
||||
|
||||
### Demo 測試帳號
|
||||
|
||||
#### API Key(用於 API 認證)
|
||||
|
||||
```
|
||||
X-API-Key: muser_68600856036340bcafc01930eb4bd839
|
||||
```
|
||||
|
||||
#### SFTPGo(用於影片上傳)
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| SFTP 主機 | `sftpgo.momentry.ddns.net` |
|
||||
| SFTP 連接埠 | `2022` |
|
||||
| 用戶名 | `demo` |
|
||||
| 密碼 | `demopassword123` |
|
||||
| Web 管理介面 | `https://sftpgo.momentry.ddns.net` |
|
||||
|
||||
**使用方式**:透過 SFTP 上傳影片,系統會自動註冊並處理。
|
||||
|
||||
---
|
||||
|
||||
## 2. 快速範例
|
||||
|
||||
### 查詢所有影片
|
||||
|
||||
```bash
|
||||
curl -s -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
"https://api.momentry.ddns.net/api/v1/videos"
|
||||
```
|
||||
|
||||
### 查詢單一影片
|
||||
|
||||
```bash
|
||||
curl -s -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
"https://api.momentry.ddns.net/api/v1/videos/{uuid}"
|
||||
```
|
||||
|
||||
### 查詢處理任務狀態
|
||||
|
||||
```bash
|
||||
curl -s -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
"https://api.momentry.ddns.net/api/v1/jobs/{uuid}"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. API 端點說明
|
||||
|
||||
### 3.1 影片相關
|
||||
|
||||
#### GET /api/v1/videos
|
||||
取得所有影片列表
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"videos": [
|
||||
{
|
||||
"uuid": "5dea6618a606e7c7",
|
||||
"filename": "demo_video.mp4",
|
||||
"duration": 123.45,
|
||||
"status": "ready",
|
||||
"created_at": "2026-03-25T10:00:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /api/v1/videos/:uuid
|
||||
取得單一影片詳情
|
||||
|
||||
### 3.2 搜尋與分段查詢
|
||||
|
||||
#### POST /api/v1/search
|
||||
向量搜尋,查詢分段(Chunk)詳情
|
||||
|
||||
**請求參數**:
|
||||
| 參數 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| `query` | string | 是 | 搜尋關鍵字 |
|
||||
| `limit` | number | 否 | 回傳數量(預設 10) |
|
||||
| `uuid` | string | 否 | 只搜尋指定影片 |
|
||||
|
||||
**請求範例**:
|
||||
```json
|
||||
{
|
||||
"query": "天氣",
|
||||
"limit": 10,
|
||||
"uuid": "5dea6618a606e7c7"
|
||||
}
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "39567a0eb16f39fd",
|
||||
"chunk_id": "sentence_1471",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 5309.08,
|
||||
"end_time": 5311.08,
|
||||
"text": "influenced by a vital way,",
|
||||
"score": 0.68
|
||||
}
|
||||
],
|
||||
"query": "天氣"
|
||||
}
|
||||
```
|
||||
|
||||
**Chunk 欄位說明**:
|
||||
| 欄位 | 說明 | 範例 |
|
||||
|------|------|------|
|
||||
| `uuid` | 影片唯一識別碼 | `39567a0eb16f39fd` |
|
||||
| `chunk_id` | 分段識別碼 | `sentence_1471` |
|
||||
| `chunk_type` | 分段類型 | `sentence` / `cut` / `time` / `trace` / `story` |
|
||||
| `start_time` | 開始時間(秒) | `5309.08` |
|
||||
| `end_time` | 結束時間(秒) | `5311.08` |
|
||||
| `text` | 內容文字 | `influenced by a vital way` |
|
||||
| `score` | 相似度分數(0-1) | `0.68` |
|
||||
|
||||
**Chunk 類型說明**:
|
||||
| 類型 | 說明 | 來源 |
|
||||
|------|------|------|
|
||||
| `sentence` | 語音轉文字片段 | ASR 處理 |
|
||||
| `cut` | 場景變化片段 | CUT 處理 |
|
||||
| `time` | 固定時間分段 | 系統自動切割 |
|
||||
| `trace` | 軌跡追蹤片段 | YOLO 追蹤 |
|
||||
| `story` | 故事線片段(父子關係) | Story 分析 |
|
||||
|
||||
#### POST /api/v1/n8n/search
|
||||
n8n 專用搜尋(包含完整影片檔案路徑 file_path)
|
||||
|
||||
**請求參數**: 與 `/search` 相同
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"query": "天氣",
|
||||
"count": 2,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_1471",
|
||||
"vid": "39567a0eb16f39fd",
|
||||
"chunk_type": "sentence",
|
||||
"start_frame": 318545,
|
||||
"end_frame": 318665,
|
||||
"fps": 59.94,
|
||||
"start_time": 5314.31,
|
||||
"end_time": 5316.32,
|
||||
"text": "influenced by a vital way,",
|
||||
"score": 0.68
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**與 /search 的差異**:
|
||||
| 欄位 | `/search` | `/n8n/search` |
|
||||
|------|-----------|----------------|
|
||||
| 影片 UUID | `uuid` | `vid` |
|
||||
| Chunk ID | `chunk_id` | `id` |
|
||||
| 開始時間 | `start_time` | `start_time` |
|
||||
| 結束時間 | `end_time` | `end_time` |
|
||||
| 相似度分數 | `score` | `score` |
|
||||
| **檔案路徑** | ❌ | ✅ `file_path` |
|
||||
|
||||
> **注意**: `file_path` 是影片的實際路徑,可用於本地播放。
|
||||
|
||||
### 3.3 任務相關
|
||||
|
||||
### 3.4 任務相關
|
||||
|
||||
#### GET /api/v1/jobs/:uuid
|
||||
查詢處理任務狀態
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"uuid": "9760d0820f0cf9a7",
|
||||
"file_uuid": "5dea6618a606e7c7",
|
||||
"status": "completed",
|
||||
"progress": 100,
|
||||
"created_at": "2026-03-25T10:00:00Z",
|
||||
"completed_at": "2026-03-25T10:05:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /api/v1/jobs
|
||||
查詢所有任務
|
||||
|
||||
**查詢參數**:
|
||||
| 參數 | 說明 | 範例 |
|
||||
|------|------|------|
|
||||
| `status` | 篩選狀態 | `pending`, `processing`, `completed`, `failed` |
|
||||
| `limit` | 回傳數量 | `10` |
|
||||
|
||||
**範例**:
|
||||
```bash
|
||||
curl -s -H "X-API-Key: ..." \
|
||||
"https://api.momentry.ddns.net/api/v1/jobs?status=completed&limit=5"
|
||||
```
|
||||
|
||||
### 3.5 系統管理
|
||||
|
||||
#### POST /api/v1/config/cache
|
||||
切換快取功能(管理員專用)
|
||||
|
||||
**請求範例**:
|
||||
```json
|
||||
{
|
||||
"enabled": true
|
||||
}
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"cache_enabled": true,
|
||||
"message": "Cache toggled successfully"
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /api/v1/unregister
|
||||
刪除影片及其所有關聯資料(管理員專用)
|
||||
|
||||
**請求範例**:
|
||||
```json
|
||||
{
|
||||
"uuid": "5dea6618a606e7c7"
|
||||
}
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Video unregistered successfully",
|
||||
"uuid": "5dea6618a606e7c7"
|
||||
}
|
||||
```
|
||||
|
||||
**注意**: 此操作會刪除影片及其所有分段、處理結果、縮圖等關聯資料,**無法復原**。
|
||||
|
||||
### 3.6 健康檢查
|
||||
|
||||
#### GET /health
|
||||
服務健康狀態(**無需認證**)
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "0.9.20260325_144654"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. n8n Workflow 範例
|
||||
|
||||
### 4.1 基本設定
|
||||
|
||||
在 n8n workflow 中使用 HTTP Request 節點:
|
||||
|
||||
```
|
||||
┌─────────────────┐
|
||||
│ HTTP Request │
|
||||
├─────────────────┤
|
||||
│ Method: GET │
|
||||
│ URL: https://api.momentry.ddns.net/api/v1/videos
|
||||
│ Headers: │
|
||||
│ X-API-Key: │
|
||||
│ [YOUR_KEY] │
|
||||
└────────┬────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ 處理回應資料 │
|
||||
└─────────────────┘
|
||||
```
|
||||
|
||||
### 4.2 範例:檢查任務狀態
|
||||
|
||||
```javascript
|
||||
// n8n Function Node 範例
|
||||
const jobUuid = $input.item.json.uuid;
|
||||
|
||||
return [{
|
||||
json: {
|
||||
method: "GET",
|
||||
url: `https://api.momentry.ddns.net/api/v1/jobs/${jobUuid}`,
|
||||
headers: {
|
||||
"X-API-Key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
}];
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 常見問題
|
||||
|
||||
### Q: 返回 401 錯誤怎麼辦?
|
||||
確認 Header 中有正確的 `X-API-Key` 值
|
||||
|
||||
### Q: 如何確認影片處理完成?
|
||||
```
|
||||
GET /api/v1/jobs/{uuid}
|
||||
```
|
||||
檢查 `status` 是否為 `completed`
|
||||
|
||||
### Q: 查不到資料?
|
||||
確認 UUID 格式正確(16碼 hex 字串)
|
||||
|
||||
---
|
||||
|
||||
## 6. 快速參考卡
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Momentry API 速查 │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ 查詢所有影片 GET /api/v1/videos │
|
||||
│ 查詢單一影片 GET /api/v1/videos/:uuid │
|
||||
│ 向量搜尋 POST /api/v1/search │
|
||||
│ n8n 搜尋 POST /api/v1/n8n/search │
|
||||
│ 查詢任務狀態 GET /api/v1/jobs/:uuid │
|
||||
│ 查詢所有任務 GET /api/v1/jobs │
|
||||
│ 快取設定 POST /api/v1/config/cache (管理員) │
|
||||
│ 刪除影片 POST /api/v1/unregister (管理員) │
|
||||
│ 健康檢查 GET /health (免認證) │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ Header: X-API-Key: [YOUR_KEY] │
|
||||
│ URL: https://api.momentry.ddns.net │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 附錄:回應狀態說明
|
||||
|
||||
### 任務狀態 (status)
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `pending` | 等待處理 |
|
||||
| `processing` | 處理中 |
|
||||
| `completed` | 已完成 |
|
||||
| `failed` | 處理失敗 |
|
||||
|
||||
### 影片狀態 (status)
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `uploading` | 上傳中 |
|
||||
| `pending` | 等待處理 |
|
||||
| `processing` | 處理中 |
|
||||
| `ready` | 已就緒 |
|
||||
| `error` | 錯誤 |
|
||||
|
||||
---
|
||||
|
||||
## 附錄:版本歷史
|
||||
|
||||
| 版本 | 日期 | 內容 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-25 | 初版建立 | OpenCode |
|
||||
| V1.1 | 2026-03-25 | 新增快取/刪除 API、搜尋端點文件 | OpenCode |
|
||||
| V1.2 | 2026-03-25 | 新增 Chunk 欄位說明、類型、播放方式 | OpenCode |
|
||||
| V1.3 | 2026-03-25 | 新增 Demo 測試帳號(SFTPGo)| OpenCode |
|
||||
| V1.4 | 2026-03-25 | 更新 n8n 搜尋回傳欄位說明 (media_url→file_path) | OpenCode |
|
||||
| V1.5 | 2026-04-17 | 修正 API Key 格式、統一 n8n/search 欄位名稱 (start/end → start_time/end_time) | OpenCode |
|
||||
@@ -1,343 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "WORDPRESS"
|
||||
title: "WordPress 呼叫 Momentry API 指南"
|
||||
date: "2026-03-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "wordpress"
|
||||
ai_query_hints:
|
||||
- "查詢 WordPress 呼叫 Momentry API 指南 的內容"
|
||||
- "WordPress 呼叫 Momentry API 指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 WordPress 呼叫 Momentry API 指南?"
|
||||
---
|
||||
|
||||
# WordPress 呼叫 Momentry API 指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V1.1 |
|
||||
| 日期 | 2026-03-25 |
|
||||
| 用途 | 在 WordPress 中呼叫 Momentry API |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.1 | 2026-03-25 | 更新: n8n 搜尋回傳 `file_path` 取代 `media_url`,新增 API Key 驗證說明 | OpenCode | deepseek-reasoner |
|
||||
| V1.0 | 2026-03-23 | 創建 WordPress API 指南 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## API URL
|
||||
|
||||
在 WordPress 中呼叫 API,**請使用外部 URL**:
|
||||
|
||||
```
|
||||
https://api.momentry.ddns.net
|
||||
```
|
||||
|
||||
> ⚠️ WordPress 運行於瀏覽器端,無法直接訪問 `localhost`。
|
||||
|
||||
---
|
||||
|
||||
## API 認證
|
||||
|
||||
所有 `/api/v1/*` 端點(除了健康檢查)都需要 API Key 認證。請在請求標頭中加入:
|
||||
|
||||
```
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY']
|
||||
```
|
||||
|
||||
**目前示範使用的 API Key**: `muser_68600856036340bcafc01930eb4bd839`
|
||||
|
||||
> **注意**: 正式環境請使用安全的 API Key 管理機制,避免在客戶端 JavaScript 中暴露 API Key。
|
||||
|
||||
---
|
||||
|
||||
## 常用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋(標準格式) |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
|
||||
---
|
||||
|
||||
## PHP 範例
|
||||
|
||||
### 基本搜尋
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/n8n/search';
|
||||
|
||||
$data = [
|
||||
'query' => 'charade',
|
||||
'limit' => 10
|
||||
];
|
||||
|
||||
$response = wp_remote_post($api_url, [
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY'],
|
||||
'body' => json_encode($data),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
echo '錯誤: ' . $response->get_error_message();
|
||||
} else {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
print_r($body['hits']);
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 列出所有影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/videos';
|
||||
|
||||
$response = wp_remote_get($api_url, [
|
||||
'headers' => ['X-API-Key' => 'YOUR_API_KEY'],
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
foreach ($body['videos'] as $video) {
|
||||
echo $video['file_name'] . "\n";
|
||||
}
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 查詢特定影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$uuid = '5dea6618a606e7c7';
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/lookup?uuid=' . $uuid;
|
||||
|
||||
$response = wp_remote_get($api_url, [
|
||||
'headers' => ['X-API-Key' => 'YOUR_API_KEY'],
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$video = json_decode(wp_remote_retrieve_body($response), true);
|
||||
echo '檔案: ' . $video['file_name'] . "\n";
|
||||
echo '時長: ' . $video['duration'] . ' 秒';
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## JavaScript 範例
|
||||
|
||||
### 使用 fetch
|
||||
|
||||
```javascript
|
||||
// 搜尋影片
|
||||
async function searchVideos(query, limit = 10) {
|
||||
const response = await fetch('https://api.momentry.ddns.net/api/v1/n8n/search', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json', 'X-API-Key': 'YOUR_API_KEY' },
|
||||
body: JSON.stringify({ query, limit })
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error('API 請求失敗');
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
// 使用範例
|
||||
searchVideos('charade', 5)
|
||||
.then(data => {
|
||||
data.hits.forEach(hit => {
|
||||
console.log(`${hit.text} (score: ${hit.score})`);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## WordPress Shortcode 範例
|
||||
|
||||
在 `functions.php` 中註冊短碼:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 將文件路徑轉換為可訪問的 URL
|
||||
function convert_file_path_to_url($file_path) {
|
||||
// 範例: 將 SFTPGo 文件路徑轉換為 web URL
|
||||
// /Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
// → https://sftpgo.example.com/demo/video.mp4
|
||||
|
||||
// 移除基本路徑
|
||||
$base_path = '/Users/accusys/momentry/var/sftpgo/data/';
|
||||
if (strpos($file_path, $base_path) === 0) {
|
||||
$relative_path = substr($file_path, strlen($base_path));
|
||||
// 替換為實際的 SFTPGo web URL
|
||||
return 'https://sftpgo.example.com/' . $relative_path;
|
||||
}
|
||||
|
||||
// 如果無法轉換,返回原始路徑
|
||||
return $file_path;
|
||||
}
|
||||
|
||||
// 註冊短碼
|
||||
add_shortcode('momentry_search', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'query' => '',
|
||||
'limit' => '10'
|
||||
], $atts);
|
||||
|
||||
if (empty($atts['query'])) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$response = wp_remote_post('https://api.momentry.ddns.net/api/v1/n8n/search', [
|
||||
'headers' => [
|
||||
'Content-Type' => 'application/json',
|
||||
'X-API-Key' => 'YOUR_API_KEY' // 替換為實際的 API Key
|
||||
],
|
||||
'body' => json_encode([
|
||||
'query' => $atts['query'],
|
||||
'limit' => (int)$atts['limit']
|
||||
]),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return '<p>搜尋服務暫時無法使用</p>';
|
||||
}
|
||||
|
||||
$data = json_decode(wp_remote_retrieve_body($response), true);
|
||||
|
||||
if (empty($data['hits'])) {
|
||||
return '<p>找不到相關結果</p>';
|
||||
}
|
||||
|
||||
$output = '<ul class="momentry-results">';
|
||||
foreach ($data['hits'] as $hit) {
|
||||
// 注意: API 現在返回 file_path 而非 media_url
|
||||
// 需要將文件路徑轉換為可訪問的 URL
|
||||
$file_path = $hit['file_path'];
|
||||
$video_url = convert_file_path_to_url($file_path); // 需要實作此函數
|
||||
|
||||
$output .= sprintf(
|
||||
'<li>%s <a href="%s?start=%s">播放</a></li>',
|
||||
esc_html($hit['text']),
|
||||
$video_url,
|
||||
$hit['start']
|
||||
);
|
||||
}
|
||||
$output .= '</ul>';
|
||||
|
||||
return $output;
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```
|
||||
[momentry_search query="charade" limit="5"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## REST API Endpoint (WP >= 5.0)
|
||||
|
||||
在 WordPress REST API 中註冊自定義端點:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 註冊 REST API 端點
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'POST',
|
||||
'callback' => function($request) {
|
||||
$response = wp_remote_post(
|
||||
'https://api.momentry.ddns.net/api/v1/n8n/search',
|
||||
[
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY'],
|
||||
'body' => json_encode([
|
||||
'query' => $request->get_param('query'),
|
||||
'limit' => $request->get_param('limit', 10)
|
||||
])
|
||||
]
|
||||
);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return new WP_Error('api_error', 'API 請求失敗');
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response));
|
||||
}
|
||||
]);
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**呼叫方式**:
|
||||
```
|
||||
POST /wp-json/momentry/v1/search
|
||||
Body: {"query": "charade", "limit": 5}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤
|
||||
|
||||
### 錯誤: cURL error 7
|
||||
|
||||
**原因**: 無法連接到 API
|
||||
|
||||
**檢查**:
|
||||
1. API 服務是否啟動
|
||||
2. 網路是否可達
|
||||
|
||||
### 錯誤: 502 Bad Gateway
|
||||
|
||||
**原因**: API 服務未啟動
|
||||
|
||||
**解決**:
|
||||
```bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## curl 測試
|
||||
|
||||
在終端機中測試:
|
||||
|
||||
```bash
|
||||
# 健康檢查
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 搜尋測試
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":5}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 使用範例
|
||||
@@ -1,686 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry Core 版本紀錄"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "core"
|
||||
- "版本紀錄"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry Core 版本紀錄 的內容"
|
||||
- "Momentry Core 版本紀錄 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry Core 版本紀錄?"
|
||||
---
|
||||
|
||||
# Momentry Core 版本紀錄
|
||||
|
||||
## 版本命名規則
|
||||
|
||||
### Main Version (主版本)
|
||||
```
|
||||
v{major}.{minor}
|
||||
例: v0.1, v0.2, v1.0
|
||||
```
|
||||
|
||||
### Build Version (建置版本)
|
||||
```
|
||||
v{major}.{minor}.{YYYYMMDD_HHMMSS}
|
||||
例: v0.1.20260325_143000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本紀錄存放位置
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/versions/
|
||||
├── current/ # 目前使用版本
|
||||
│ ├── binary # 當前 binary
|
||||
│ └── version.json # 版本資訊
|
||||
│
|
||||
├── releases/ # Release 版本存放
|
||||
│ ├── v0.1/
|
||||
│ │ ├── v0.1.20260325_143000/
|
||||
│ │ │ ├── binary
|
||||
│ │ │ └── version.json
|
||||
│ │ ├── v0.1.20260324_100000/
|
||||
│ │ │ └── ...
|
||||
│ │ └── release.json # v0.1 版本總覽
|
||||
│ │
|
||||
│ └── v0.2/
|
||||
│ └── ...
|
||||
│
|
||||
└── changelog.json # 全域版本變更記錄
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## version.json 格式
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "v0.1.20260325_143000",
|
||||
"main_version": "v0.1",
|
||||
"build_timestamp": "2026-03-25T14:30:00+08:00",
|
||||
"git_commit": "83ae050",
|
||||
"git_branch": "main",
|
||||
"git_message": "fix: save probe.json to OUTPUT_DIR instead of current directory",
|
||||
"features": [
|
||||
"API Key Authentication",
|
||||
"Job Worker System"
|
||||
],
|
||||
"fixes": [
|
||||
"get_processor_results_by_job column mapping"
|
||||
],
|
||||
"deployed_at": "2026-03-25T15:00:00+08:00",
|
||||
"deployed_by": "opencode",
|
||||
"status": "production"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## release.json 格式 (主版本總覽)
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "v0.1",
|
||||
"status": "production",
|
||||
"created_at": "2026-03-14T10:00:00+08:00",
|
||||
"current_build": "v0.1.20260325_143000",
|
||||
"builds": [
|
||||
{
|
||||
"build": "v0.1.20260325_143000",
|
||||
"date": "2026-03-25",
|
||||
"commits": ["83ae050", "171c36a"],
|
||||
"summary": "fix: save probe.json, add v2 backup versioning"
|
||||
},
|
||||
{
|
||||
"build": "v0.1.20260324_100000",
|
||||
"date": "2026-03-24",
|
||||
"commits": ["89fbfd6", "3edaf01"],
|
||||
"summary": "feat: add POST /api/v1/probe endpoint"
|
||||
}
|
||||
],
|
||||
"changelog": [
|
||||
"## v0.1.20260325_143000",
|
||||
"- 修復 processor_results 欄位映射錯誤",
|
||||
"- 添加 API Key 認證",
|
||||
"",
|
||||
"## v0.1.20260324_100000",
|
||||
"- 新增 Probe API"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## changelog.json 格式 (全域變更記錄)
|
||||
|
||||
```json
|
||||
{
|
||||
"updated_at": "2026-03-25T14:30:00+08:00",
|
||||
"versions": {
|
||||
"v0.1": {
|
||||
"status": "production",
|
||||
"current_build": "v0.1.20260325_143000",
|
||||
"build_count": 12
|
||||
},
|
||||
"v0.0": {
|
||||
"status": "deprecated",
|
||||
"final_build": "v0.0.20260310_090000"
|
||||
}
|
||||
},
|
||||
"recent_changes": [
|
||||
{
|
||||
"version": "v0.1.20260325_143000",
|
||||
"date": "2026-03-25",
|
||||
"changes": [
|
||||
{"type": "fix", "description": "get_processor_results_by_job column mapping"},
|
||||
{"type": "feat", "description": "API Key Authentication"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Script
|
||||
|
||||
### /Users/accusys/momentry/scripts/release.sh
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
PROJECT_DIR="/Users/accusys/momentry_core_0.1"
|
||||
VERSIONS_DIR="/Users/accusys/momentry/versions"
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/bin"
|
||||
CURRENT_BIN="/Users/accusys/momentry/bin/momentry"
|
||||
|
||||
# 顏色輸出
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m'
|
||||
|
||||
log_info() { echo -e "${GREEN}[INFO]${NC} $1"; }
|
||||
log_warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
|
||||
log_error() { echo -e "${RED}[ERROR]${NC} $1"; }
|
||||
|
||||
# 解析命令列參數
|
||||
MAIN_VERSION=""
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
-v|--version)
|
||||
MAIN_VERSION="$2"
|
||||
shift 2
|
||||
;;
|
||||
*)
|
||||
log_error "Unknown option: $1"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ -z "$MAIN_VERSION" ]; then
|
||||
log_error "請指定主版本: ./release.sh -v v0.1"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log_info "開始 Release ${MAIN_VERSION}..."
|
||||
|
||||
# 1. 取得 Git 資訊
|
||||
GIT_COMMIT=$(git -C "$PROJECT_DIR" rev-parse --short HEAD)
|
||||
GIT_BRANCH=$(git -C "$PROJECT_DIR" rev-parse --abbrev-ref HEAD)
|
||||
GIT_MESSAGE=$(git -C "$PROJECT_DIR" log -1 --pretty=%s)
|
||||
BUILD_TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BUILD_VERSION="${MAIN_VERSION}.${BUILD_TIMESTAMP}"
|
||||
|
||||
log_info "Build Version: ${BUILD_VERSION}"
|
||||
log_info "Git Commit: ${GIT_COMMIT}"
|
||||
|
||||
# 2. 創建版本目錄
|
||||
BUILD_DIR="${VERSIONS_DIR}/releases/${MAIN_VERSION}/${BUILD_VERSION}"
|
||||
mkdir -p "$BUILD_DIR"
|
||||
mkdir -p "${VERSIONS_DIR}/current"
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 3. 停止 Production Service
|
||||
log_info "停止 Production Service..."
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist 2>/dev/null || true
|
||||
|
||||
# 4. 備份當前 Binary
|
||||
if [ -f "$CURRENT_BIN" ]; then
|
||||
OLD_VERSION=$(cat "${VERSIONS_DIR}/current/version.json" 2>/dev/null | jq -r '.version // "unknown"')
|
||||
log_info "備份當前版本: $OLD_VERSION"
|
||||
cp "$CURRENT_BIN" "${BACKUP_DIR}/momentry_${OLD_VERSION}_$(date +%Y%m%d_%H%M%S)"
|
||||
fi
|
||||
|
||||
# 5. 編譯 Release 版本
|
||||
log_info "編譯 Release 版本..."
|
||||
cd "$PROJECT_DIR"
|
||||
cargo build --release --bin momentry
|
||||
|
||||
# 6. 複製到版本目錄
|
||||
log_info "複製到版本目錄..."
|
||||
cp target/release/momentry "${BUILD_DIR}/binary"
|
||||
cp target/release/momentry "$CURRENT_BIN"
|
||||
|
||||
# 7. 生成 version.json
|
||||
cat > "${BUILD_DIR}/version.json" << EOF
|
||||
{
|
||||
"version": "${BUILD_VERSION}",
|
||||
"main_version": "${MAIN_VERSION}",
|
||||
"build_timestamp": "$(date -Iseconds)",
|
||||
"git_commit": "${GIT_COMMIT}",
|
||||
"git_branch": "${GIT_BRANCH}",
|
||||
"git_message": "${GIT_MESSAGE}",
|
||||
"features": [],
|
||||
"fixes": [],
|
||||
"deployed_at": null,
|
||||
"deployed_by": null,
|
||||
"status": "built"
|
||||
}
|
||||
EOF
|
||||
|
||||
# 8. 更新 current
|
||||
cp "${BUILD_DIR}/version.json" "${VERSIONS_DIR}/current/version.json"
|
||||
|
||||
# 9. 更新 changelog.json
|
||||
UPDATE_CHANGELOG="
|
||||
import json
|
||||
from datetime import datetime
|
||||
|
||||
changelog_path = '${VERSIONS_DIR}/changelog.json'
|
||||
build_info = {
|
||||
'version': '${BUILD_VERSION}',
|
||||
'date': datetime.now().strftime('%Y-%m-%d'),
|
||||
'commit': '${GIT_COMMIT}',
|
||||
'message': '${GIT_MESSAGE}'
|
||||
}
|
||||
|
||||
try:
|
||||
with open(changelog_path, 'r') as f:
|
||||
changelog = json.load(f)
|
||||
except FileNotFoundError:
|
||||
changelog = {'updated_at': '', 'versions': {}, 'recent_changes': []}
|
||||
|
||||
changelog['updated_at'] = datetime.now().isoformat()
|
||||
if '${MAIN_VERSION}' not in changelog['versions']:
|
||||
changelog['versions']['${MAIN_VERSION}'] = {'status': 'building', 'build_count': 0}
|
||||
|
||||
changelog['versions']['${MAIN_VERSION}']['build_count'] += 1
|
||||
changelog['versions']['${MAIN_VERSION}']['current_build'] = '${BUILD_VERSION}'
|
||||
changelog['recent_changes'].insert(0, build_info)
|
||||
|
||||
with open(changelog_path, 'w') as f:
|
||||
json.dump(changelog, f, indent=2, ensure_ascii=False)
|
||||
"
|
||||
python3 -c "$UPDATE_CHANGELOG"
|
||||
|
||||
# 10. 啟動 Production Service
|
||||
log_info "啟動 Production Service..."
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 11. 驗證
|
||||
sleep 3
|
||||
if curl -s http://localhost:3002/health > /dev/null; then
|
||||
log_info "✓ Release 成功!"
|
||||
log_info "版本: ${BUILD_VERSION}"
|
||||
log_info "目錄: ${BUILD_DIR}"
|
||||
else
|
||||
log_error "✗ Release 失敗!請檢查服務狀態。"
|
||||
exit 1
|
||||
fi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 查詢版本指令
|
||||
|
||||
### 查詢目前版本
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/current/version.json
|
||||
```
|
||||
|
||||
### 查詢所有 Release
|
||||
```bash
|
||||
ls -la /Users/accusys/momentry/versions/releases/
|
||||
```
|
||||
|
||||
### 查詢版本歷史
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/changelog.json | python3 -m json.tool
|
||||
```
|
||||
|
||||
### 查詢特定主版本
|
||||
```bash
|
||||
ls /Users/accusys/momentry/versions/releases/v0.1/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本狀態
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `building` | 建置中 |
|
||||
| `built` | 已建置,未部署 |
|
||||
| `testing` | 測試中 |
|
||||
| `production` | 正式環境使用中 |
|
||||
| `deprecated` | 已棄用 |
|
||||
| `archived` | 已封存 |
|
||||
|
||||
---
|
||||
|
||||
## 版本流程圖
|
||||
|
||||
```
|
||||
develop (git branch)
|
||||
│
|
||||
▼
|
||||
feature/bugfix commit
|
||||
│
|
||||
▼
|
||||
develop ──────────────────┐
|
||||
│ │
|
||||
│ (merge to main) │
|
||||
▼ │
|
||||
main (git) │
|
||||
│ │
|
||||
▼ │
|
||||
Build v0.1.20260325_143000
|
||||
│ │
|
||||
├──► testing (3003) │
|
||||
│ │
|
||||
│ (approve) │
|
||||
▼ ▼
|
||||
v0.1 ───────────────────┘
|
||||
│
|
||||
├──► releases/v0.1/v0.1.20260325_143000/
|
||||
│
|
||||
├──► current/ (production)
|
||||
│
|
||||
▼
|
||||
changelog.json (update)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note (版本發布說明)
|
||||
|
||||
### Release Note 存放位置
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/versions/releases/{主版本}/{建置版本}/
|
||||
├── binary
|
||||
├── version.json
|
||||
└── RELEASE_NOTE.md # 發布說明 (Markdown)
|
||||
```
|
||||
|
||||
### Release Note 範本
|
||||
|
||||
```markdown
|
||||
# Momentry Core v0.1.20260325_143000 Release Note
|
||||
|
||||
## 版本資訊
|
||||
- **Build Version**: v0.1.20260325_143000
|
||||
- **Main Version**: v0.1
|
||||
- **Build Date**: 2026-03-25 14:30:00
|
||||
- **Git Commit**: 83ae050
|
||||
|
||||
## 新功能 (Features)
|
||||
|
||||
### API Key 認證系統
|
||||
- 添加 API Key 認證中介層
|
||||
- 所有 `/api/v1/*` 端點需要 `X-API-Key` header
|
||||
- 支援 API Key 使用追蹤和審計日誌
|
||||
|
||||
### Job Worker 系統
|
||||
- 新增 Job Worker 二進位檔
|
||||
- 支援最多 2 個並發處理器
|
||||
- 新增 `/api/v1/jobs/:uuid` 端點查詢任務詳情
|
||||
|
||||
## 錯誤修復 (Bug Fixes)
|
||||
|
||||
| Issue | 描述 |
|
||||
|-------|------|
|
||||
| #001 | 修復 `get_processor_results_by_job` 欄位映射錯誤 |
|
||||
| #002 | 修復 API Key 驗證時區處理問題 |
|
||||
|
||||
## API 變更 (API Changes)
|
||||
|
||||
### 新增端點
|
||||
| Method | Endpoint | 說明 |
|
||||
|--------|----------|------|
|
||||
| GET | `/api/v1/jobs` | 取得所有任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 取得特定任務詳情 |
|
||||
|
||||
### 認證變更
|
||||
| 端點 | 舊版 | 新版 |
|
||||
|------|------|------|
|
||||
| `/api/v1/*` | 公開 | 需要 API Key |
|
||||
|
||||
## 升級指南
|
||||
|
||||
### 從舊版升級
|
||||
1. 備份當前版本
|
||||
2. 停止服務
|
||||
3. 替換 binary
|
||||
4. 重啟服務
|
||||
5. 更新 API Key 配置
|
||||
|
||||
### API Key 配置
|
||||
```bash
|
||||
# 請求範例
|
||||
curl -H "X-API-Key: your_api_key" \
|
||||
"http://localhost:3002/api/v1/videos"
|
||||
```
|
||||
|
||||
## 已知問題 (Known Issues)
|
||||
|
||||
- 暫無
|
||||
|
||||
## 相關文檔
|
||||
|
||||
- [API 文檔](../docs_v1.0/REFERENCE/API_INDEX.md)
|
||||
- [版本管理規範](../docs_v1.0/REFERENCE/VERSION_MANAGEMENT.md)
|
||||
|
||||
---
|
||||
|
||||
## Release Note 自動生成 Script
|
||||
|
||||
### /Users/accusys/momentry/scripts/generate_release_note.sh
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
BUILD_VERSION=$1
|
||||
MAIN_VERSION=$2
|
||||
BUILD_DIR="/Users/accusys/momentry/versions/releases/${MAIN_VERSION}/${BUILD_VERSION}"
|
||||
|
||||
# 取得 Git 資訊
|
||||
GIT_COMMITS=$(git log --oneline -10)
|
||||
GIT_CHANGES=$(git diff --stat HEAD~5..HEAD)
|
||||
|
||||
cat > "${BUILD_DIR}/RELEASE_NOTE.md" << EOF
|
||||
# Momentry Core ${BUILD_VERSION} Release Note
|
||||
|
||||
## 版本資訊
|
||||
- **Build Version**: ${BUILD_VERSION}
|
||||
- **Main Version**: ${MAIN_VERSION}
|
||||
- **Build Date**: $(date '+%Y-%m-%d %H:%M:%S')
|
||||
- **Git Commit**: $(git rev-parse --short HEAD)
|
||||
|
||||
## 變更內容
|
||||
|
||||
### Commit 記錄
|
||||
\`\`\`
|
||||
${GIT_COMMITS}
|
||||
\`\`\`
|
||||
|
||||
### 變更統計
|
||||
\`\`\`
|
||||
${GIT_CHANGES}
|
||||
\`\`\`
|
||||
|
||||
## 新功能
|
||||
|
||||
## 錯誤修復
|
||||
|
||||
## API 變更
|
||||
|
||||
## 升級指南
|
||||
|
||||
## 已知問題
|
||||
|
||||
EOF
|
||||
|
||||
echo "Release Note 生成完成: ${BUILD_DIR}/RELEASE_NOTE.md"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note 查詢
|
||||
|
||||
### 查詢所有 Release Note
|
||||
```bash
|
||||
find /Users/accusys/momentry/versions/releases -name "RELEASE_NOTE.md"
|
||||
```
|
||||
|
||||
### 查看特定版本 Release Note
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/releases/v0.1/v0.1.20260325_143000/RELEASE_NOTE.md
|
||||
```
|
||||
|
||||
### 查詢最新版本 Release Note
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/current/RELEASE_NOTE.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note 範例
|
||||
|
||||
### 完整 Release Note 範例
|
||||
|
||||
\`\`\`markdown
|
||||
# Momentry Core v0.1.20260325_143000 Release Note
|
||||
|
||||
## 版本資訊
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| Build Version | v0.1.20260325_143000 |
|
||||
| Main Version | v0.1 |
|
||||
| Build Date | 2026-03-25 14:30:00 |
|
||||
| Git Commit | 83ae050 |
|
||||
| Status | ✅ Production |
|
||||
|
||||
## 新功能 (Features)
|
||||
|
||||
### 1. API Key 認證系統
|
||||
添加完整的 API Key 認證系統,保護所有 API 端點。
|
||||
|
||||
**功能:**
|
||||
- SHA256 key hash 驗證
|
||||
- 使用統計追蹤
|
||||
- 審計日誌記錄
|
||||
- 異常檢測
|
||||
|
||||
**API 使用方式:**
|
||||
\`\`\`bash
|
||||
curl -H "X-API-Key: your_key" \\
|
||||
"http://localhost:3002/api/v1/videos"
|
||||
\`\`\`
|
||||
|
||||
### 2. Job Worker 系統
|
||||
新增獨立的 Job Worker 處理影片處理任務。
|
||||
|
||||
**特性:**
|
||||
- 最多 2 個並發處理器
|
||||
- Polling-based 任務獲取
|
||||
- 自動進度追蹤
|
||||
|
||||
## 錯誤修復 (Bug Fixes)
|
||||
|
||||
| Issue | 描述 | 嚴重性 |
|
||||
|-------|------|--------|
|
||||
| #001 | 修復 `get_processor_results_by_job` TIMESTAMP 欄位映射 | 🔴 高 |
|
||||
| #002 | 修復 3002 port 衝突問題 | 🟡 中 |
|
||||
|
||||
## API 變更
|
||||
|
||||
### 新增端點
|
||||
| Method | Endpoint | 說明 |
|
||||
|--------|----------|------|
|
||||
| GET | `/api/v1/jobs` | 取得任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 取得任務詳情 |
|
||||
|
||||
### 端點認證狀態
|
||||
| 端點 | 認證需求 |
|
||||
|------|----------|
|
||||
| `/health` | ❌ 不需要 |
|
||||
| `/api/v1/*` | ✅ 需要 `X-API-Key` |
|
||||
|
||||
## 升級指南
|
||||
|
||||
### 前置需求
|
||||
- PostgreSQL 資料庫
|
||||
- Redis 伺服器
|
||||
- MongoDB 快取
|
||||
|
||||
### 升級步驟
|
||||
1. **備份當前版本**
|
||||
\`\`\`bash
|
||||
cp /Users/accusys/momentry/bin/momentry \\
|
||||
/Users/accusys/momentry/backup/bin/momentry_$(date +%Y%m%d)
|
||||
\`\`\`
|
||||
|
||||
2. **停止服務**
|
||||
\`\`\`bash
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
3. **替換 Binary**
|
||||
\`\`\`bash
|
||||
cp v0.1.20260325_143000/binary /Users/accusys/momentry/bin/momentry
|
||||
\`\`\`
|
||||
|
||||
4. **重啟服務**
|
||||
\`\`\`bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
5. **驗證**
|
||||
\`\`\`bash
|
||||
curl http://localhost:3002/health
|
||||
\`\`\`
|
||||
|
||||
## 已知問題 (Known Issues)
|
||||
|
||||
- 暫無
|
||||
|
||||
## 技術細節
|
||||
|
||||
### 認證流程
|
||||
\`\`\`
|
||||
Client Request
|
||||
│
|
||||
▼
|
||||
[X-API-Key Header] ──► Middleware
|
||||
│ │
|
||||
│ ▼
|
||||
│ Hash Key (SHA256)
|
||||
│ │
|
||||
│ ▼
|
||||
│ DB Lookup
|
||||
│ │
|
||||
│ ▼
|
||||
│ Validate Status
|
||||
│ │
|
||||
▼ ▼
|
||||
Handler ◄────────────────────┘
|
||||
\`\`\`
|
||||
|
||||
### 資料庫變更
|
||||
\`\`\`sql
|
||||
-- 新增 duration_secs 欄位
|
||||
ALTER TABLE processor_results
|
||||
ADD COLUMN IF NOT EXISTS duration_secs DOUBLE PRECISION;
|
||||
\`\`\`
|
||||
|
||||
## 回滾指南
|
||||
|
||||
如需回滾到上一版本:
|
||||
\`\`\`bash
|
||||
# 1. 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 2. 恢復舊版
|
||||
cp /Users/accusys/momentry/backup/bin/momentry_v0.1.20260324_100000 \\
|
||||
/Users/accusys/momentry/bin/momentry
|
||||
|
||||
# 3. 重啟服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
## 聯繫與支援
|
||||
|
||||
- **Issue Tracker**: https://gitea.momentry.ddns.net/momentry/momentry_core/issues
|
||||
- **文檔**: https://docs.momentry.ddns.net
|
||||
|
||||
---
|
||||
|
||||
*Generated: $(date '+%Y-%m-%d %H:%M:%S')*
|
||||
\`\`\`
|
||||
|
||||
```
|
||||
@@ -1,371 +0,0 @@
|
||||
# 🎬 連續演示模式使用指南
|
||||
|
||||
## 功能特點
|
||||
|
||||
### 1️⃣ 從頭到尾連續播放
|
||||
- 按 ASR 片段順序播放
|
||||
- 不跳躍、不間斷
|
||||
- 完整呈現所有內容
|
||||
|
||||
### 2️⃣ 顯示所有識別信息
|
||||
每個片段顯示:
|
||||
- **ASR**: 文字內容
|
||||
- **Speaker**: 說話人 + 演員名 + 角色名
|
||||
- **Face**: 人臉位置和置信度
|
||||
- **Pose**: 嘴部關鍵點
|
||||
- **更多**: 未來可擴展 OCR、場景等
|
||||
|
||||
### 3️⃣ 鍵盤控制
|
||||
- **SPACE**: 暫停/恢復
|
||||
- **Q**: 停止並退出
|
||||
|
||||
---
|
||||
|
||||
## 快速開始
|
||||
|
||||
### 基本用法
|
||||
|
||||
```bash
|
||||
./run_demo.sh --continuous
|
||||
```
|
||||
|
||||
### 顯示視頻
|
||||
|
||||
```bash
|
||||
./run_demo.sh --continuous --video
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 使用範例
|
||||
|
||||
### 1. 音頻連續播放(默認)
|
||||
|
||||
```bash
|
||||
./run_demo.sh --continuous
|
||||
```
|
||||
|
||||
**輸出示例**:
|
||||
```
|
||||
🎬 Continuous Demo Mode
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
📺 Playing from beginning to end
|
||||
⏸️ Press SPACE to pause/resume
|
||||
⏹️ Press Q to quit
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
[1/1118] Segment
|
||||
================================================================================
|
||||
⏱ Time: 14.20s - 21.50s
|
||||
🎤 Speaker: SPEAKER_4 → James Coburn (Tex Panthollow)
|
||||
================================================================================
|
||||
▶️ Playing: 14.20s - 21.50s (7.30s)
|
||||
|
||||
[2/1118] Segment
|
||||
================================================================================
|
||||
⏱ Time: 22.40s - 58.30s
|
||||
🎤 Speaker: SPEAKER_4 → James Coburn (Tex Panthollow)
|
||||
================================================================================
|
||||
▶️ Playing: 22.40s - 58.30s (35.90s)
|
||||
```
|
||||
|
||||
### 2. 視頻連續播放
|
||||
|
||||
```bash
|
||||
./run_demo.sh --continuous --video
|
||||
```
|
||||
|
||||
**特點**:
|
||||
- 📺 彈出視頻窗口
|
||||
- 🎬 視聽同步
|
||||
- 💯 完整體驗
|
||||
|
||||
### 3. 自定義窗口大小
|
||||
|
||||
```bash
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--continuous-demo \
|
||||
--show-video \
|
||||
--video-width 1600 \
|
||||
--video-height 900
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 鍵盤控制詳解
|
||||
|
||||
### ⏸️ 暫停(SPACE)
|
||||
|
||||
**何時使用**:
|
||||
- 想仔細看某個片段
|
||||
- 需要暫停分析
|
||||
- 想跳過某些內容
|
||||
|
||||
**操作**:
|
||||
```
|
||||
⏸️ Paused - Press SPACE to resume
|
||||
```
|
||||
|
||||
再次按 SPACE 恢復播放。
|
||||
|
||||
### ⏹️ 退出(Q)
|
||||
|
||||
**何時使用**:
|
||||
- 演示完成
|
||||
- 想提前結束
|
||||
- 切換到其他任務
|
||||
|
||||
**操作**:
|
||||
```
|
||||
⏹️ Stopped by user
|
||||
```
|
||||
|
||||
立即停止並退出。
|
||||
|
||||
---
|
||||
|
||||
## 演示流程
|
||||
|
||||
### 完整流程圖
|
||||
|
||||
```
|
||||
開始
|
||||
↓
|
||||
載入數據(ASR, ASRX, Face, Pose)
|
||||
↓
|
||||
逐句播放 ASR 片段
|
||||
├─ 顯示文字
|
||||
├─ 顯示說話人
|
||||
├─ 顯示人臉
|
||||
├─ 顯示嘴部動作
|
||||
└─ 播放音頻/視頻
|
||||
↓
|
||||
用戶可隨時:
|
||||
├─ SPACE 暫停/恢復
|
||||
└─ Q 退出
|
||||
↓
|
||||
播放完成
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 信息顯示格式
|
||||
|
||||
### 標準格式
|
||||
|
||||
```
|
||||
[片段序號/總數] Segment
|
||||
================================================================================
|
||||
⏱ Time: 起始時間 - 結束時間
|
||||
📝 Text: 文字內容(如果有)
|
||||
🎤 Speaker: 說話人ID → 演員名 (角色名)
|
||||
👤 Face: 位置、大小、置信度(如果有)
|
||||
👄 Mouth landmarks: 嘴部關鍵點(如果有)
|
||||
================================================================================
|
||||
▶️ Playing: 起始時間 - 結束時間 (時長)
|
||||
```
|
||||
|
||||
### 實際範例
|
||||
|
||||
```
|
||||
[234/1118] Segment
|
||||
================================================================================
|
||||
⏱ Time: 299.50s - 303.10s
|
||||
🎤 Speaker: SPEAKER_1 → Audrey Hepburn (Regina Lampert)
|
||||
👤 Face: bbox=(1250,178) 147x206, confidence=0.88
|
||||
================================================================================
|
||||
▶️ Playing: 299.50s - 303.10s (3.60s)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 與其他模式對比
|
||||
|
||||
| 特性 | 連續模式 | 說話人演示 | 交互模式 |
|
||||
|------|----------|-----------|----------|
|
||||
| **播放方式** | 從頭到尾 | 按說話人 | 手動控制 |
|
||||
| **自動化** | ✅ 全自動 | ✅ 半自動 | ❌ 手動 |
|
||||
| **信息展示** | ✅ 完整 | ✅ 完整 | ✅ 按需 |
|
||||
| **暫停控制** | ✅ 支持 | ❌ 不支持 | N/A |
|
||||
| **適用場景** | 完整演示 | 說話人分析 | 深度分析 |
|
||||
|
||||
---
|
||||
|
||||
## 使用場景
|
||||
|
||||
### 1. 完整功能演示
|
||||
|
||||
```bash
|
||||
# 展示所有識別功能
|
||||
./run_demo.sh --continuous --video
|
||||
```
|
||||
|
||||
適用於:
|
||||
- 向客戶演示
|
||||
- 團隊內部展示
|
||||
- 功能驗收
|
||||
|
||||
### 2. 內容審核
|
||||
|
||||
```bash
|
||||
# 快速瀏覽所有內容
|
||||
./run_demo.sh --continuous
|
||||
```
|
||||
|
||||
適用於:
|
||||
- 檢查 ASR 準確度
|
||||
- 驗證說話人識別
|
||||
- 確認人臉檢測
|
||||
|
||||
### 3. 數據驗證
|
||||
|
||||
```bash
|
||||
# 驗證處理結果
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asr asr.json \
|
||||
--asrx asrx.json \
|
||||
--face face.json \
|
||||
--continuous-demo
|
||||
```
|
||||
|
||||
適用於:
|
||||
- 檢查處理質量
|
||||
- 發現問題片段
|
||||
- 優化處理參數
|
||||
|
||||
---
|
||||
|
||||
## 高級用法
|
||||
|
||||
### 1. 慢速播放
|
||||
|
||||
```bash
|
||||
# 慢速觀看細節
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--continuous-demo \
|
||||
--show-video
|
||||
```
|
||||
|
||||
按 SPACE 暫停查看細節。
|
||||
|
||||
### 2. 快速瀏覽
|
||||
|
||||
```bash
|
||||
# 音頻模式快速瀏覽
|
||||
./run_demo.sh --continuous
|
||||
```
|
||||
|
||||
適合快速了解內容。
|
||||
|
||||
### 3. 特定時間段
|
||||
|
||||
結合交互模式:
|
||||
|
||||
```bash
|
||||
# 1. 先用交互模式找到起始時間
|
||||
./target/debug/integrated_player --video video.mp4 --asrx asrx.json
|
||||
|
||||
# 2. 輸入時間跳轉
|
||||
> 300
|
||||
|
||||
# 3. 改用連續模式從該時間開始
|
||||
# (需要修改代碼支持 --start 參數)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 性能優化
|
||||
|
||||
### 1. 音頻模式
|
||||
|
||||
```bash
|
||||
# 最快、最輕量
|
||||
./run_demo.sh --continuous
|
||||
```
|
||||
|
||||
### 2. 視頻模式
|
||||
|
||||
```bash
|
||||
# 較慢、更完整
|
||||
./run_demo.sh --continuous --video
|
||||
```
|
||||
|
||||
### 3. 自定義窗口
|
||||
|
||||
```bash
|
||||
# 小窗口更快
|
||||
--video-width 640 --video-height 480
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見問題
|
||||
|
||||
### Q1: 播放速度太快?
|
||||
|
||||
A: 按 SPACE 暫停,仔細查看信息。
|
||||
|
||||
### Q2: 想跳過某些片段?
|
||||
|
||||
A: 按 Q 退出,使用交互模式手動選擇。
|
||||
|
||||
### Q3: 沒有 ASR 數據?
|
||||
|
||||
A: 連續模式需要 ASR 數據。請確保提供 `--asr` 參數。
|
||||
|
||||
### Q4: 某些片段沒有信息?
|
||||
|
||||
A: 正常現象。不是每個片段都有所有信息(Face、Pose等)。
|
||||
|
||||
### Q5: 可以調整播放速度嗎?
|
||||
|
||||
A: 連續模式按實際時長播放。需要快進請使用 `--demo` 模式。
|
||||
|
||||
---
|
||||
|
||||
## 命令速查
|
||||
|
||||
```bash
|
||||
# 連續音頻演示
|
||||
./run_demo.sh --continuous
|
||||
|
||||
# 連續視頻演示
|
||||
./run_demo.sh --continuous --video
|
||||
|
||||
# 自定義窗口
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--continuous-demo \
|
||||
--show-video \
|
||||
--video-width 1600 \
|
||||
--video-height 900
|
||||
|
||||
# 鍵盤控制
|
||||
SPACE - 暫停/恢復
|
||||
Q - 退出
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 未來擴展
|
||||
|
||||
### 計劃功能
|
||||
|
||||
1. **進度條**: 顯示當前播放進度
|
||||
2. **時間跳轉**: 支持從指定時間開始
|
||||
3. **字幕疊加**: 在視頻上顯示 ASR 文字
|
||||
4. **人臉標註**: 在視頻上畫出人臉框
|
||||
5. **OCR 整合**: 顯示文字識別結果
|
||||
6. **場景識別**: 顯示場景類型
|
||||
|
||||
---
|
||||
|
||||
**更新日期**: 2026-04-02
|
||||
**版本**: 2.0.0
|
||||
**作者**: Momentry Team
|
||||
@@ -1,397 +0,0 @@
|
||||
# 整合播放器演示功能指南
|
||||
|
||||
## 🎬 自動演示模式
|
||||
|
||||
整合播放器支持自動演示功能,可以自動播放所有說話人的片段,展示各項功能。
|
||||
|
||||
---
|
||||
|
||||
## 快速開始
|
||||
|
||||
### 1. 快速演示(推薦初次使用)
|
||||
|
||||
```bash
|
||||
./run_demo.sh --quick
|
||||
```
|
||||
|
||||
- 每個說話人演示 1 個片段
|
||||
- 3 倍速播放
|
||||
- 適合快速了解功能
|
||||
|
||||
### 2. 標準演示
|
||||
|
||||
```bash
|
||||
./run_demo.sh
|
||||
```
|
||||
|
||||
- 每個說話人演示 3 個片段
|
||||
- 2 倍速播放
|
||||
- 完整展示所有功能
|
||||
|
||||
### 3. 自定義演示
|
||||
|
||||
```bash
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 5 \
|
||||
--demo-speed 1.5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 演示參數
|
||||
|
||||
| 參數 | 說明 | 默認值 |
|
||||
|------|------|--------|
|
||||
| `--demo` | 啟用自動演示模式 | false |
|
||||
| `--demo-segments-per-speaker` | 每個說話人演示的片段數 | 3 |
|
||||
| `--demo-speed` | 演示速度(倍速) | 2.0 |
|
||||
|
||||
---
|
||||
|
||||
## 演示流程
|
||||
|
||||
演示模式會自動執行以下步驟:
|
||||
|
||||
1. **載入數據**
|
||||
- ASRX 說話人分離結果
|
||||
- Face 人臉檢測結果(如果提供)
|
||||
- Pose 姿態估計結果(如果提供)
|
||||
|
||||
2. **列出說話人**
|
||||
```
|
||||
📊 Speaker Statistics:
|
||||
────────────────────────────────────────────────────────────────────────────────
|
||||
Speaker ID Actor Character Segments Duration
|
||||
────────────────────────────────────────────────────────────────────────────────
|
||||
SPEAKER_0 Cary Grant Peter Joshua 654 1764.4s
|
||||
SPEAKER_1 Audrey Hepburn Regina Lampert 403 1119.4s
|
||||
SPEAKER_2 Walter Matthau Hamilton Bartholomew 49 65.7s
|
||||
SPEAKER_4 James Coburn Tex Panthollow 3 44.1s
|
||||
────────────────────────────────────────────────────────────────────────────────
|
||||
```
|
||||
|
||||
3. **逐一演示每個說話人**
|
||||
|
||||
對每個說話人:
|
||||
- 顯示說話人信息(ID → 演員 → 角色)
|
||||
- 播放指定數量的片段
|
||||
- 顯示整合信息(文字、人臉、嘴部動作)
|
||||
- 暫停 2 秒後切換到下一個說話人
|
||||
|
||||
4. **演示示例輸出**
|
||||
|
||||
```
|
||||
================================================================================
|
||||
🎭 Demo: SPEAKER_1 → Audrey Hepburn (Regina Lampert)
|
||||
================================================================================
|
||||
|
||||
[Segment 1/3]
|
||||
|
||||
================================================================================
|
||||
⏱ Time: 299.50s - 303.10s
|
||||
🎤 Speaker: SPEAKER_1 → Audrey Hepburn (Regina Lampert)
|
||||
👤 Face: bbox=(1250,178) 147x206, confidence=0.88
|
||||
================================================================================
|
||||
|
||||
⏳ Playing audio (1.8s)...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 演示模式特點
|
||||
|
||||
### 1. 自動化播放
|
||||
- 無需手動輸入命令
|
||||
- 自動播放所有說話人
|
||||
- 適合展示和測試
|
||||
|
||||
### 2. 速度控制
|
||||
- 可調整播放速度
|
||||
- 支持快速瀏覽(3x)
|
||||
- 支持正常速度(1x)
|
||||
|
||||
### 3. 完整展示
|
||||
- ASR 文字
|
||||
- 人臉檢測
|
||||
- 說話人識別
|
||||
- 演員/角色映射
|
||||
- 嘴部動作(如果有 Pose 數據)
|
||||
|
||||
---
|
||||
|
||||
## 使用場景
|
||||
|
||||
### 1. 功能演示
|
||||
```bash
|
||||
# 展示給團隊或客戶
|
||||
./run_demo.sh
|
||||
```
|
||||
|
||||
### 2. 快速測試
|
||||
```bash
|
||||
# 開發過程中的快速測試
|
||||
./run_demo.sh --quick
|
||||
```
|
||||
|
||||
### 3. 數據驗證
|
||||
```bash
|
||||
# 驗證 ASRX 結果的正確性
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--demo \
|
||||
--demo-speed 1.0 # 原速播放
|
||||
```
|
||||
|
||||
### 4. 說話人分析
|
||||
```bash
|
||||
# 分析特定說話人的表現
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 10 # 更多片段
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 演示時間估算
|
||||
|
||||
以 Charade (114.7 分鐘) 為例:
|
||||
|
||||
| 模式 | 片段數/說話人 | 速度 | 總時間 |
|
||||
|------|---------------|------|--------|
|
||||
| 快速 | 1 | 3x | ~2 分鐘 |
|
||||
| 標準 | 3 | 2x | ~5 分鐘 |
|
||||
| 完整 | 5 | 1x | ~15 分鐘 |
|
||||
|
||||
計算公式:
|
||||
```
|
||||
總時間 = 說話人數 × 片段數 × 平均片段時長 / 速度
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 演示腳本詳解
|
||||
|
||||
### run_demo.sh
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# 主要邏輯:
|
||||
|
||||
# 1. 檢查編譯
|
||||
if [ ! -f ./target/debug/integrated_player ]; then
|
||||
cargo build --bin integrated_player
|
||||
fi
|
||||
|
||||
# 2. 檢查數據
|
||||
if [ ! -f "$VIDEO" ]; then
|
||||
python3 scripts/asrx_self/test_long_movie.py
|
||||
fi
|
||||
|
||||
# 3. 運行演示
|
||||
if [ "$1" = "--quick" ]; then
|
||||
# 快速模式
|
||||
./target/debug/integrated_player \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 1 \
|
||||
--demo-speed 3.0
|
||||
else
|
||||
# 標準模式
|
||||
./target/debug/integrated_player \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 3 \
|
||||
--demo-speed 2.0
|
||||
fi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 高級用法
|
||||
|
||||
### 1. 演示特定說話人
|
||||
|
||||
```bash
|
||||
# 只演示主要說話人
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--auto-play-speaker \
|
||||
--speaker-name SPEAKER_0
|
||||
```
|
||||
|
||||
### 2. 演示整合 Face 數據
|
||||
|
||||
```bash
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--face face.json \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 3
|
||||
```
|
||||
|
||||
### 3. 完整演示(所有數據)
|
||||
|
||||
```bash
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asr asr.json \
|
||||
--face face.json \
|
||||
--asrx asrx.json \
|
||||
--pose pose.json \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 5 \
|
||||
--demo-speed 1.5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 輸出說明
|
||||
|
||||
### 演示輸出結構
|
||||
|
||||
```
|
||||
🎬 Auto Demo Mode
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
Segments per speaker: 3
|
||||
Demo speed: 2.0x
|
||||
|
||||
================================================================================
|
||||
🎭 Demo: SPEAKER_0 → Cary Grant (Peter Joshua)
|
||||
================================================================================
|
||||
|
||||
[Segment 1/3]
|
||||
|
||||
================================================================================
|
||||
⏱ Time: 14.20s - 21.50s
|
||||
🎤 Speaker: SPEAKER_0 → Cary Grant (Peter Joshua)
|
||||
👤 Face: bbox=(1250,178) 147x206, confidence=0.88
|
||||
================================================================================
|
||||
|
||||
⏳ Playing audio (3.6s)...
|
||||
|
||||
[Segment 2/3]
|
||||
...
|
||||
|
||||
⏸️ Pausing 2 seconds before next speaker...
|
||||
|
||||
================================================================================
|
||||
🎭 Demo: SPEAKER_1 → Audrey Hepburn (Regina Lampert)
|
||||
================================================================================
|
||||
...
|
||||
|
||||
================================================================================
|
||||
✅ Demo completed!
|
||||
================================================================================
|
||||
```
|
||||
|
||||
### 信息解讀
|
||||
|
||||
- **🎭 Demo**: 說話人演示標題
|
||||
- **⏱ Time**: 片段時間範圍
|
||||
- **🎤 Speaker**: 說話人 → 演員 → 角色
|
||||
- **👤 Face**: 人臉位置和置信度
|
||||
- **👄 Mouth**: 嘴部關鍵點(如果有)
|
||||
- **⏳ Playing**: 正在播放音頻
|
||||
- **⏸️ Pausing**: 說話人切換暫停
|
||||
|
||||
---
|
||||
|
||||
## 故障排查
|
||||
|
||||
### 問題 1: 找不到測試數據
|
||||
|
||||
```bash
|
||||
# 解決方案:生成測試數據
|
||||
cd scripts/asrx_self
|
||||
python3 test_long_movie.py
|
||||
cd ../..
|
||||
```
|
||||
|
||||
### 問題 2: 播放失敗
|
||||
|
||||
```bash
|
||||
# 檢查 ffplay
|
||||
which ffplay
|
||||
|
||||
# 安裝 ffmpeg
|
||||
brew install ffmpeg
|
||||
```
|
||||
|
||||
### 問題 3: 演示太快/太慢
|
||||
|
||||
```bash
|
||||
# 調整速度參數
|
||||
--demo-speed 1.0 # 原速
|
||||
--demo-speed 2.0 # 2 倍速(默認)
|
||||
--demo-speed 3.0 # 3 倍速
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 性能優化
|
||||
|
||||
### 減少片段數
|
||||
|
||||
```bash
|
||||
--demo-segments-per-speaker 1 # 每個說話人只演示 1 個片段
|
||||
```
|
||||
|
||||
### 提高速度
|
||||
|
||||
```bash
|
||||
--demo-speed 4.0 # 4 倍速快速瀏覽
|
||||
```
|
||||
|
||||
### 演示主要說話人
|
||||
|
||||
```bash
|
||||
# 只演示片段數最多的說話人
|
||||
--auto-play-speaker --speaker-name SPEAKER_0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 比較:演示模式 vs 交互模式
|
||||
|
||||
| 特性 | 演示模式 | 交互模式 |
|
||||
|------|----------|----------|
|
||||
| 自動化 | ✅ 全自動 | ❌ 需手動輸入 |
|
||||
| 速度控制 | ✅ 可調整 | ❌ 固定速度 |
|
||||
| 說話人選擇 | ❌ 按順序 | ✅ 自由選擇 |
|
||||
| 時間跳轉 | ❌ 不支持 | ✅ 支持 |
|
||||
| 適用場景 | 展示、測試 | 分析、開發 |
|
||||
|
||||
---
|
||||
|
||||
## 相關命令
|
||||
|
||||
```bash
|
||||
# 查看幫助
|
||||
./target/debug/integrated_player --help
|
||||
|
||||
# 快速測試
|
||||
./run_demo.sh --quick
|
||||
|
||||
# 標準演示
|
||||
./run_demo.sh
|
||||
|
||||
# 自定義演示
|
||||
./target/debug/integrated_player \
|
||||
--video video.mp4 \
|
||||
--asrx asrx.json \
|
||||
--demo \
|
||||
--demo-segments-per-speaker 5 \
|
||||
--demo-speed 1.5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**創建日期**: 2026-04-02
|
||||
**版本**: 1.1.0
|
||||
**作者**: Momentry Team
|
||||
@@ -1,705 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry Core API 示範手冊"
|
||||
date: "2026-03-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "core"
|
||||
- "示範手冊"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry Core API 示範手冊 的內容"
|
||||
- "Momentry Core API 示範手冊 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry Core API 示範手冊?"
|
||||
---
|
||||
|
||||
# Momentry Core API 示範手冊
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-25 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-25 | 創建示範手冊,包含 Demo API Key 與完整範例 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
**狀態**: 完成
|
||||
|
||||
---
|
||||
|
||||
## 快速開始
|
||||
|
||||
### Demo API Key
|
||||
|
||||
```
|
||||
API Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69
|
||||
Key ID: muser_68600856036340bcafc01930eb4bd839
|
||||
過期日: 2027-03-25
|
||||
```
|
||||
|
||||
### 測試連線
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":456464}
|
||||
```
|
||||
|
||||
### 測試認證
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/videos | jq '.videos | length'
|
||||
```
|
||||
|
||||
```json
|
||||
13
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境 URL
|
||||
|
||||
| 環境 | URL | 用途 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 本機開發測試 |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | n8n/WordPress/curl 生產環境 |
|
||||
|
||||
---
|
||||
|
||||
## 端點總覽
|
||||
|
||||
| 方法 | 端點 | 說明 | 認證 |
|
||||
|------|------|------|------|
|
||||
| GET | `/health` | 健康檢查 | 公開 |
|
||||
| GET | `/health/detailed` | 詳細健康檢查 | 公開 |
|
||||
| POST | `/api/v1/register` | 註冊影片 | 需要 |
|
||||
| POST | `/api/v1/probe` | 探測影片資訊 | 需要 |
|
||||
| POST | `/api/v1/search` | 語意搜尋 | 需要 |
|
||||
| POST | `/api/v1/n8n/search` | n8n 格式搜尋 | 需要 |
|
||||
| POST | `/api/v1/search/hybrid` | 混合搜尋 | 需要 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 | 需要 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 UUID | 需要 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 | 需要 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 | 需要 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 | 需要 |
|
||||
|
||||
---
|
||||
|
||||
## 1. curl 範例
|
||||
|
||||
### 基本格式
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
URL
|
||||
```
|
||||
|
||||
### 1.1 健康檢查(公開)
|
||||
|
||||
```bash
|
||||
# 基本健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查(含服務狀態)
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
### 1.2 列出影片
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/videos | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"videos": [
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"file_name": "ExaSAN PCIe series - Director Ou Yu-Zhi Shares His Experience.mp4",
|
||||
"duration": 159.637188,
|
||||
"width": 640,
|
||||
"height": 360
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 1.3 搜尋影片
|
||||
|
||||
```bash
|
||||
curl -X POST \
|
||||
-H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "ExaSAN", "limit": 5}' \
|
||||
http://localhost:3002/api/v1/search | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"chunk_id": "...",
|
||||
"text": "...",
|
||||
"score": 0.85,
|
||||
"start_time": 0.0,
|
||||
"end_time": 5.0
|
||||
}
|
||||
],
|
||||
"total": 1,
|
||||
"query": "ExaSAN",
|
||||
"took_ms": 123
|
||||
}
|
||||
```
|
||||
|
||||
### 1.4 查詢進度
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/progress/952f5854b9febad1 | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"overall_progress": 67,
|
||||
"current_processor": "yolo",
|
||||
"processors": [
|
||||
{"name": "asr", "status": "completed"},
|
||||
{"name": "cut", "status": "completed"},
|
||||
{"name": "yolo", "status": "running"}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. n8n 範例
|
||||
|
||||
### 2.1 HTTP Request 節點設定
|
||||
|
||||
```
|
||||
Method: POST
|
||||
URL: https://api.momentry.ddns.net/api/v1/search
|
||||
Authentication: None (使用 Header)
|
||||
|
||||
Headers:
|
||||
┌─────────────────────┬──────────────────────────────────────────────────┐
|
||||
│ Name │ Value │
|
||||
├─────────────────────┼──────────────────────────────────────────────────┤
|
||||
│ X-API-Key │ muser_68600856036340bcafc01930eb4bd839_... │
|
||||
│ Content-Type │ application/json │
|
||||
└─────────────────────┴──────────────────────────────────────────────────┘
|
||||
|
||||
Body Content (JSON):
|
||||
{
|
||||
"query": "{{ $json.search_term }}",
|
||||
"limit": 5
|
||||
}
|
||||
```
|
||||
|
||||
### 2.2 n8n 搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"name": "Set Search Term",
|
||||
"type": "n8n-nodes-base.set",
|
||||
"parameters": {
|
||||
"values": {
|
||||
"json": {
|
||||
"search_term": "ExaSAN"
|
||||
}
|
||||
}
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Search Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "POST",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/search",
|
||||
"authentication": "genericCredentialType",
|
||||
"genericAuthType": "httpHeaderAuth",
|
||||
"sendHeaders": true,
|
||||
"headerParameters": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "X-API-Key",
|
||||
"value": "muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
}
|
||||
]
|
||||
},
|
||||
"sendBody": true,
|
||||
"bodyContentType": "json",
|
||||
"specifyBody": "json",
|
||||
"jsonBody": "={{ { \"query\": $json.search_term, \"limit\": 5 } }}"
|
||||
},
|
||||
"position": [650, 300]
|
||||
},
|
||||
{
|
||||
"name": "Process Results",
|
||||
"type": "n8n-nodes-base.code",
|
||||
"parameters": {
|
||||
"jsCode": "// Extract video results\nconst results = $input.first().json.results;\nreturn results.map(r => ({\n uuid: r.uuid,\n text: r.text,\n score: r.score,\n time: `${r.start_time}s - ${r.end_time}s`\n}));"
|
||||
},
|
||||
"position": [850, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Set Search Term"}]]
|
||||
},
|
||||
"Set Search Term": {
|
||||
"main": [[{"node": "Search Videos"}]]
|
||||
},
|
||||
"Search Videos": {
|
||||
"main": [[{"node": "Process Results"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.3 n8n 列出影片 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Get Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "GET",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/videos",
|
||||
"sendHeaders": true,
|
||||
"headerParameters": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "X-API-Key",
|
||||
"value": "muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Extract Video List",
|
||||
"type": "n8n-nodes-base.code",
|
||||
"parameters": {
|
||||
"jsCode": "const videos = $input.first().json.videos;\nreturn videos.map(v => ({\n json: {\n uuid: v.uuid,\n name: v.file_name,\n duration: Math.round(v.duration) + 's',\n resolution: `${v.width}x${v.height}`\n }\n}));"
|
||||
},
|
||||
"position": [650, 300]
|
||||
},
|
||||
{
|
||||
"name": "Slack Notification",
|
||||
"type": "n8n-nodes-base.slack",
|
||||
"parameters": {
|
||||
"channel": "#momentry",
|
||||
"text": "=Found {{ $json.length }} videos:\n{{ $json.map(v => `• ${v.name} (${v.duration})`).join(`\n`) }}"
|
||||
},
|
||||
"position": [850, 300]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 n8n 定時同步 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Schedule Trigger",
|
||||
"type": "n8n-nodes-base.scheduleTrigger",
|
||||
"parameters": {
|
||||
"rule": {
|
||||
"interval": [{"field": "hours", "hours": 1}]
|
||||
}
|
||||
},
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"name": "Get Pending Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "GET",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/videos"
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Filter Processing",
|
||||
"type": "n8n-nodes-base.filter",
|
||||
"parameters": {
|
||||
"conditions": {
|
||||
"options": {"caseSensitive": true},
|
||||
"conditions": [
|
||||
{"id": "status", "leftValue": "{{ $json.status }}", "rightValue": "processing"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"position": [650, 300]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. WordPress 範例
|
||||
|
||||
### 3.1 PHP 函數庫
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* Momentry API Client
|
||||
*/
|
||||
|
||||
class Momentry_API {
|
||||
private const API_URL = 'https://api.momentry.ddns.net';
|
||||
private const API_KEY = 'muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69';
|
||||
|
||||
/**
|
||||
* 發送 API 請求
|
||||
*/
|
||||
private function request(string $endpoint, array $data = [], string $method = 'GET'): array {
|
||||
$url = self::API_URL . $endpoint;
|
||||
|
||||
$args = [
|
||||
'headers' => [
|
||||
'X-API-Key' => self::API_KEY,
|
||||
'Content-Type' => 'application/json',
|
||||
],
|
||||
'timeout' => 30,
|
||||
];
|
||||
|
||||
if ($method === 'POST') {
|
||||
$args['method'] = 'POST';
|
||||
$args['body'] = json_encode($data);
|
||||
}
|
||||
|
||||
$response = wp_remote_request($url, $args);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
throw new Exception($response->get_error_message());
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response), true);
|
||||
}
|
||||
|
||||
/**
|
||||
* 列出所有影片
|
||||
*/
|
||||
public function list_videos(): array {
|
||||
return $this->request('/api/v1/videos');
|
||||
}
|
||||
|
||||
/**
|
||||
* 搜尋影片內容
|
||||
*/
|
||||
public function search(string $query, int $limit = 10): array {
|
||||
return $this->request('/api/v1/search', [
|
||||
'query' => $query,
|
||||
'limit' => $limit,
|
||||
], 'POST');
|
||||
}
|
||||
|
||||
/**
|
||||
* 取得影片進度
|
||||
*/
|
||||
public function get_progress(string $uuid): array {
|
||||
return $this->request("/api/v1/progress/{$uuid}");
|
||||
}
|
||||
|
||||
/**
|
||||
* 檢查健康狀態
|
||||
*/
|
||||
public function health_check(): array {
|
||||
return $this->request('/health');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 短代碼 (Shortcode)
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* WordPress 短代碼範例
|
||||
*/
|
||||
|
||||
// 註冊短代碼
|
||||
add_shortcode('momentry_videos', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'limit' => 10,
|
||||
], $atts);
|
||||
|
||||
$api = new Momentry_API();
|
||||
|
||||
try {
|
||||
$result = $api->list_videos();
|
||||
$videos = array_slice($result['videos'], 0, $atts['limit']);
|
||||
|
||||
ob_start();
|
||||
?>
|
||||
<div class="momentry-videos">
|
||||
<h3>影片列表</h3>
|
||||
<ul>
|
||||
<?php foreach ($videos as $video): ?>
|
||||
<li>
|
||||
<strong><?= esc_html($video['file_name']) ?></strong>
|
||||
<br>
|
||||
<small>
|
||||
UUID: <?= esc_html($video['uuid']) ?>
|
||||
| 時長: <?= gmdate("H:i:s", $video['duration']) ?>
|
||||
</small>
|
||||
</li>
|
||||
<?php endforeach; ?>
|
||||
</ul>
|
||||
</div>
|
||||
<?php
|
||||
return ob_get_clean();
|
||||
|
||||
} catch (Exception $e) {
|
||||
return '<p class="error">載入失敗: ' . esc_html($e->getMessage()) . '</p>';
|
||||
}
|
||||
});
|
||||
|
||||
// 搜尋短代碼
|
||||
add_shortcode('momentry_search', function($atts, $content = '') {
|
||||
$query = sanitize_text_field($content);
|
||||
|
||||
if (empty($query)) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$api = new Momentry_API();
|
||||
|
||||
try {
|
||||
$result = $api->search($query);
|
||||
|
||||
ob_start();
|
||||
?>
|
||||
<div class="momentry-search-results">
|
||||
<h3>「<?= esc_html($query) ?>」搜尋結果</h3>
|
||||
<?php if (empty($result['results'])): ?>
|
||||
<p>沒有找到相關結果</p>
|
||||
<?php else: ?>
|
||||
<ul>
|
||||
<?php foreach ($result['results'] as $item): ?>
|
||||
<li>
|
||||
<a href="/video/<?= esc_attr($item['uuid']) ?>?t=<?= (int)$item['start_time'] ?>">
|
||||
<?= esc_html($item['text']) ?>
|
||||
</a>
|
||||
<br>
|
||||
<small>相似度: <?= round($item['score'] * 100) ?>%</small>
|
||||
</li>
|
||||
<?php endforeach; ?>
|
||||
</ul>
|
||||
<?php endif; ?>
|
||||
</div>
|
||||
<?php
|
||||
return ob_get_clean();
|
||||
|
||||
} catch (Exception $e) {
|
||||
return '<p class="error">搜尋失敗: ' . esc_html($e->getMessage()) . '</p>';
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### 3.3 使用方式
|
||||
|
||||
在 WordPress 頁面或文章中:
|
||||
|
||||
```
|
||||
[momentry_videos limit="5"]
|
||||
|
||||
[momentry_search]ExaSAN[/momentry_search]
|
||||
```
|
||||
|
||||
### 3.4 REST API 整合
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* 註冊 WordPress REST API 端點
|
||||
*/
|
||||
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'GET',
|
||||
'callback' => function(WP_REST_Request $request) {
|
||||
$query = sanitize_text_field($request->get_param('q'));
|
||||
|
||||
if (empty($query)) {
|
||||
return new WP_Error('missing_query', '需要搜尋關鍵字', ['status' => 400]);
|
||||
}
|
||||
|
||||
$api = new Momentry_API();
|
||||
$result = $api->search($query);
|
||||
|
||||
return new WP_REST_Response($result, 200);
|
||||
},
|
||||
'permission_callback' => '__return_true',
|
||||
]);
|
||||
});
|
||||
|
||||
// 使用方式: GET /wp-json/momentry/v1/search?q=ExaSAN
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 疑難排解
|
||||
|
||||
### 4.1 常見錯誤
|
||||
|
||||
| 錯誤 | 原因 | 解決方案 |
|
||||
|------|------|----------|
|
||||
| `401 Unauthorized` | API Key 無效或過期 | 檢查 API Key 是否正確 |
|
||||
| `500 Internal Server Error` | 伺服器錯誤 | 檢查 `/health/detailed` 服務狀態 |
|
||||
| `Connection Timeout` | 網路問題 | 確認 `api.momentry.ddns.net` 可達 |
|
||||
|
||||
### 4.2 測試腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# test_api.sh - Momentry API 測試腳本
|
||||
|
||||
API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
BASE_URL="http://localhost:3002"
|
||||
|
||||
echo "=== 1. 健康檢查 ==="
|
||||
curl -s "$BASE_URL/health" | jq .
|
||||
echo ""
|
||||
|
||||
echo "=== 2. 列出影片 ==="
|
||||
curl -s -H "X-API-Key: $API_KEY" "$BASE_URL/api/v1/videos" | jq '.videos | length'
|
||||
echo ""
|
||||
|
||||
echo "=== 3. 搜尋測試 ==="
|
||||
curl -s -X POST -H "X-API-Key: $API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "test", "limit": 3}' \
|
||||
"$BASE_URL/api/v1/search" | jq '.results | length'
|
||||
echo ""
|
||||
|
||||
echo "=== 完成 ==="
|
||||
```
|
||||
|
||||
### 4.3 驗證腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# verify_auth.sh - 驗證 API Key
|
||||
|
||||
API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
BASE_URL="http://localhost:3002"
|
||||
|
||||
# 測試 1: 無 API Key
|
||||
echo "測試 1: 無 API Key"
|
||||
RESULT=$(curl -s -o /dev/null -w "%{http_code}" "$BASE_URL/api/v1/videos")
|
||||
[ "$RESULT" = "401" ] && echo "✅ 正確拒絕 (401)" || echo "❌ 預期 401,實際 $RESULT"
|
||||
|
||||
# 測試 2: 有 API Key
|
||||
echo "測試 2: 有 API Key"
|
||||
RESULT=$(curl -s -H "X-API-Key: $API_KEY" "$BASE_URL/api/v1/videos")
|
||||
echo "$RESULT" | jq -e '.videos' > /dev/null && echo "✅ 成功取得資料" || echo "❌ 取得資料失敗"
|
||||
|
||||
# 測試 3: 無效 API Key
|
||||
echo "測試 3: 無效 API Key"
|
||||
RESULT=$(curl -s -o /dev/null -w "%{http_code}" -H "X-API-Key: invalid_key" "$BASE_URL/api/v1/videos")
|
||||
[ "$RESULT" = "401" ] && echo "✅ 正確拒絕 (401)" || echo "❌ 預期 401,實際 $RESULT"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. API Key 管理
|
||||
|
||||
### 5.1 建立新 API Key
|
||||
|
||||
```bash
|
||||
# 本地建立
|
||||
./target/release/momentry api-key create "My App" --key-type user --ttl 90
|
||||
```
|
||||
|
||||
### 5.2 列出 API Keys
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key list
|
||||
```
|
||||
|
||||
### 5.3 驗證 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key validate --key "YOUR_API_KEY"
|
||||
```
|
||||
|
||||
### 5.4 撤銷 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key revoke --key "YOUR_API_KEY"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. 影片 UUID 說明
|
||||
|
||||
UUID 是基於檔案路徑的 SHA256 哈希前 16 位:
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
↓
|
||||
SHA256 Hash
|
||||
↓
|
||||
9760d0820f0cf9a7
|
||||
```
|
||||
|
||||
### B. 處理器狀態
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `pending` | 等待處理 |
|
||||
| `running` | 處理中 |
|
||||
| `completed` | 已完成 |
|
||||
| `failed` | 失敗 |
|
||||
|
||||
### C. 支援的處理器
|
||||
|
||||
- **ASR**: 語音識別
|
||||
- **CUT**: 場景剪切
|
||||
- **YOLO**: 物件偵測
|
||||
|
||||
### D. 聯絡支援
|
||||
|
||||
- Email: support@momentry.ddns.net
|
||||
- 文件: https://docs.momentry.ddns.net
|
||||
- GitHub: https://github.com/anomalyco/momentry
|
||||
@@ -1,222 +0,0 @@
|
||||
# 🎬 演示功能總結
|
||||
|
||||
## 當前可用的演示模式
|
||||
|
||||
### 1️⃣ 說話人演示模式(已實現)
|
||||
|
||||
```bash
|
||||
# 快速演示(每個說話人 1 個片段)
|
||||
./run_demo.sh --quick
|
||||
|
||||
# 標準演示(每個說話人 3 個片段)
|
||||
./run_demo.sh
|
||||
|
||||
# 視頻演示
|
||||
./run_demo.sh --video
|
||||
```
|
||||
|
||||
**特點**:
|
||||
- ✅ 按 ASRX 數據播放
|
||||
- ✅ 顯示說話人統計
|
||||
- ✅ 顯示演員名和角色名
|
||||
- ✅ 支持音頻/視頻模式
|
||||
|
||||
---
|
||||
|
||||
### 2️⃣ 連續播放模式(簡化版)
|
||||
|
||||
```bash
|
||||
# 音頻模式
|
||||
./play_continuous.sh
|
||||
|
||||
# 視頻模式
|
||||
./play_continuous.sh --video
|
||||
```
|
||||
|
||||
**特點**:
|
||||
- ✅ 從頭到尾連續播放
|
||||
- ✅ 顯示說話人和時間信息
|
||||
- ✅ 支持視頻顯示
|
||||
- ⚠️ 不能暫停(按 Ctrl+C 停止)
|
||||
|
||||
**實現原理**:
|
||||
- 使用 `jq` 解析 ASRX JSON
|
||||
- 循環調用 `ffplay` 播放每個片段
|
||||
- 簡單高效
|
||||
|
||||
---
|
||||
|
||||
## 演示效果
|
||||
|
||||
### 說話人演示
|
||||
|
||||
```
|
||||
🎬 Integrated Player for ASR/Face/ASRX/Pose
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
Video: "/tmp/charade_audio.wav"
|
||||
✓ Loaded 1118 ASRX segments, 8 speakers
|
||||
|
||||
📊 Speaker Statistics:
|
||||
--------------------------------------------------------------------------------
|
||||
Speaker ID Actor Character Segments Duration
|
||||
--------------------------------------------------------------------------------
|
||||
SPEAKER_0 Cary Grant Peter Joshua 654 1764.4s
|
||||
SPEAKER_1 Audrey Hepburn Regina Lampert 403 1119.4s
|
||||
SPEAKER_2 Walter Matthau Hamilton Bartholomew 49 65.7s
|
||||
SPEAKER_4 James Coburn Tex Panthollow 3 44.1s
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
🎭 Demo: SPEAKER_0 → Cary Grant (Peter Joshua)
|
||||
================================================================================
|
||||
⏱ Time: 374.80s - 375.90s
|
||||
🎤 Speaker: SPEAKER_0 → Cary Grant (Peter Joshua)
|
||||
================================================================================
|
||||
⏳ Playing audio...
|
||||
```
|
||||
|
||||
### 連續播放
|
||||
|
||||
```
|
||||
🎬 连续演示模式
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
📺 从头到尾播放所有 ASRX 片段
|
||||
⏸️ 按 Ctrl+C 停止
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
📊 总片段数: 1118
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
[1/1118] 🎤 SPEAKER_5
|
||||
⏱ 1.8s - 2.6s (0.8s)
|
||||
🔊 播放中...
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
[2/1118] 🎤 SPEAKER_4
|
||||
⏱ 14.2s - 21.5s (7.3s)
|
||||
🔊 播放中...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 使用建議
|
||||
|
||||
### 適用場景
|
||||
|
||||
| 模式 | 適用場景 | 優點 | 缺點 |
|
||||
|------|----------|------|------|
|
||||
| **說話人演示** | 展示、分析 | 按說話人跳躍、完整信息 | 不連續 |
|
||||
| **連續播放** | 完整體驗 | 從頭到尾、不間斷 | 不能暫停 |
|
||||
|
||||
### 推薦用法
|
||||
|
||||
#### 1. 快速了解內容
|
||||
```bash
|
||||
./run_demo.sh --quick
|
||||
```
|
||||
|
||||
#### 2. 說話人分析
|
||||
```bash
|
||||
./run_demo.sh
|
||||
```
|
||||
|
||||
#### 3. 完整觀看
|
||||
```bash
|
||||
./play_continuous.sh --video
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 技術實現
|
||||
|
||||
### 說話人演示
|
||||
- **語言**: Rust
|
||||
- **實現**: `integrated_player` binary
|
||||
- **數據源**: ASRX JSON
|
||||
- **控制**: 預設片段數
|
||||
|
||||
### 連續播放
|
||||
- **語言**: Bash
|
||||
- **實現**: `play_continuous.sh` 腳本
|
||||
- **數據源**: ASRX JSON
|
||||
- **控制**: Ctrl+C 停止
|
||||
- **工具**: jq, ffplay
|
||||
|
||||
---
|
||||
|
||||
## 未來改進
|
||||
|
||||
### 計劃功能
|
||||
|
||||
1. **暫停控制**
|
||||
- 使用 Rust 實現
|
||||
- 支持鍵盤交互
|
||||
- 空格鍵暫停
|
||||
|
||||
2. **進度條**
|
||||
- 顯示當前進度
|
||||
- 剩餘時間估算
|
||||
|
||||
3. **字幕疊加**
|
||||
- 在視頻上顯示 ASR 文字
|
||||
- 支持多語言
|
||||
|
||||
4. **人臉標註**
|
||||
- 在視頻上畫出人臉框
|
||||
- 實時顯示檢測結果
|
||||
|
||||
5. **完整信息展示**
|
||||
- ASR 文字
|
||||
- 人臉檢測
|
||||
- 嘴部動作
|
||||
- OCR 文字
|
||||
- 場景識別
|
||||
|
||||
---
|
||||
|
||||
## 常見問題
|
||||
|
||||
### Q: 為什麼連續模式不能暫停?
|
||||
|
||||
A: 簡化版使用 Bash 腳本實現,沒有鍵盤監聽功能。完整版需要 Rust 實現,目前開發中。
|
||||
|
||||
### Q: 說話人演示為什麼會跳躍?
|
||||
|
||||
A: 說話人演示按說話人分組播放,會跳過其他說話人的片段。連續模式才會完整播放。
|
||||
|
||||
### Q: 如何查看所有片段?
|
||||
|
||||
A: 使用連續播放模式:
|
||||
```bash
|
||||
./play_continuous.sh
|
||||
```
|
||||
|
||||
### Q: 播放速度如何?
|
||||
|
||||
A: 兩種模式都按實際時長播放。說話人演示有 2 秒暫停。
|
||||
|
||||
---
|
||||
|
||||
## 快速命令參考
|
||||
|
||||
```bash
|
||||
# 說話人演示(音頻)
|
||||
./run_demo.sh
|
||||
|
||||
# 說話人演示(視頻)
|
||||
./run_demo.sh --video
|
||||
|
||||
# 快速演示
|
||||
./run_demo.sh --quick
|
||||
|
||||
# 連續播放(音頻)
|
||||
./play_continuous.sh
|
||||
|
||||
# 連續播放(視頻)
|
||||
./play_continuous.sh --video
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**更新日期**: 2026-04-02
|
||||
**版本**: 2.1.0
|
||||
**作者**: Momentry Team
|
||||
@@ -1,222 +0,0 @@
|
||||
# 🎬 演示功能使用說明
|
||||
|
||||
## 問題:只聽到聲音?
|
||||
|
||||
您遇到的情況是正常的!默認情況下,演示模式只播放音頻,不顯示視頻畫面。這樣可以:
|
||||
- 快速瀏覽所有說話人
|
||||
- 專注於語音內容
|
||||
- 不受視頻窗口干擾
|
||||
|
||||
---
|
||||
|
||||
## 解決方案:顯示視頻畫面
|
||||
|
||||
### 方法 1: 使用演示腳本(推薦)
|
||||
|
||||
```bash
|
||||
# 快速演示 + 顯示視頻
|
||||
./run_demo.sh --quick --video
|
||||
|
||||
# 標準演示 + 顯示視頻
|
||||
./run_demo.sh --video
|
||||
|
||||
# 完整演示 + 顯示視頻
|
||||
./run_demo.sh --video
|
||||
```
|
||||
|
||||
### 方法 2: 直接使用播放器
|
||||
|
||||
```bash
|
||||
# 啟用視頻顯示
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--demo \
|
||||
--show-video
|
||||
|
||||
# 自定義視頻窗口大小
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--demo \
|
||||
--show-video \
|
||||
--video-width 1200 \
|
||||
--video-height 800
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 完整參數說明
|
||||
|
||||
### 視頻相關參數
|
||||
|
||||
| 參數 | 說明 | 默認值 |
|
||||
|------|------|--------|
|
||||
| `--show-video` | 顯示視頻畫面 | false(僅音頻) |
|
||||
| `--video-width` | 視頻窗口寬度 | 800 |
|
||||
| `--video-height` | 視頻窗口高度 | 600 |
|
||||
|
||||
### 演示相關參數
|
||||
|
||||
| 參數 | 說明 | 默認值 |
|
||||
|------|------|--------|
|
||||
| `--demo` | 啟用自動演示模式 | false |
|
||||
| `--demo-segments-per-speaker` | 每個說話人的片段數 | 3 |
|
||||
| `--demo-speed` | 演示速度倍數 | 2.0 |
|
||||
|
||||
---
|
||||
|
||||
## 使用範例
|
||||
|
||||
### 1. 音頻模式(默認)
|
||||
|
||||
```bash
|
||||
# 僅播放音頻,不顯示視頻
|
||||
./run_demo.sh --quick
|
||||
```
|
||||
|
||||
**優點**:
|
||||
- ✅ 快速瀏覽
|
||||
- ✅ 專注語音
|
||||
- ✅ 不受干擾
|
||||
|
||||
**適用場景**:
|
||||
- 快速測試
|
||||
- 語音內容分析
|
||||
- 後台播放
|
||||
|
||||
### 2. 視頻模式
|
||||
|
||||
```bash
|
||||
# 顯示視頻畫面
|
||||
./run_demo.sh --video
|
||||
```
|
||||
|
||||
**優點**:
|
||||
- ✅ 視聽結合
|
||||
- ✅ 更直觀
|
||||
- ✅ 完整體驗
|
||||
|
||||
**適用場景**:
|
||||
- 功能演示
|
||||
- 內容展示
|
||||
- 完整測試
|
||||
|
||||
### 3. 自定義模式
|
||||
|
||||
```bash
|
||||
# 慢速演示 + 大窗口
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--demo \
|
||||
--show-video \
|
||||
--demo-speed 1.0 \
|
||||
--video-width 1600 \
|
||||
--video-height 900 \
|
||||
--demo-segments-per-speaker 5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 對比:音頻模式 vs 視頻模式
|
||||
|
||||
| 特性 | 音頻模式 | 視頻模式 |
|
||||
|------|----------|----------|
|
||||
| **播放速度** | 快 | 慢 |
|
||||
| **資源占用** | 低 | 高 |
|
||||
| **窗口干擾** | 無 | 有 |
|
||||
| **體驗完整度** | 70% | 100% |
|
||||
| **適用場景** | 測試、分析 | 演示、展示 |
|
||||
|
||||
---
|
||||
|
||||
## 推薦使用方式
|
||||
|
||||
### 開發測試
|
||||
```bash
|
||||
# 快速音頻測試
|
||||
./run_demo.sh --quick
|
||||
```
|
||||
|
||||
### 功能演示
|
||||
```bash
|
||||
# 視頻演示
|
||||
./run_demo.sh --video
|
||||
```
|
||||
|
||||
### 完整體驗
|
||||
```bash
|
||||
# 慢速視頻演示
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--face /tmp/face_long.json \
|
||||
--demo \
|
||||
--show-video \
|
||||
--demo-speed 1.0 \
|
||||
--demo-segments-per-speaker 5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見問題
|
||||
|
||||
### Q: 為什麼默認不顯示視頻?
|
||||
|
||||
A:
|
||||
1. **性能考慮**:音頻模式更快、更輕量
|
||||
2. **專注內容**:不受視覺干擾
|
||||
3. **測試效率**:快速瀏覽所有說話人
|
||||
|
||||
### Q: 如何調整視頻窗口大小?
|
||||
|
||||
A:
|
||||
```bash
|
||||
--video-width 1200 --video-height 800
|
||||
```
|
||||
|
||||
### Q: 可以同時顯示字幕嗎?
|
||||
|
||||
A: 目前終端會顯示 ASR 文字,未來可以考慮在視頻上疊加字幕。
|
||||
|
||||
### Q: 視頻播放卡頓?
|
||||
|
||||
A:
|
||||
1. 使用較低的 `--demo-speed`(如 1.5)
|
||||
2. 減少 `--demo-segments-per-speaker`
|
||||
3. 確保系統性能足夠
|
||||
|
||||
---
|
||||
|
||||
## 完整演示命令集合
|
||||
|
||||
```bash
|
||||
# 1. 快速音頻演示
|
||||
./run_demo.sh --quick
|
||||
|
||||
# 2. 快速視頻演示
|
||||
./run_demo.sh --quick --video
|
||||
|
||||
# 3. 標準音頻演示
|
||||
./run_demo.sh
|
||||
|
||||
# 4. 標準視頻演示
|
||||
./run_demo.sh --video
|
||||
|
||||
# 5. 完整視頻演示(慢速 + 大窗口)
|
||||
./target/debug/integrated_player \
|
||||
--video /tmp/charade_audio.wav \
|
||||
--asrx /tmp/asrx_charade_optimized.json \
|
||||
--demo \
|
||||
--show-video \
|
||||
--demo-speed 1.0 \
|
||||
--video-width 1600 \
|
||||
--video-height 900
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**更新日期**: 2026-04-02
|
||||
**版本**: 1.2.0
|
||||
**作者**: Momentry Team
|
||||
@@ -1,199 +0,0 @@
|
||||
# Dev 3003 改造記錄
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-04-30 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-04-30 | Dev 3003 全面改造 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 1. 改造目標
|
||||
|
||||
- 將 Dev 3003 (Playground) 與 Public 3002 完全隔離
|
||||
- 統一術語:`video_uuid` → `file_uuid`
|
||||
- 修復資料庫結構問題(probe_json 類型、timestamp 類型)
|
||||
- Python 腳本和 output 目錄隔離
|
||||
|
||||
---
|
||||
|
||||
## 2. PostgreSQL Schema 修復
|
||||
|
||||
### 2.1 probe_json 類型修復
|
||||
|
||||
**問題**: `dev.videos.probe_json` 類型為 `TEXT`,但 Rust 期望 `JSONB`
|
||||
|
||||
**修復**:
|
||||
```sql
|
||||
ALTER TABLE dev.videos ALTER COLUMN probe_json TYPE jsonb USING probe_json::jsonb;
|
||||
```
|
||||
|
||||
### 2.2 video_uuid → file_uuid 重命名 (10 張表)
|
||||
|
||||
| 表 | 狀態 |
|
||||
|----|------|
|
||||
| `dev.backup_registry` | ✅ 已重命名 |
|
||||
| `dev.castings` | ✅ 已重命名 |
|
||||
| `dev.characters` | ✅ 已重命名 |
|
||||
| `dev.face_identities` | ✅ 已重命名 |
|
||||
| `dev.face_recognition_results` | ✅ 已重命名 |
|
||||
| `dev.file_lifecycle` | ✅ 已重命名 |
|
||||
| `dev.file_registry` | ✅ 已重命名 |
|
||||
| `dev.processor_results` | ✅ 已重命名 |
|
||||
| `dev.video_events` | ✅ 已重命名 |
|
||||
| `dev.video_identities` | ✅ 已重命名 |
|
||||
|
||||
**修復 SQL**:
|
||||
```sql
|
||||
ALTER TABLE dev.backup_registry RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.castings RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.characters RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.face_identities RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.face_recognition_results RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.file_lifecycle RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.file_registry RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.processor_results RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.video_events RENAME COLUMN video_uuid TO file_uuid;
|
||||
ALTER TABLE dev.video_identities RENAME COLUMN video_uuid TO file_uuid;
|
||||
|
||||
-- 重建 constraint
|
||||
ALTER TABLE dev.face_recognition_results
|
||||
DROP CONSTRAINT face_recognition_results_video_uuid_key;
|
||||
ALTER TABLE dev.face_recognition_results
|
||||
ADD CONSTRAINT face_recognition_results_file_uuid_key UNIQUE (file_uuid);
|
||||
```
|
||||
|
||||
### 2.3 timestamp 類型修復
|
||||
|
||||
**問題**: `dev.videos.created_at`, `updated_at`, `registered_at` 為 `TIMESTAMP` (without time zone),但 Rust 期望 `TIMESTAMPTZ`
|
||||
|
||||
**修復**:
|
||||
```sql
|
||||
ALTER TABLE dev.videos ALTER COLUMN created_at TYPE timestamptz USING created_at AT TIME ZONE 'UTC';
|
||||
ALTER TABLE dev.videos ALTER COLUMN updated_at TYPE timestamptz USING updated_at AT TIME ZONE 'UTC';
|
||||
ALTER TABLE dev.videos ALTER COLUMN registered_at TYPE timestamptz USING registered_at AT TIME ZONE 'UTC';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Rust 代碼修改
|
||||
|
||||
### 3.1 `src/api/server.rs`
|
||||
|
||||
| 行號 | 修改前 | 修改後 |
|
||||
|------|--------|--------|
|
||||
| 3982 | `DELETE FROM {} WHERE video_uuid = $1` | `DELETE FROM {} WHERE file_uuid = $1` |
|
||||
|
||||
### 3.2 `src/api/face_recognition.rs`
|
||||
|
||||
| 行號 | 修改前 | 修改後 |
|
||||
|------|--------|--------|
|
||||
| 721 | `WHERE video_uuid = $1` | `WHERE file_uuid = $1` |
|
||||
| 764 | `"video_uuid": file_uuid` | `"file_uuid": file_uuid` |
|
||||
| 786 | `video_uuid: &str` (參數) | `file_uuid: &str` (參數) |
|
||||
| 807 | `ON CONFLICT (video_uuid)` | `ON CONFLICT (file_uuid)` |
|
||||
| 818 | `.bind(video_uuid)` | `.bind(file_uuid)` |
|
||||
| 877 | `.bind(video_uuid)` | `.bind(file_uuid)` |
|
||||
| 926 | `.bind(video_uuid)` | `.bind(file_uuid)` |
|
||||
|
||||
### 3.3 測試修復
|
||||
|
||||
| 檔案 | 修改 |
|
||||
|------|------|
|
||||
| `src/core/db/postgres_db.rs:4550` | 添加 `file_type: None` 到 `VideoRecord` 測試 |
|
||||
|
||||
---
|
||||
|
||||
## 4. Python 腳本隔離
|
||||
|
||||
### 4.1 更新預設 DATABASE_URL (7 個腳本)
|
||||
|
||||
| 腳本 | 修改 |
|
||||
|------|------|
|
||||
| `scripts/clip_logo_integration.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/match_face_with_pose_filtering.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/select_face_reference_vectors_v2.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/match_face_identity.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/tmdb_identity_integration.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/select_face_reference_vectors.py` | `?options=-c%20search_path=dev` |
|
||||
| `scripts/test_identity_db.py` | `?options=-c%20search_path=dev` |
|
||||
|
||||
### 4.2 output 目錄隔離
|
||||
|
||||
| 腳本 | 修改 |
|
||||
|------|------|
|
||||
| `scripts/identity_agent.py` | 預設 output 改為 `/Users/accusys/momentry/output_dev` |
|
||||
|
||||
### 4.3 環境變數配置
|
||||
|
||||
`.env.development` 已配置:
|
||||
```bash
|
||||
MOMENTRY_OUTPUT_DIR=/Users/accusys/momentry/output_dev
|
||||
DATABASE_SCHEMA=dev
|
||||
MONGODB_DATABASE=momentry_dev
|
||||
QDRANT_COLLECTION=momentry_dev_rule1
|
||||
REDIS_PREFIX=momentry_dev:
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 隔離狀態總覽
|
||||
|
||||
| 資源 | 配置 | 狀態 |
|
||||
|------|------|------|
|
||||
| PostgreSQL | `DATABASE_SCHEMA=dev` | ✅ 隔離 |
|
||||
| MongoDB | `momentry_dev` | ✅ 隔離 |
|
||||
| Qdrant | `momentry_dev_rule1` | ✅ 隔離 |
|
||||
| Redis | `momentry_dev:` | ✅ 隔離 |
|
||||
| Output Dir | `/Users/accusys/momentry/output_dev` | ✅ 隔離 |
|
||||
|
||||
---
|
||||
|
||||
## 6. 驗證結果
|
||||
|
||||
### 6.1 Build 驗證
|
||||
- `cargo build --bins`: ✅ 成功
|
||||
- `cargo clippy --lib`: ✅ 通過 (119 warnings, 0 errors)
|
||||
- `cargo test --lib`: ✅ 178 tests passed
|
||||
|
||||
### 6.2 API 驗證
|
||||
- `GET /api/v1/files`: ✅ 返回 200 (之前返回 500)
|
||||
- 測試數據: 6 個檔案已註冊
|
||||
|
||||
---
|
||||
|
||||
## 7. 待辦事項
|
||||
|
||||
| 任務 | 優先級 | 狀態 |
|
||||
|------|--------|------|
|
||||
| 設計 Dev 3003 API 結構 (v1.0 aligned) | Medium | ⬜ |
|
||||
| 實作 `GET /api/v1/files/{uuid}/identities` | Medium | ⬜ |
|
||||
| 實作 `GET /api/v1/identities/{uuid}` | Medium | ⬜ |
|
||||
| 實作 `GET /api/v1/identities/{uuid}/files` | Medium | ⬜ |
|
||||
| 實作 AI Agent API (clustering/merge suggestions) | Medium | ⬜ |
|
||||
|
||||
---
|
||||
|
||||
## 8. 注意事項
|
||||
|
||||
### 8.1 Public 3002 不受影響
|
||||
- 所有修改僅限於 `dev` schema
|
||||
- `public` schema 保持原狀
|
||||
- Rust 代碼修改適用於兩者,但 SQL 中的 column name 已統一為 `file_uuid`
|
||||
|
||||
### 8.2 Python 腳本注意事項
|
||||
- 仍有其他 Python 腳本使用 `DB_CONFIG`、`POSTGRES_CONFIG` 等模式
|
||||
- 這些腳本需單獨檢查和更新
|
||||
- 建議逐步遷移至使用環境變數
|
||||
|
||||
### 8.3 已知限制
|
||||
- Player module 仍使用 `video_uuid` 變數名(內部使用,不影響 API)
|
||||
- 部分 Python 腳本的 output 路徑仍需手動指定
|
||||
@@ -1,661 +0,0 @@
|
||||
---
|
||||
document_type: "design"
|
||||
title: "File / Identity API 架構設計"
|
||||
service: "MOMENTRY_CORE"
|
||||
date: "2026-04-28"
|
||||
status: "active"
|
||||
current_state: "finalized"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
created_at: "2026-04-25"
|
||||
version: "V1.2"
|
||||
tags:
|
||||
- "api"
|
||||
- "file"
|
||||
- "identity"
|
||||
- "face"
|
||||
- "candidate"
|
||||
- "pre_chunk"
|
||||
- "reference_data"
|
||||
- "identity_embedding"
|
||||
- "clip"
|
||||
related_documents:
|
||||
- "DOCS_STANDARD.md"
|
||||
- "AI_AGENT_DOCUMENTATION_GUIDE.md"
|
||||
- "_deprecated/TMDB_CHARACTER_INTEGRATION.md"
|
||||
- "_deprecated/SPEAKER_INTEGRATION.md"
|
||||
- "_deprecated/IDENTITY_SYSTEM_DESIGN.md"
|
||||
- "PROCESSORS/_CORE/RULE_SPECIFICATION.md"
|
||||
- "REFERENCE/API_ERROR_CODES.md"
|
||||
- "IDENTITY_REFERENCE_VECTOR_DESIGN.md"
|
||||
ai_query_hints:
|
||||
- "查詢 File/Identity 核心架構設計"
|
||||
- "查詢 People API 端點定義"
|
||||
- "查詢 Candidate 狀態轉換流程"
|
||||
- "查詢資料庫 Schema 定義 (含 pre_chunks)"
|
||||
- "查詢 reference_data JSONB 結構"
|
||||
- "查詢 identity_embedding (CLIP ViT-L/14)"
|
||||
---
|
||||
|
||||
# File / Identity API 架構設計文件
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-04-25 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.2 | 2026-04-28 | **重大更新**: 添加 face_embedding(512), voice_embedding(192), identity_embedding(768), reference_data JSONB 結構詳解, identity_type 扩展 (logo/symbol/sound/animal/environmental) | OpenCode | OpenCode |
|
||||
| V1.1 | 2026-04-25 | **重大更新**: 移除 faces 表 (方案 A), 新增 pre_chunks 表, 統一命名為 file_uuid, 更新 Response 格式 | OpenCode | OpenCode |
|
||||
| V1.0 | 2026-04-25 | 創建 File/Identity API 架構設計 | OpenCode | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔定義 Momentry Core 全新架構下的 File、Identity、Candidate 核心概念與 API 設計。
|
||||
核心理念:**僅有兩種核心實體 — File(任何檔案)與 Identity(任何可識別列管的物件)**。
|
||||
|
||||
---
|
||||
|
||||
## 核心設計理念
|
||||
|
||||
### 實體定義
|
||||
|
||||
| 實體 | 說明 | 範例 |
|
||||
|------|------|------|
|
||||
| **File** | 任何檔案 | video (現階段僅處理 video), pdf, ppt... |
|
||||
| **Identity** | 任何可識別列管的物件 | 人、品牌、物件、概念... |
|
||||
| **Pre-chunk** | 處理器產出的原始數據單元 | 幀 (Frame)、語音段落 (Segment) |
|
||||
| **Candidate** | 邏輯狀態:`identity_id IS NULL` 的 Face Pre-chunk | 待確認的人臉 |
|
||||
|
||||
### 關係模型
|
||||
|
||||
```
|
||||
File ──[包含]──→ Pre-chunk (Frame/Segment)
|
||||
Pre-chunk ──[歸屬於]──→ Identity (用信心度標示關係, 若為 NULL 則為 Candidate)
|
||||
Identity ──[出現在]──→ File (通過 Pre-chunk 或 file_identities 關聯)
|
||||
```
|
||||
|
||||
### 生命週期
|
||||
|
||||
**File 生命週期**:
|
||||
```
|
||||
上傳 → 自動註冊 → 取得 file_uuid → 觸發 probe → File 分類 → 等待 Rule 排程處理
|
||||
```
|
||||
|
||||
**Identity 生命週期 (People)**:
|
||||
```
|
||||
檢測到 Face → 存入 Pre-chunk (Candidate)
|
||||
↓ Agent 分析建議 / 人工確認
|
||||
關聯 Identity (不再為 Candidate)
|
||||
```
|
||||
|
||||
**Candidate 狀態轉換**:
|
||||
* **定義**: Candidate 不是獨立表格,而是 `pre_chunks` 中 `identity_id IS NULL` 的 Face 數據。
|
||||
* **確認**: 更新 `identity_id` → 成為已確認身份。
|
||||
* **剔除**: 將 `identity_id` 設回 `NULL` → 重新成為 Candidate。
|
||||
|
||||
---
|
||||
|
||||
## 資料庫 Schema (全新,不與舊系統共用)
|
||||
|
||||
### Files 表
|
||||
|
||||
| 欄位 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| file_uuid | UUID | Yes | 唯一識別 (自動產生) |
|
||||
| file_type | VARCHAR(20) | Yes | video, pdf, ppt, png... |
|
||||
| file_path | TEXT | Yes | 檔案路徑 |
|
||||
| file_name | TEXT | Yes | 檔名 |
|
||||
| file_size | BIGINT | No | 檔案大小 (bytes) |
|
||||
| mime_type | VARCHAR(100) | No | MIME 類型 |
|
||||
| probe_metadata | JSONB | No | probe 處理器輸出元數據 |
|
||||
| processing_status | VARCHAR(20) | No | pending, processing, completed |
|
||||
| created_at | TIMESTAMPTZ | Yes | 建立時間 |
|
||||
| updated_at | TIMESTAMPTZ | Yes | 更新時間 |
|
||||
|
||||
```sql
|
||||
CREATE TABLE files (
|
||||
file_uuid UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
file_type VARCHAR(20) NOT NULL,
|
||||
file_path TEXT NOT NULL,
|
||||
file_name TEXT NOT NULL,
|
||||
file_size BIGINT,
|
||||
mime_type VARCHAR(100),
|
||||
probe_metadata JSONB DEFAULT '{}',
|
||||
processing_status VARCHAR(20) DEFAULT 'pending',
|
||||
created_at TIMESTAMPTZ DEFAULT NOW(),
|
||||
updated_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
```
|
||||
|
||||
### Pre-chunks 表 (處理器原始數據)
|
||||
|
||||
**說明**: 所有 Processor (YOLO, Face, ASR...) 產出的數據皆存於此表。
|
||||
* **Video File**: 最小單位為 **Frame (幀)** (`coordinate_type = 'frame'`)。
|
||||
* **Text File**: 最小單位為 Word/Sentence (`coordinate_type = 'text'`)。
|
||||
|
||||
| 欄位 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| id | BIGSERIAL | Yes | 主鍵 |
|
||||
| file_uuid | UUID | Yes | 所屬 File |
|
||||
| processor_type | VARCHAR(20) | Yes | 產生此數據的處理器 (yolo, face, asr...) |
|
||||
| coordinate_type | VARCHAR(20) | Yes | 座標類型 (frame, text, page...) |
|
||||
| coordinate_index | BIGINT | Yes | 索引值 (幀號、段落號) |
|
||||
| timestamp | FLOAT | No | 時間位置 (秒) |
|
||||
| data | JSONB | Yes | 處理器原始輸出 (例如: { "objects": [...] }) |
|
||||
| identity_id | UUID | No | **若為 Face 且歸屬 Identity 則填寫,否則為 NULL (Candidate)** |
|
||||
| confidence | FLOAT | No | 匹配信心度 |
|
||||
| created_at | TIMESTAMPTZ | Yes | 建立時間 |
|
||||
|
||||
```sql
|
||||
CREATE TABLE pre_chunks (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
file_uuid UUID REFERENCES files(file_uuid) ON DELETE CASCADE,
|
||||
processor_type VARCHAR(20) NOT NULL, -- 'yolo', 'face', 'ocr', 'asr'...
|
||||
coordinate_type VARCHAR(20) DEFAULT 'frame', -- 'frame' for video
|
||||
coordinate_index BIGINT NOT NULL, -- Frame number
|
||||
timestamp FLOAT,
|
||||
data JSONB NOT NULL, -- Raw processor output
|
||||
identity_id UUID REFERENCES identities(identity_id), -- Link to Identity (NULL = Candidate)
|
||||
confidence FLOAT,
|
||||
created_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
|
||||
-- 索引優化
|
||||
CREATE INDEX idx_pre_chunks_file ON pre_chunks(file_uuid);
|
||||
CREATE INDEX idx_pre_chunks_type ON pre_chunks(processor_type);
|
||||
CREATE INDEX idx_pre_chunks_identity ON pre_chunks(identity_id) WHERE identity_id IS NOT NULL;
|
||||
```
|
||||
|
||||
### Identities 表
|
||||
|
||||
| 欄位 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| identity_id | UUID | Yes | 唯一識別 (自動產生) |
|
||||
| name | TEXT | Yes | 顯示名稱 |
|
||||
| identity_type | VARCHAR(30) | Yes | people, brand, object, concept, logo, symbol, sound, animal, environmental... |
|
||||
| source | VARCHAR(20) | No | manual, tmdb, agent_suggested, ai_detection |
|
||||
| status | VARCHAR(20) | No | pending, confirmed, skipped |
|
||||
| face_embedding | VECTOR(512) | No | 參考臉向量 (ArcFace) - 用於人臉比對 |
|
||||
| voice_embedding | VECTOR(192) | No | 參考聲紋向量 (ECAPA-TDNN) - 用於聲音比對 |
|
||||
| identity_embedding | VECTOR(768) | No | 身份向量 (CLIP ViT-L/14) - 用於 logo/symbol/object 搜索 |
|
||||
| reference_data | JSONB | No | 1對多參考向量存儲 (多角度/多場景/多版本 embedding) |
|
||||
| metadata | JSONB | No | 擴展屬性 |
|
||||
| created_at | TIMESTAMPTZ | Yes | 建立時間 |
|
||||
| updated_at | TIMESTAMPTZ | Yes | 更新時間 |
|
||||
|
||||
```sql
|
||||
CREATE TABLE identities (
|
||||
identity_id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||
name TEXT NOT NULL,
|
||||
identity_type VARCHAR(30) NOT NULL,
|
||||
source VARCHAR(20) DEFAULT 'manual',
|
||||
status VARCHAR(20) DEFAULT 'pending',
|
||||
|
||||
-- 參考向量 (用於自動比對)
|
||||
face_embedding VECTOR(512), -- 參考臉向量 (ArcFace)
|
||||
voice_embedding VECTOR(192), -- 參考聲紋向量 (ECAPA-TDNN)
|
||||
identity_embedding VECTOR(768), -- 身份向量 (CLIP ViT-L/14)
|
||||
|
||||
-- 1對多參考向量存儲
|
||||
reference_data JSONB DEFAULT '{}', -- 多角度/多場景/多版本 embedding
|
||||
metadata JSONB DEFAULT '{}',
|
||||
created_at TIMESTAMPTZ DEFAULT NOW(),
|
||||
updated_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
```
|
||||
|
||||
#### reference_data JSONB 結構詳解
|
||||
|
||||
`reference_data` 用於存儲同一 Identity 的多個參考向量,支援 1對多匹配,提高識別鲁棒性。
|
||||
|
||||
**完整結構範例**:
|
||||
```json
|
||||
{
|
||||
"face_embeddings": [
|
||||
{
|
||||
"embedding": [0.1, 0.2, ...],
|
||||
"source": "tmdb_images",
|
||||
"image_url": "https://image.tmdb.org/t/p/original/xxx.jpg",
|
||||
"angle": "frontal",
|
||||
"quality_score": 0.95,
|
||||
"created_at": "2026-04-28T10:00:00Z"
|
||||
},
|
||||
{
|
||||
"embedding": [0.3, 0.4, ...],
|
||||
"source": "tmdb_images",
|
||||
"image_url": "https://image.tmdb.org/t/p/original/yyy.jpg",
|
||||
"angle": "profile_left",
|
||||
"quality_score": 0.88,
|
||||
"created_at": "2026-04-28T10:05:00Z"
|
||||
}
|
||||
],
|
||||
"voice_embeddings": [
|
||||
{
|
||||
"embedding": [0.1, 0.2, ...],
|
||||
"source": "video_segment",
|
||||
"file_uuid": "vid_001",
|
||||
"timestamp_start": 120.5,
|
||||
"timestamp_end": 135.2,
|
||||
"quality_score": 0.88,
|
||||
"created_at": "2026-04-28T11:00:00Z"
|
||||
}
|
||||
],
|
||||
"identity_embeddings": [
|
||||
{
|
||||
"embedding": [0.1, 0.2, ...],
|
||||
"source": "logo_image",
|
||||
"image_url": "https://www.accusys.com.tw/wp-content/uploads/2023/03/Accusys-Orange-2017.png",
|
||||
"context": "brand_logo",
|
||||
"created_at": "2026-04-28T12:00:00Z"
|
||||
}
|
||||
],
|
||||
"sound_embeddings": [
|
||||
{
|
||||
"embedding": [0.1, 0.2, ...],
|
||||
"source": "audio_segment",
|
||||
"file_uuid": "vid_001",
|
||||
"timestamp_start": 10.0,
|
||||
"timestamp_end": 15.0,
|
||||
"sound_type": "animal_dog_bark",
|
||||
"created_at": "2026-04-28T13:00:00Z"
|
||||
}
|
||||
],
|
||||
"image_urls": [
|
||||
"https://image.tmdb.org/t/p/original/xxx.jpg",
|
||||
"https://www.accusys.com.tw/wp-content/uploads/2023/03/Accusys-Orange-2017.png"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**欄位說明**:
|
||||
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| face_embeddings | Array | 多個 512-dim ArcFace embedding (不同角度/定妝造型) |
|
||||
| voice_embeddings | Array | 多個 192-dim ECAPA-TDNN embedding (不同音質片段) |
|
||||
| identity_embeddings | Array | 多個 768-dim CLIP ViT-L/14 embedding (logo/symbol/object) |
|
||||
| sound_embeddings | Array | TBD - 動物叫聲、雷雨、槍炮、樂器 (Phase 5+) |
|
||||
| image_urls | Array | 參考圖片 URL 列表 |
|
||||
|
||||
**子欄位說明**:
|
||||
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| embedding | Array | 向量值 |
|
||||
| source | String | 來源: tmdb_profile, tmdb_images, manual_upload, auto_detection, logo_image, audio_segment |
|
||||
| image_url | String | 圖片 URL (face/identity) |
|
||||
| file_uuid | UUID | 檔案 UUID (voice/sound) |
|
||||
| timestamp_start/end | Float | 時間範圍 (voice/sound) |
|
||||
| angle | String | 人臉角度: frontal, profile_left, profile_right, three_quarter |
|
||||
| quality_score | Float | 質量評分 (0.0-1.0) |
|
||||
| context | String | 識別場景: brand_logo, symbol, object, concept |
|
||||
| sound_type | String | 聲音類型: animal_dog_bark, environmental_thunder, weapon_gunshot, musical_guitar |
|
||||
| created_at | String | 建立時間 |
|
||||
|
||||
**設計理念**:
|
||||
1. **1對多匹配**: 同一 Identity 可有多個參考向量,提高識別鲁棒性
|
||||
2. **多角度覆蓋**: 人臉正面、側面、三側角度,覆蓋不同拍攝角度
|
||||
3. **多場景覆蓋**: Logo/Symbol 在不同場景(白底、黑底、複雜背景)的 embedding
|
||||
4. **質量評分**: 記錄每個參考向量的質量,用於加權匹配
|
||||
5. **來源追溯**: 記錄每個 embedding 的來源,方便追溯和更新
|
||||
|
||||
### File-Identities 表 (關聯表 - 用於記錄聚合後的結果或特定角色資訊)
|
||||
|
||||
**說明**: 用於記錄 Identity 在 File 中的**整體出現資訊** (如:角色名、定妝造型描述)。
|
||||
具體的臉部幀數據仍儲存在 `pre_chunks` 表中。
|
||||
|
||||
| 欄位 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| id | BIGSERIAL | Yes | 主鍵 |
|
||||
| file_uuid | UUID | Yes | File UUID |
|
||||
| identity_id | UUID | Yes | Identity UUID |
|
||||
| role_name | TEXT | No | 劇中角色名 (e.g., 蘇麗珍) |
|
||||
| costume_design | TEXT | No | 定妝造型描述 (e.g., 老妝) |
|
||||
| presentation | TEXT[] | No | 出現形式 (face, speaker, pose, name_mention) |
|
||||
| timestamp_start | FLOAT | No | 最早出現時間 |
|
||||
| timestamp_end | FLOAT | No | 最晚出現時間 |
|
||||
| match_confidence | FLOAT | No | 整體匹配置信度 |
|
||||
| is_confirmed | BOOLEAN | No | 是否已人工確認 |
|
||||
| status | VARCHAR(20) | No | detected, matched, confirmed |
|
||||
| created_at | TIMESTAMPTZ | Yes | 建立時間 |
|
||||
|
||||
```sql
|
||||
CREATE TABLE file_identities (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
file_uuid UUID REFERENCES files(file_uuid) ON DELETE CASCADE,
|
||||
identity_id UUID REFERENCES identities(identity_id) ON DELETE CASCADE,
|
||||
role_name TEXT,
|
||||
costume_design TEXT,
|
||||
presentation TEXT[] DEFAULT '{}',
|
||||
timestamp_start FLOAT,
|
||||
timestamp_end FLOAT,
|
||||
match_confidence FLOAT,
|
||||
is_confirmed BOOLEAN DEFAULT FALSE,
|
||||
status VARCHAR(20) DEFAULT 'detected',
|
||||
created_at TIMESTAMPTZ DEFAULT NOW(),
|
||||
UNIQUE(file_uuid, identity_id)
|
||||
);
|
||||
```
|
||||
|
||||
### Categories 表
|
||||
|
||||
| 欄位 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| code | VARCHAR(20) | Yes | 階層編號 (P-001-010/010) |
|
||||
| name | TEXT | Yes | 分類名稱 |
|
||||
| parent_code | VARCHAR(20) | No | 父分類代碼 |
|
||||
| category_type | VARCHAR(20) | No | file, identity, both |
|
||||
| description | TEXT | No | 描述 |
|
||||
| created_at | TIMESTAMPTZ | Yes | 建立時間 |
|
||||
|
||||
```sql
|
||||
CREATE TABLE categories (
|
||||
code VARCHAR(20) PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
parent_code VARCHAR(20) REFERENCES categories(code),
|
||||
category_type VARCHAR(20) DEFAULT 'both',
|
||||
description TEXT,
|
||||
created_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
|
||||
CREATE TABLE file_categories (
|
||||
file_uuid UUID REFERENCES files(file_uuid),
|
||||
category_code VARCHAR(20) REFERENCES categories(code),
|
||||
PRIMARY KEY (file_uuid, category_code)
|
||||
);
|
||||
|
||||
CREATE TABLE identity_categories (
|
||||
identity_id UUID REFERENCES identities(identity_id),
|
||||
category_code VARCHAR(20) REFERENCES categories(code),
|
||||
PRIMARY KEY (identity_id, category_code)
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 端點設計
|
||||
|
||||
### API Response 格式規範
|
||||
|
||||
**成功 Response (List)**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"total": 156,
|
||||
"page": 1,
|
||||
"page_size": 20,
|
||||
"data": [...]
|
||||
}
|
||||
```
|
||||
|
||||
**成功 Response (單一資源)**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {...}
|
||||
}
|
||||
```
|
||||
|
||||
**成功 Response (操作)**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "操作成功"
|
||||
}
|
||||
```
|
||||
|
||||
**錯誤 Response**:
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"error": {
|
||||
"code": "E001_NOT_FOUND",
|
||||
"message": "找不到指定的資源"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Candidates API
|
||||
|
||||
**定義**: 查詢 `pre_chunks` 表中 `processor_type = 'face'` 且 `identity_id IS NULL` 的紀錄。
|
||||
|
||||
| Method | Endpoint | 功能 | 說明 |
|
||||
|--------|----------|------|------|
|
||||
| `GET` | `/people/candidates` | 列出未確認的 face | 無 uuid 參數 = 全域搜尋 |
|
||||
|
||||
**Query 參數**:
|
||||
```
|
||||
?file_uuid={uuid} # 指定 File (可選)
|
||||
&page=1
|
||||
&page_size=20
|
||||
&sort=created_at # 排序欄位
|
||||
```
|
||||
|
||||
**Request**:
|
||||
```bash
|
||||
curl -X GET "https://api.yourdomain.com/people/candidates" \
|
||||
-H "X-API-Key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"total": 50,
|
||||
"page": 1,
|
||||
"page_size": 20,
|
||||
"data": [
|
||||
{
|
||||
"pre_chunk_id": 1001,
|
||||
"file_uuid": "vid_001",
|
||||
"frame_index": 3600,
|
||||
"timestamp": 120.5,
|
||||
"preview_image_url": "https://cdn.xxx.com/faces/face_11.jpg",
|
||||
"data": { "bounding_box": {...} },
|
||||
"agent_suggestion": {
|
||||
"type": "match_existing",
|
||||
"identity_id": "abc123",
|
||||
"identity_name": "張曼玉",
|
||||
"confidence": 0.85
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### People/Identities API
|
||||
|
||||
| Method | Endpoint | 功能 | 說明 |
|
||||
|--------|----------|------|------|
|
||||
| `GET` | `/people` | List All | 列出所有 People Identity |
|
||||
| `POST` | `/people/search` | Search | 複雜搜尋條件 |
|
||||
| `GET` | `/people/{identity_id}` | Detail | 獲取單個 Identity 詳情 |
|
||||
| `GET` | `/people/{identity_id}/resolve` | 出現在哪些 File | 獲取此人在哪些 File 中出現 |
|
||||
| `POST` | `/people` | Create | 建立新的 People Identity |
|
||||
| `PATCH` | `/people/{identity_id}` | Update | 更新 Identity 資訊 |
|
||||
| `POST` | `/people/merge` | Merge | 合併多個 Identity |
|
||||
| `POST` | `/people/{identity_id}/confirm-candidate` | Confirm | 確認 Candidate (更新 pre_chunk identity_id) |
|
||||
| `POST` | `/people/{identity_id}/remove-candidate` | Remove | 移除關聯 (設回 NULL) |
|
||||
|
||||
#### List All
|
||||
|
||||
**Request**:
|
||||
```bash
|
||||
curl -X GET "https://api.yourdomain.com/people?page=1&page_size=20&status=confirmed" \
|
||||
-H "X-API-Key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"total": 156,
|
||||
"page": 1,
|
||||
"page_size": 20,
|
||||
"data": [
|
||||
{
|
||||
"identity_id": "abc123",
|
||||
"name": "張曼玉",
|
||||
"identity_type": "people",
|
||||
"preview_image_url": "https://cdn.xxx.com/identities/abc123.jpg",
|
||||
"tmdb_id": 1234,
|
||||
"source": "tmdb",
|
||||
"status": "confirmed",
|
||||
"total_files": 5
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Confirm Candidate (更新 Face 歸屬)
|
||||
|
||||
**指定給現有 Identity**:
|
||||
```bash
|
||||
curl -X POST "https://api.yourdomain.com/people/{identity_id}/confirm-candidate" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"file_uuid": "vid_001",
|
||||
"pre_chunk_id": 1001
|
||||
}'
|
||||
```
|
||||
|
||||
*後端邏輯*:
|
||||
```sql
|
||||
UPDATE pre_chunks
|
||||
SET identity_id = '...', confidence = 0.95
|
||||
WHERE id = 1001 AND file_uuid = 'vid_001';
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Candidate confirmed"
|
||||
}
|
||||
```
|
||||
|
||||
#### Remove Candidate (取消歸屬)
|
||||
|
||||
```bash
|
||||
curl -X POST "https://api.yourdomain.com/people/{identity_id}/remove-candidate" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"file_uuid": "vid_001",
|
||||
"pre_chunk_id": 1001
|
||||
}'
|
||||
```
|
||||
|
||||
*後端邏輯*:
|
||||
```sql
|
||||
UPDATE pre_chunks
|
||||
SET identity_id = NULL, confidence = NULL
|
||||
WHERE id = 1001;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 錯誤碼定義
|
||||
|
||||
詳細錯誤碼請參考: `REFERENCE/API_ERROR_CODES.md`
|
||||
|
||||
| 錯誤碼 | HTTP 狀態 | 說明 |
|
||||
|--------|-----------|------|
|
||||
| `E001_NOT_FOUND` | 404 | 找不到資源 (File, Identity, Pre-chunk) |
|
||||
| `E002_DUPLICATE` | 409 | 資源已存在 (如重複註冊 Identity) |
|
||||
| `E003_VALIDATION` | 400 | 參數驗證失敗 |
|
||||
| `E004_PROCESSOR` | 500 | 處理器執行失敗 |
|
||||
| `E005_INTERNAL` | 500 | 系統內部錯誤 |
|
||||
|
||||
---
|
||||
|
||||
## 實作計畫
|
||||
|
||||
### Phase 0: 系統備份 (立即執行)
|
||||
|
||||
* [ ] 備份現有 PostgreSQL 資料庫
|
||||
* [ ] 備份現有程式碼
|
||||
* [ ] 記錄現有版本
|
||||
|
||||
### Phase 1: 建立新資料庫 Schema
|
||||
|
||||
* [ ] 建立 `files`, `identities`, `pre_chunks` 表
|
||||
* [ ] 建立 `file_identities`, `categories` 表
|
||||
* [ ] 建立索引
|
||||
* [ ] 建立測試資料
|
||||
|
||||
### Phase 2: 核心 API 實作
|
||||
|
||||
* [ ] Candidates API (`GET /people/candidates`) - 查詢 `identity_id IS NULL`
|
||||
* [ ] Identity CRUD API (`GET/POST/PATCH /people`)
|
||||
* [ ] Identity Search API (`POST /people/search`)
|
||||
* [ ] Identity Resolve API (`GET /people/{id}/resolve`)
|
||||
* [ ] Candidate Management (`POST /people/{id}/confirm-candidate`, `remove-candidate`)
|
||||
* [ ] Status API (`GET /people/status`)
|
||||
|
||||
### Phase 3: Processor 整合 (Pre-chunk 寫入)
|
||||
|
||||
* [ ] 修改 YOLO, Face, OCR 處理器,改寫入 `pre_chunks` 表
|
||||
* [ ] 實作 `PROCESSOR_RESUME_STRATEGY.md` 中的 Checkpoint 邏輯
|
||||
* [ ] probe Processor 整合 (ffprobe → File 分類)
|
||||
|
||||
### Phase 4: Portal 前端
|
||||
|
||||
* [ ] Candidates 介面
|
||||
* [ ] Identity 管理介面
|
||||
* [ ] File 管理介面
|
||||
|
||||
### Phase 5: 非 People Identity (待辦事項)
|
||||
|
||||
* [ ] Brand Identity 支援
|
||||
* [ ] Object Identity 支援
|
||||
* [ ] Concept Identity 支援
|
||||
|
||||
---
|
||||
|
||||
## 待辦事項
|
||||
|
||||
| 項目 | 優先級 | 說明 |
|
||||
|------|--------|------|
|
||||
| 系統備份 | 高 | 立即執行 |
|
||||
| 新資料庫 Schema | 高 | Phase 1 |
|
||||
| Core API | 高 | Phase 2 |
|
||||
| Processor 整合 | 中 | Phase 3 (寫入 pre_chunks) |
|
||||
| Portal 前端 | 中 | Phase 4 |
|
||||
| 非 People Identity | 低 | Phase 5 (待辦事項) |
|
||||
|
||||
---
|
||||
|
||||
## 限制條件
|
||||
|
||||
* 本設計為全新架構,不與現有系統共用資料
|
||||
* 需要做新的處理器版本產生新的輸出 (寫入 `pre_chunks` 而非 `chunks`)
|
||||
* 非 People Identity 列入待辦事項,不在本次實作範圍
|
||||
* Face 的唯一識別為 `file_uuid` + `coordinate_index` (Frame Number)
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
* `docs_v1.0/STANDARDS/DOCS_STANDARD.md` - 文件創建規範
|
||||
* `docs_v1.0/ARCHITECTURE/` - 架構相關文件
|
||||
* `docs_v1.0/PROCESSORS/_CORE/PROCESSOR_RESUME_STRATEGY.md` - 處理器續傳機制
|
||||
* `docs_v1.0/PROCESSORS/_CORE/RULE_SPECIFICATION.md` - Rule 依賴與數據流定義
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
* 版本: V1.2
|
||||
* 建立日期: 2026-04-25
|
||||
* 文件更新: 2026-04-28
|
||||
@@ -1,726 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry 系統全新 Mac 安裝指南"
|
||||
date: "2026-03-23"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "系統全新"
|
||||
- "安裝指南"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry 系統全新 Mac 安裝指南 的內容"
|
||||
- "Momentry 系統全新 Mac 安裝指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry 系統全新 Mac 安裝指南?"
|
||||
---
|
||||
|
||||
# Momentry 系統全新 Mac 安裝指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
| 適用對象 | 全新 Mac (Intel 或 Apple Silicon) |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 快速概覽
|
||||
|
||||
### 安裝時間估算
|
||||
|
||||
| 項目 | 時間 |
|
||||
|------|------|
|
||||
| 系統準備 | 30 分鐘 |
|
||||
| Homebrew 安裝 | 15 分鐘 |
|
||||
| 資料庫服務 | 30 分鐘 |
|
||||
| 應用服務 | 60 分鐘 |
|
||||
| Momentry Core | 20 分鐘 |
|
||||
| **總計** | **~2.5 小時** |
|
||||
|
||||
### 系統需求
|
||||
|
||||
| 項目 | 最低需求 | 推薦需求 |
|
||||
|------|----------|----------|
|
||||
| macOS | 13.0 Ventura | 14.0+ Sonoma |
|
||||
| 記憶體 | 8GB | 16GB+ |
|
||||
| 儲存空間 | 100GB | 500GB+ |
|
||||
| CPU | Apple Silicon M1 或 Intel i5 | M2/M3 或 Intel i7+ |
|
||||
|
||||
---
|
||||
|
||||
## 第一部分:系統準備
|
||||
|
||||
### 1.1 macOS 初始設定
|
||||
|
||||
首次開機後,執行以下設定:
|
||||
|
||||
```bash
|
||||
# 1. 設定電腦名稱
|
||||
sudo scutil --set ComputerName "Momentry"
|
||||
sudo scutil --set LocalHostName "momentry"
|
||||
|
||||
# 2. 啟用 SSH 遠端登入
|
||||
sudo systemsetup -setremotelogin on
|
||||
|
||||
# 3. 關閉休眠 (防止遠端斷線)
|
||||
sudo pmset -a sleep 0
|
||||
sudo pmset -a hibernatemode 0
|
||||
|
||||
# 4. 允許任何來源 App (安裝開發工具用)
|
||||
sudo spctl --master-disable
|
||||
|
||||
# 5. 設定時區
|
||||
sudo systemsetup -settimezone "Asia/Taipei"
|
||||
```
|
||||
|
||||
### 1.2 建立管理員帳戶
|
||||
|
||||
```bash
|
||||
# 建立 Momentry 管理員帳戶 (可選)
|
||||
sudo dscl . -create /Users/momentry
|
||||
sudo dscl . -create /Users/momentry UserShell /bin/zsh
|
||||
sudo dscl . -create /Users/momentry RealName "Momentry Admin"
|
||||
sudo dscl . -create /Users/momentry PrimaryGroupID 80
|
||||
sudo dscl . -create /Users/momentry UniqueID 1001
|
||||
sudo dscl . -passwd /Users/momentry "momentry_password"
|
||||
sudo dscl . -append /Groups/admin GroupMembership momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第二部分:Homebrew 安裝
|
||||
|
||||
### 2.1 安裝 Homebrew
|
||||
|
||||
```bash
|
||||
# 安裝 Homebrew
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
|
||||
# Apple Silicon 設定
|
||||
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
|
||||
eval "$(/opt/homebrew/bin/brew shellenv)"
|
||||
|
||||
# Intel Mac 設定
|
||||
# echo 'eval "$(/usr/local/bin/brew shellenv)"' >> ~/.zprofile
|
||||
# eval "$(/usr/local/bin/brew shellenv)"
|
||||
|
||||
# 驗證
|
||||
brew --version
|
||||
```
|
||||
|
||||
### 2.2 安裝基礎工具
|
||||
|
||||
```bash
|
||||
# 開發工具
|
||||
brew install \
|
||||
git \
|
||||
curl \
|
||||
wget \
|
||||
jq \
|
||||
yq \
|
||||
tree \
|
||||
htop \
|
||||
tmux \
|
||||
zsh \
|
||||
zsh-completions \
|
||||
ncdu \
|
||||
httpie \
|
||||
openssl \
|
||||
readline \
|
||||
sqlite \
|
||||
python@3.11 \
|
||||
rustup-init
|
||||
|
||||
# Rust 初始化
|
||||
rustup-init -y
|
||||
source "$HOME/.cargo/env"
|
||||
|
||||
# Python 虛擬環境
|
||||
python3.11 -m venv ~/.venv
|
||||
source ~/.venv/bin/activate
|
||||
pip install --upgrade pip
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第三部分:建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立目錄結構
|
||||
mkdir -p /Users/accusys/momentry/{var,etc,log,scripts,backup}
|
||||
mkdir -p /Users/accusys/momentry/var/{postgresql,mongodb,mariadb,redis,qdrant,n8n,ollama,sftpgo}
|
||||
mkdir -p /Users/accusys/momentry/etc/{sftpgo,caddy,gitea,php}
|
||||
mkdir -p /Users/accusys/momentry/scripts
|
||||
mkdir -p /Users/accusys/momentry/backup/{daily,weekly,monthly}
|
||||
mkdir -p /Users/accusys/workspace/sftpgo
|
||||
mkdir -p /Users/accusys/sftpgo_test/{demo,uploads}
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry
|
||||
chown -R accusys:staff /Users/accusys/workspace
|
||||
chown -R accusys:staff /Users/accusys/sftpgo_test
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第四部分:資料庫服務安裝
|
||||
|
||||
### 4.1 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install postgresql@18
|
||||
|
||||
# 啟動服務
|
||||
brew services start postgresql@18
|
||||
|
||||
# 建立資料庫
|
||||
createdb momentry
|
||||
createdb video_register
|
||||
createdb n8n
|
||||
createdb sftpgo
|
||||
|
||||
# 建立用戶
|
||||
psql -U accusys -d postgres << 'EOF'
|
||||
CREATE USER sftpgo WITH PASSWORD 'sftpgo_pass_2026';
|
||||
GRANT ALL PRIVILEGES ON DATABASE sftpgo TO sftpgo;
|
||||
GRANT ALL PRIVILEGES ON DATABASE momentry TO accusys;
|
||||
GRANT ALL PRIVILEGES ON DATABASE video_register TO accusys;
|
||||
GRANT ALL PRIVILEGES ON DATABASE n8n TO accusys;
|
||||
EOF
|
||||
|
||||
# 驗證
|
||||
pg_isready -h 127.0.0.1 -p 5432
|
||||
```
|
||||
|
||||
### 4.2 MongoDB
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew tap mongodb/brew
|
||||
brew install mongodb-community
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/mongodb
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/mongodb
|
||||
|
||||
# 啟動服務
|
||||
brew services start mongodb-community
|
||||
|
||||
# 建立用戶
|
||||
mongosh admin --eval "
|
||||
db.createUser({
|
||||
user: 'accusys',
|
||||
pwd: 'Test3200Test3200',
|
||||
roles: [
|
||||
{ role: 'readWriteAnyDatabase', db: 'admin' },
|
||||
{ role: 'dbAdminAnyDatabase', db: 'admin' }
|
||||
]
|
||||
});
|
||||
"
|
||||
|
||||
# 驗證
|
||||
mongosh --quiet --eval "db.adminCommand('ping')"
|
||||
```
|
||||
|
||||
### 4.3 Redis
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install redis
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 建立配置文件
|
||||
cat > /Users/accusys/momentry/etc/redis/redis.conf << 'EOF'
|
||||
requirepass accusys
|
||||
dir /Users/accusys/momentry/var/redis
|
||||
logfile /Users/accusys/momentry/log/redis.log
|
||||
daemonize no
|
||||
port 6379
|
||||
bind 127.0.0.1
|
||||
EOF
|
||||
|
||||
# 啟動服務
|
||||
redis-server /Users/accusys/momentry/etc/redis/redis.conf &
|
||||
sleep 2
|
||||
|
||||
# 驗證
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
### 4.4 MariaDB (WordPress)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install mariadb
|
||||
|
||||
# 啟動服務
|
||||
brew services start mariadb
|
||||
|
||||
# 安全設定
|
||||
mysql_secure_installation
|
||||
|
||||
# 建立資料庫
|
||||
mysql -u root << 'EOF'
|
||||
CREATE DATABASE wordpress CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
||||
CREATE USER 'wordpress'@'localhost' IDENTIFIED BY 'wordpress_password';
|
||||
GRANT ALL PRIVILEGES ON wordpress.* TO 'wordpress'@'localhost';
|
||||
FLUSH PRIVILEGES;
|
||||
EOF
|
||||
|
||||
# 驗證
|
||||
mysql -u root -e "SHOW DATABASES;"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第五部分:應用服務安裝
|
||||
|
||||
### 5.1 Ollama (LLM)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install ollama
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/ollama
|
||||
mkdir -p ~/.ollama/models
|
||||
|
||||
# 啟動服務
|
||||
brew services start ollama
|
||||
|
||||
# 下載模型
|
||||
ollama pull llama3.2
|
||||
ollama pull nomic-embed-text
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:11434/api/tags | jq '.models[].name'
|
||||
```
|
||||
|
||||
### 5.2 Caddy (反向代理)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install caddy
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/caddy
|
||||
|
||||
# 建立 Caddyfile
|
||||
cat > /Users/accusys/momentry/etc/caddy/Caddyfile << 'EOF'
|
||||
{
|
||||
admin off
|
||||
auto_https off
|
||||
}
|
||||
|
||||
# 範例:本地開發
|
||||
:8080 {
|
||||
respond "Momentry Server" 200
|
||||
}
|
||||
EOF
|
||||
|
||||
# 啟動服務
|
||||
brew services start caddy
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:8080
|
||||
```
|
||||
|
||||
### 5.3 Gitea (Git 服務)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install gitea
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/gitea
|
||||
mkdir -p /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 複製設定檔
|
||||
cp /opt/homebrew/etc/gitea/conf/app.ini /Users/accusys/momentry/etc/gitea/
|
||||
|
||||
# 啟動服務
|
||||
brew services start gitea
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:3000
|
||||
```
|
||||
|
||||
### 5.4 n8n (工作流程自動化)
|
||||
|
||||
```bash
|
||||
# 安裝 Node.js (如果尚未安裝)
|
||||
brew install node@22
|
||||
|
||||
# 全域安裝 n8n
|
||||
npm install -g n8n
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 設定環境變數
|
||||
export N8N_DATA_DIR=/Users/accusys/momentry/var/n8n
|
||||
export DB_TYPE=postgresdb
|
||||
export DB_POSTGRES_HOST=127.0.0.1
|
||||
export DB_POSTGRES_PORT=5432
|
||||
export DB_POSTGRES_DATABASE=n8n
|
||||
export DB_POSTGRES_USER=accusys
|
||||
export DB_POSTGRES_PASSWORD=accusys
|
||||
export N8N_ENCRYPTION_KEY=Test3200Test3200Test3200
|
||||
|
||||
# 啟動服務
|
||||
n8n start &
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:5678
|
||||
```
|
||||
|
||||
### 5.5 SFTPGo (SFTP 服務)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install sftpgo
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/sftpgo
|
||||
|
||||
# 建立配置文件
|
||||
cat > /Users/accusys/momentry/etc/sftpgo/sftpgo.json << 'EOF'
|
||||
{
|
||||
"data_provider": {
|
||||
"driver": "postgresql",
|
||||
"host": "127.0.0.1",
|
||||
"port": 5432,
|
||||
"username": "sftpgo",
|
||||
"password": "sftpgo_pass_2026",
|
||||
"name": "sftpgo",
|
||||
"create_default_admin": true
|
||||
},
|
||||
"httpd": {
|
||||
"bind_port": 8080,
|
||||
"bind_address": "127.0.0.1"
|
||||
},
|
||||
"sftpd": {
|
||||
"bindings": [
|
||||
{"port": 2022}
|
||||
]
|
||||
},
|
||||
"ftpd": {
|
||||
"bindings": [
|
||||
{"port": 0}
|
||||
]
|
||||
}
|
||||
}
|
||||
EOF
|
||||
|
||||
# 建立 launchd plist
|
||||
cat > /Library/LaunchDaemons/com.momentry.sftpgo.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.sftpgo</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/workspace/sftpgo</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/opt/homebrew/bin/sftpgo</string>
|
||||
<string>serve</string>
|
||||
<string>--config-file</string>
|
||||
<string>/Users/accusys/momentry/etc/sftpgo/sftpgo.json</string>
|
||||
</array>
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>PATH</key>
|
||||
<string>/opt/homebrew/bin:/opt/homebrew/sbin:/usr/bin:/bin</string>
|
||||
<key>HOME</key>
|
||||
<string>/Users/accusys</string>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_USERNAME</key>
|
||||
<string>admin</string>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_PASSWORD</key>
|
||||
<string>Test3200Test3200</string>
|
||||
</dict>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/sftpgo.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/sftpgo.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.sftpgo.plist
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s -X POST http://localhost:8080/api/v2/token -u "admin:Test3200Test3200"
|
||||
```
|
||||
|
||||
### 5.6 Qdrant (向量資料庫)
|
||||
|
||||
```bash
|
||||
# 安裝 Rust (如果尚未安裝)
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
source "$HOME/.cargo/env"
|
||||
|
||||
# 安裝 Qdrant
|
||||
cargo install qdrant
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant/storage
|
||||
|
||||
# 啟動服務
|
||||
qdrant --data-path /Users/accusys/momentry/var/qdrant/storage --api-key Test3200Test3200Test3200 &
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s http://localhost:6333/collections -H "api-key: Test3200Test3200Test3200"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第六部分:Momentry Core 安裝
|
||||
|
||||
### 6.1 安裝依賴
|
||||
|
||||
```bash
|
||||
# 安裝 Python 依賴
|
||||
pip install \
|
||||
openai-whisper \
|
||||
ultralytics \
|
||||
opencv-python \
|
||||
pillow \
|
||||
python-dotenv \
|
||||
requests \
|
||||
httpx
|
||||
|
||||
# 安裝 FFmpeg
|
||||
brew install ffmpeg
|
||||
```
|
||||
|
||||
### 6.2 安裝 Momentry Core
|
||||
|
||||
```bash
|
||||
# 克隆或進入專案目錄
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
|
||||
# 編譯專案
|
||||
cargo build --release
|
||||
|
||||
# 複製執行檔
|
||||
cp target/release/momentry /usr/local/bin/
|
||||
|
||||
# 建立 launchd plist
|
||||
cat > /Library/LaunchDaemons/com.momentry.api.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.api</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/usr/local/bin/momentry</string>
|
||||
<string>server</string>
|
||||
<string>--host</string>
|
||||
<string>0.0.0.0</string>
|
||||
<string>--port</string>
|
||||
<string>3002</string>
|
||||
</array>
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>DATABASE_URL</key>
|
||||
<string>postgres://accusys:accusys@127.0.0.1:5432/momentry</string>
|
||||
<key>RUST_LOG</key>
|
||||
<string>info</string>
|
||||
</dict>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第七部分:服務驗證
|
||||
|
||||
### 7.1 健康檢查腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# health_check.sh
|
||||
|
||||
echo "=========================================="
|
||||
echo "Momentry System Health Check"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
|
||||
# PostgreSQL
|
||||
pg_isready -h 127.0.0.1 -p 5432 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ PostgreSQL" || echo "❌ PostgreSQL"
|
||||
|
||||
# MongoDB
|
||||
mongosh --quiet --eval "db.adminCommand('ping')" > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ MongoDB" || echo "❌ MongoDB"
|
||||
|
||||
# Redis
|
||||
redis-cli -a accusys ping > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Redis" || echo "❌ Redis"
|
||||
|
||||
# Ollama
|
||||
curl -s http://localhost:11434/api/tags > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Ollama" || echo "❌ Ollama"
|
||||
|
||||
# n8n
|
||||
curl -s http://localhost:5678 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ n8n" || echo "❌ n8n"
|
||||
|
||||
# SFTPGo
|
||||
curl -s http://localhost:8080 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ SFTPGo" || echo "❌ SFTPGo"
|
||||
|
||||
# Qdrant
|
||||
curl -s http://localhost:6333/ > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Qdrant" || echo "❌ Qdrant"
|
||||
|
||||
# Momentry API
|
||||
curl -s http://localhost:3002/health > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Momentry API" || echo "❌ Momentry API"
|
||||
|
||||
# Caddy
|
||||
curl -sI http://localhost:8080 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Caddy" || echo "❌ Caddy"
|
||||
|
||||
echo ""
|
||||
echo "=========================================="
|
||||
```
|
||||
|
||||
### 7.2 執行驗證
|
||||
|
||||
```bash
|
||||
# 儲存並執行
|
||||
chmod +x health_check.sh
|
||||
./health_check.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第八部分:重要憑證總覽
|
||||
|
||||
### 8.1 服務密碼
|
||||
|
||||
| 服務 | 用戶名 | 密碼 | 用途 |
|
||||
|------|--------|------|------|
|
||||
| **PostgreSQL** | accusys | `accusys` | 主要資料庫 |
|
||||
| **PostgreSQL** | sftpgo | `sftpgo_pass_2026` | SFTPGo 資料庫 |
|
||||
| **MongoDB** | accusys | `Test3200Test3200` | 文件資料庫 |
|
||||
| **Redis** | - | `accusys` | 快取服務 |
|
||||
| **n8n** | - | `Test3200Test3200Test3200` | n8n 加密金鑰 |
|
||||
| **SFTPGo** | admin | `Test3200Test3200` | SFTPGo 管理員 |
|
||||
| **Qdrant** | - | `Test3200Test3200Test3200` | Qdrant API Key |
|
||||
| **MariaDB** | root | (設定時指定) | WordPress 資料庫 |
|
||||
| **MariaDB** | wordpress | `wordpress_password` | WordPress 資料庫用戶 |
|
||||
|
||||
### 8.2 服務連接埠
|
||||
|
||||
| 服務 | 連接埠 | 協定 |
|
||||
|------|--------|------|
|
||||
| PostgreSQL | 5432 | TCP |
|
||||
| MongoDB | 27017 | TCP |
|
||||
| Redis | 6379 | TCP |
|
||||
| Ollama | 11434 | HTTP |
|
||||
| n8n | 5678 | HTTP |
|
||||
| SFTPGo | 8080 | HTTP |
|
||||
| SFTPGo | 2022 | SFTP |
|
||||
| Qdrant | 6333 | HTTP |
|
||||
| Momentry API | 3002 | HTTP |
|
||||
| Caddy | 80/443 | HTTP/HTTPS |
|
||||
| Gitea | 3000 | HTTP |
|
||||
| PHP-FPM | 9000 | TCP |
|
||||
|
||||
---
|
||||
|
||||
## 第九部分:相關文檔
|
||||
|
||||
| 文檔 | 說明 |
|
||||
|------|------|
|
||||
| `SERVICES.md` | 服務詳細說明 |
|
||||
| `INSTALL_POSTGRESQL.md` | PostgreSQL 安裝指南 |
|
||||
| `INSTALL_MONGODB.md` | MongoDB 安裝指南 |
|
||||
| `INSTALL_REDIS.md` | Redis 安裝指南 |
|
||||
| `INSTALL_QDRANT.md` | Qdrant 安裝指南 |
|
||||
| `INSTALL_N8N.md` | n8n 安裝指南 |
|
||||
| `INSTALL_SFTPGO.md` | SFTPGo 安裝指南 |
|
||||
| `SFTPGO_DEMO_USER.md` | SFTPGo Demo 用戶指南 |
|
||||
| `MOMENTRY_CORE_MONITORING.md` | 監控規範 |
|
||||
| `API_INDEX.md` | API 文件索引 |
|
||||
|
||||
---
|
||||
|
||||
## 附錄:常見問題
|
||||
|
||||
### Q1: n8n 無法連接 PostgreSQL
|
||||
|
||||
確保資料庫用戶有登入權限:
|
||||
```bash
|
||||
psql -U accusys -d postgres -c "ALTER USER accusys WITH LOGIN;"
|
||||
```
|
||||
|
||||
### Q2: SFTPGo 無法啟動
|
||||
|
||||
檢查 PostgreSQL 是否運行:
|
||||
```bash
|
||||
pg_isready -h 127.0.0.1 -p 5432
|
||||
```
|
||||
|
||||
### Q3: Qdrant API Key 無效
|
||||
|
||||
使用正確的 API Key:
|
||||
```bash
|
||||
curl -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
```
|
||||
|
||||
### Q4: Momentry API 無法啟動
|
||||
|
||||
檢查環境變數:
|
||||
```bash
|
||||
export DATABASE_URL="postgres://accusys:accusys@127.0.0.1:5432/momentry"
|
||||
export RUST_LOG=debug
|
||||
momentry server --host 0.0.0.0 --port 3002
|
||||
```
|
||||
@@ -1,487 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "CADDY"
|
||||
title: "Caddy 安裝指南 (本地部署)"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "caddy"
|
||||
- "reverse-proxy"
|
||||
- "web-server"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Caddy 反向代理?"
|
||||
- "Caddy 配置檔案路徑在哪裡?"
|
||||
- "如何配置 Caddy 開機自動啟動?"
|
||||
---
|
||||
|
||||
# Caddy 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Caddy Web Server,配置為本地部署,作為反向代理伺服器。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Caddy | ✅ 已安裝 v2.10.2 |
|
||||
| 設定檔 | /Users/accusys/momentry/etc/Caddyfile |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.caddy.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Caddy (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Caddy
|
||||
brew install caddy
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
caddy --version
|
||||
# v2.10.2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/caddy
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/caddy
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/caddy.log
|
||||
touch /Users/accusys/momentry/log/caddy.error.log
|
||||
|
||||
# 設定權限
|
||||
# 注意: Caddy 使用 ports 80/443,必須以 root 身份運行
|
||||
# 因此 var/caddy 目錄需要 root:admin 權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/caddy
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
sudo chown -R root:admin /Users/accusys/momentry/var/caddy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/Caddyfile`:
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
metrics
|
||||
}
|
||||
|
||||
# 定義日誌 Snippet
|
||||
(common_log) {
|
||||
log {
|
||||
output file /Users/accusys/momentry/log/{args[0]}.log {
|
||||
roll_size 100mb
|
||||
roll_keep 5
|
||||
roll_keep_for 720h
|
||||
}
|
||||
format json
|
||||
}
|
||||
}
|
||||
|
||||
# Example: 反向代理到本地服務
|
||||
example.momentry.ddns.net {
|
||||
reverse_proxy localhost:8080 {
|
||||
header_up Host {upstream_hostport}
|
||||
}
|
||||
import common_log example_access
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
**注意**: Caddy 需要使用 ports 80 和 443,必須以 root 身份運行。
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.caddy.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "caddy"
|
||||
type: "http"
|
||||
port: 80
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:2019/config/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/etc/caddy/` | 配置 | **不要刪除** - Caddy 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/Users/accusys/momentry/var/caddy/` | 數據 | **不要刪除** - Caddy 數據 |
|
||||
| `/opt/homebrew/opt/caddy/` | 安裝 | **刪除** - Caddy 安裝目錄 |
|
||||
| `/opt/homebrew/opt/caddy/` | 安裝 | **刪除** - Caddy 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Caddy
|
||||
|
||||
```bash
|
||||
# 找到 Caddy 進程
|
||||
ps aux | grep caddy | grep -v grep
|
||||
|
||||
# 停止 Caddy
|
||||
pkill caddy
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep caddy | grep -v grep || echo "Caddy 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Caddy
|
||||
|
||||
```bash
|
||||
# 卸載 Caddy
|
||||
brew uninstall caddy
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/caddy.log
|
||||
rm -f /Users/accusys/momentry/log/caddy.error.log
|
||||
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/caddy
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
# /Users/accusys/momentry/var
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Caddy 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Caddy 進程
|
||||
echo "1. Caddy 進程:"
|
||||
ps aux | grep caddy | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 80/443
|
||||
echo "2. Port 80/443:"
|
||||
(lsof -i :80 > /dev/null 2>&1 || lsof -i :443 > /dev/null 2>&1) && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. caddy 命令
|
||||
echo "3. caddy 命令:"
|
||||
which caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 配置目錄 (可選刪除)
|
||||
echo "6. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Caddy 卸載後檢查 ===
|
||||
1. Caddy 進程:
|
||||
✓ 已停止
|
||||
2. Port 80/443:
|
||||
✓ 已釋放
|
||||
3. caddy 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 配置目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep caddy | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :80
|
||||
lsof -i :443
|
||||
lsof -i :2019
|
||||
|
||||
# 3. 測試配置語法
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 4. 查看 Caddy 版本
|
||||
caddy version
|
||||
|
||||
# 5. 重新載入配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/caddy.log
|
||||
|
||||
# 7. 查看 Caddy 適配的網站
|
||||
curl -I http://localhost:2019/config/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Caddyfile 範例
|
||||
|
||||
### 基本反向代理
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 反向代理到本地服務
|
||||
example.local {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
```
|
||||
|
||||
### 帶 SSL 的反向代理
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 使用 Let's Encrypt 自動 SSL
|
||||
example.momentry.ddns.net {
|
||||
reverse_proxy localhost:8080 {
|
||||
header_up Host {upstream_hostport}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 多站點配置
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 站點 1
|
||||
site1.example.com {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
|
||||
# 站點 2
|
||||
site2.example.com {
|
||||
reverse_proxy localhost:8081
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
CADDY_CONFIG=/Users/accusys/momentry/etc/Caddyfile
|
||||
CADDY_HOME=/Users/accusys/.local/share/caddy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Caddy 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/caddy.log
|
||||
|
||||
# 檢查配置語法
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/etc/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/etc
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 80
|
||||
lsof -i :80
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入配置
|
||||
|
||||
```bash
|
||||
# 重新載入配置 (熱重載)
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 或者停止後重新啟動
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/caddy/` | Caddy 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/caddy/bin/caddy` | Caddy 執行檔 |
|
||||
| 配置 | `/Users/accusys/momentry/etc/Caddyfile` | 設定檔 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/caddy.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/caddy.error.log` | 錯誤日誌 |
|
||||
| 數據 | `/Users/accusys/momentry/var/caddy/` | Caddy 數據目錄 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.caddy.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/caddy_backup/Caddyfile` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 驗證配置
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 熱重載配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 停止 Caddy
|
||||
caddy stop
|
||||
|
||||
# 啟動 Caddy
|
||||
caddy start --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 適配所有網站
|
||||
caddy adapt --config /Users/accusys/momentry/etc/Caddyfile --adapter caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/daily/caddy"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 備份配置
|
||||
tar -czf "$BACKUP_DIR/caddy_cfg_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 驗證
|
||||
sha256sum "$BACKUP_DIR/caddy_cfg_${TIMESTAMP}.tar.gz" > "$BACKUP_DIR/caddy_${TIMESTAMP}.sha256"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 解壓配置
|
||||
tar -xzf /Users/accusys/momentry/backup/daily/caddy/caddy_cfg_20260316_102416.tar.gz -C /
|
||||
|
||||
# 驗證並重載
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 2.10.2
|
||||
- 配置: /Users/accusys/momentry/etc/Caddyfile
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,430 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "GITEA"
|
||||
title: "Gitea 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "gitea"
|
||||
- "git-server"
|
||||
- "version-control"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Gitea 本地 Git 伺服器?"
|
||||
- "Gitea 數據目錄路徑在哪裡?"
|
||||
- "如何配置 Gitea 開機自動啟動?"
|
||||
---
|
||||
|
||||
# Gitea 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Gitea Git 服務,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Gitea | ✅ 已安裝 v1.25.3 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/gitea/ |
|
||||
| 配置目錄 | /Users/accusys/momentry/etc/gitea/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Gitea (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Gitea
|
||||
brew install gitea
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
gitea --version
|
||||
# gitea version 1.25.3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/gitea/data
|
||||
mkdir -p /Users/accusys/momentry/var/gitea/log
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/gitea.log
|
||||
touch /Users/accusys/momentry/log/gitea.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/gitea
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/gitea
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/gitea/app.ini`:
|
||||
|
||||
```ini
|
||||
APP_NAME = Gitea: Git with a cup of tea
|
||||
RUN_USER = accusys
|
||||
WORK_PATH = /Users/accusys/momentry/var/gitea
|
||||
RUN_MODE = prod
|
||||
|
||||
[database]
|
||||
DB_TYPE = postgres
|
||||
HOST = 127.0.0.1:5432
|
||||
NAME = gitea
|
||||
USER = gitea
|
||||
PASSWD = gitea_pass
|
||||
SSL_MODE = disable
|
||||
|
||||
[repository]
|
||||
ROOT = /Users/accusys/momentry/var/gitea/data/gitea-repositories
|
||||
|
||||
[server]
|
||||
SSH_DOMAIN = gitea.momentry.ddns.net
|
||||
DOMAIN = gitea.momentry.ddns.net
|
||||
HTTP_PORT = 3000
|
||||
ROOT_URL = http://gitea.momentry.ddns.net:3000/
|
||||
APP_DATA_PATH = /Users/accusys/momentry/var/gitea/data
|
||||
DISABLE_SSH = false
|
||||
SSH_PORT = 2222
|
||||
LFS_START_SERVER = true
|
||||
OFFLINE_MODE = true
|
||||
|
||||
[lfs]
|
||||
PATH = /Users/accusys/momentry/var/gitea/data/lfs
|
||||
|
||||
[log]
|
||||
MODE = console, file
|
||||
ROOT_PATH = /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.gitea.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "gitea"
|
||||
type: "http"
|
||||
port: 3000
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:3000/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/gitea/` | 數據 | **不要刪除** - Gitea 數據 |
|
||||
| `/Users/accusys/momentry/etc/gitea/` | 配置 | **不要刪除** - Gitea 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/gitea/` | 安裝 | **刪除** - Gitea 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Gitea
|
||||
|
||||
```bash
|
||||
# 找到 Gitea 進程
|
||||
ps aux | grep gitea | grep -v grep
|
||||
|
||||
# 停止 Gitea
|
||||
pkill gitea
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep gitea | grep -v grep || echo "Gitea 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Gitea
|
||||
|
||||
```bash
|
||||
# 卸載 Gitea
|
||||
brew uninstall gitea
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/gitea
|
||||
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/gitea.log
|
||||
rm -f /Users/accusys/momentry/log/gitea.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Gitea 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Gitea 進程
|
||||
echo "1. Gitea 進程:"
|
||||
ps aux | grep gitea | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 3000
|
||||
echo "2. Port 3000:"
|
||||
lsof -i :3000 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. gitea 命令
|
||||
echo "3. gitea 命令:"
|
||||
which gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/gitea" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 配置目錄 (可選刪除)
|
||||
echo "7. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc/gitea" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Gitea 卸載後檢查 ===
|
||||
1. Gitea 進程:
|
||||
✓ 已停止
|
||||
2. Port 3000:
|
||||
✓ 已釋放
|
||||
3. gitea 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 配置目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep gitea | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :3000
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:3000/
|
||||
|
||||
# 4. 查看版本
|
||||
gitea --version
|
||||
|
||||
# 5. 驗證配置
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/gitea.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| URL | http://localhost:3000 |
|
||||
| Domain | gitea.momentry.ddns.net |
|
||||
| SSH Port | 2222 |
|
||||
| Database | PostgreSQL (gitea) |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
GITEA_URL=http://localhost:3000
|
||||
GITEA_ROOT=/Users/accusys/momentry/var/gitea/data/gitea-repositories
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Gitea 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea.log
|
||||
|
||||
# 檢查配置語法
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/gitea/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/gitea
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 3000
|
||||
lsof -i :3000
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.gitea.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/gitea/` | Gitea 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/gitea/bin/gitea` | Gitea 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/gitea/data/` | 數據儲存 |
|
||||
| 配置 | `/Users/accusys/momentry/etc/gitea/app.ini` | 設定檔 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/gitea.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/gitea.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.gitea.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/gitea_backup/app.ini` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 資料庫資訊
|
||||
|
||||
Gitea 使用 PostgreSQL 作為資料庫:
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Database | gitea |
|
||||
| User | gitea |
|
||||
| Host | 127.0.0.1:5432 |
|
||||
| Password | gitea_pass |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 啟動 Gitea
|
||||
gitea web --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 驗證配置
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 查看版本
|
||||
gitea --version
|
||||
|
||||
# 備份數據
|
||||
gitea dump --config /Users/accusys/momentry/etc/gitea/app.ini --zipfile /Users/accusys/momentry/var/gitea_backup.zip
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.25.3
|
||||
- HTTP Port: 3000
|
||||
- SSH Port: 2222
|
||||
- 數據目錄: /Users/accusys/momentry/var/gitea/
|
||||
- 配置: /Users/accusys/momentry/etc/gitea/app.ini
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,413 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "GITEA_MCP"
|
||||
title: "Gitea MCP Server 安裝指南 (本地部署)"
|
||||
date: "2026-03-24"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "gitea"
|
||||
- "mcp-server"
|
||||
- "ai-agent"
|
||||
- "git-integration"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Gitea MCP Server?"
|
||||
- "如何配置 MCP 與 Gitea 整合?"
|
||||
- "Gitea MCP Server 的 Webhook 路徑為何?"
|
||||
---
|
||||
|
||||
# Gitea MCP Server 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-24 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-24 | 創建文件 | OpenCode | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Gitea MCP Server,配置為透過 OpenCode MCP 整合存取 Gitea API。
|
||||
|
||||
Gitea MCP Server 是一個 MCP (Model Context Protocol) 伺服器,提供對 Gitea API 的完整存取能力,包括 repos、issues、pull requests、workflows 等資源管理。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Gitea MCP Server | ✅ 已安裝 |
|
||||
| 安裝方式 | Homebrew (`gitea-mcp-server`) |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist |
|
||||
| 執行身份 | accusys |
|
||||
| 監聽端口 | 8787 |
|
||||
| Gitea 主機 | http://localhost:3000 |
|
||||
| Launchd 狀態 | ✅ 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
---
|
||||
|
||||
## 前置條件
|
||||
|
||||
- Gitea 服務已運行(端口 3000)
|
||||
- Homebrew 已安裝
|
||||
- 管理員權限
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Gitea MCP Server
|
||||
|
||||
```bash
|
||||
brew install gitea-mcp-server
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which gitea-mcp-server
|
||||
# /opt/homebrew/bin/gitea-mcp-server
|
||||
|
||||
/opt/homebrew/bin/gitea-mcp-server --help
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 創建日誌目錄
|
||||
|
||||
```bash
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
touch /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
touch /Users/accusys/momentry/log/gitea-mcp-server.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 獲取 Gitea API Token
|
||||
|
||||
#### 步驟 3.1: 登入 Gitea
|
||||
|
||||
1. 開啟瀏覽器,訪問 http://localhost:3000
|
||||
2. 使用管理員帳號登入
|
||||
|
||||
#### 步驟 3.2: 生成 Personal Access Token
|
||||
|
||||
1. 點擊右上角頭像 → **Settings**
|
||||
2. 左側選單選擇 **Applications**
|
||||
3. 在 **Access Tokens** 區塊:
|
||||
- **Token Name**: `opencode-mcp`
|
||||
- **Expiration**: 選擇過期時間(如 365 days)
|
||||
- **Scopes**: 勾選需要的權限
|
||||
- `repo` - 倉庫操作
|
||||
- `read:user` - 讀取用戶資訊
|
||||
- `read:org` - 讀取組織資訊
|
||||
4. 點擊 **Generate Token**
|
||||
5. **立即複製** 生成的 Token
|
||||
|
||||
#### 步驟 3.3: 驗證 Token
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: token <YOUR_TOKEN>" http://localhost:3000/api/v1/user
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 創建 Plist 檔案
|
||||
|
||||
```bash
|
||||
sudo tee /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.gitea-mcp-server</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/opt/homebrew/bin/gitea-mcp-server</string>
|
||||
<string>-transport</string>
|
||||
<string>http</string>
|
||||
<string>-port</string>
|
||||
<string>8787</string>
|
||||
<string>-host</string>
|
||||
<string>http://localhost:3000</string>
|
||||
<string>-token</string>
|
||||
<string><GITEA_TOKEN></string>
|
||||
</array>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/gitea-mcp-server.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/gitea-mcp-server.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
```
|
||||
|
||||
**注意**: 將 `<GITEA_TOKEN>` 替換為實際的 Token 值。
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 設定權限
|
||||
|
||||
```bash
|
||||
sudo chown root:wheel /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
sudo chmod 644 /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: 載入服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 7: 驗證服務
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
sudo launchctl list | grep gitea-mcp-server
|
||||
|
||||
# 檢查進程
|
||||
ps aux | grep gitea-mcp-server | grep -v grep
|
||||
|
||||
# 測試端點
|
||||
curl -s http://localhost:8787/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 8: 整合 OpenCode MCP
|
||||
|
||||
#### 步驟 8.1: 更新 OpenCode 配置
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 步驟 8.2: 重啟 OpenCode
|
||||
|
||||
```bash
|
||||
# 停止現有 OpenCode
|
||||
pkill -f opencode
|
||||
|
||||
# 重新啟動
|
||||
opencode
|
||||
```
|
||||
|
||||
#### 步驟 8.3: 驗證 MCP 連接
|
||||
|
||||
在 OpenCode 中執行:
|
||||
|
||||
```
|
||||
/mcps
|
||||
```
|
||||
|
||||
確認 gitea 顯示為 `connected`。
|
||||
|
||||
---
|
||||
|
||||
## Plist 參數說明
|
||||
|
||||
| 參數 | 說明 | 值 |
|
||||
|------|------|-----|
|
||||
| `-transport` | 傳輸類型 | `http` |
|
||||
| `-port` | HTTP 監聽端口 | `8787` |
|
||||
| `-host` | Gitea 主機 URL | `http://localhost:3000` |
|
||||
| `-token` | Gitea API Token | 見 Step 3 |
|
||||
|
||||
---
|
||||
|
||||
## 管理指令
|
||||
|
||||
### 啟動服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 停止服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 重啟服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 查看日誌
|
||||
|
||||
```bash
|
||||
# 即時查看日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
|
||||
# 錯誤日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### Step 1: 停止服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 移除 Plist
|
||||
|
||||
```bash
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 從 OpenCode 配置移除
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`,移除 `mcp.gitea` 區塊。
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 服務無法啟動
|
||||
|
||||
1. 檢查 Token 是否正確
|
||||
2. 檢查 Gitea 是否運行:`curl -s http://localhost:3000/`
|
||||
3. 檢查日誌:`/Users/accusys/momentry/log/gitea-mcp-server.error.log`
|
||||
|
||||
---
|
||||
|
||||
### Token 無效
|
||||
|
||||
1. 確認 Token 未過期
|
||||
2. 確認 Token 有足夠的權限
|
||||
3. 重新生成 Token
|
||||
|
||||
---
|
||||
|
||||
### 端口被佔用
|
||||
|
||||
```bash
|
||||
# 檢查端口占用
|
||||
lsof -i :8787
|
||||
|
||||
# 修改 plist 中的端口後重新載入
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### OpenCode MCP 未顯示
|
||||
|
||||
1. 確認 OpenCode 已重啟
|
||||
2. 檢查 `~/.config/opencode/opencode.json` 格式正確
|
||||
3. 確認 gitea-mcp-server 程序正在運行
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist | Launchd 服務配置 |
|
||||
| 日誌 | /Users/accusys/momentry/log/gitea-mcp-server.log | 標準輸出日誌 |
|
||||
| 錯誤日誌 | /Users/accusys/momentry/log/gitea-mcp-server.error.log | 錯誤日誌 |
|
||||
| OpenCode 配置 | ~/.config/opencode/opencode.json | MCP 設定檔 |
|
||||
| Gitea | http://localhost:3000 | Gitea Web UI |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 驗證服務狀態
|
||||
sudo launchctl list | grep gitea-mcp-server
|
||||
|
||||
# 查看服務 PID
|
||||
ps aux | grep gitea-mcp-server | grep -v grep
|
||||
|
||||
# 測試端點
|
||||
curl -s http://localhost:8787/
|
||||
|
||||
# 驗證 Gitea 連接
|
||||
curl -H "Authorization: token <TOKEN>" http://localhost:3000/api/v1/user
|
||||
|
||||
# 查看即時日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.0
|
||||
- 安裝日期: 2026-03-24
|
||||
- 文件更新: 2026-03-24
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OpenCode MCP 整合](./N8N_MCP_SETUP.md) - n8n MCP 設定說明
|
||||
- [服務總覽](./SERVICES.md) - 所有服務狀態總覽
|
||||
- [待解決問題](./PENDING_ISSUES.md) - MCP 安裝狀態追蹤
|
||||
@@ -1,416 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "MARIADB"
|
||||
title: "MariaDB 安裝指南 (本地部署)"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "mariadb"
|
||||
- "database"
|
||||
- "macos"
|
||||
- "sql"
|
||||
ai_query_hints:
|
||||
- "如何安裝 MariaDB 資料庫?"
|
||||
- "MariaDB 連線資訊為何?"
|
||||
- "如何備份與恢復 MariaDB 數據?"
|
||||
---
|
||||
|
||||
# MariaDB 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 MariaDB,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| MariaDB | ✅ 已安裝 v12.1.2 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/mariadb/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.mariadb.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 MariaDB (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 MariaDB
|
||||
brew install mariadb
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
mariadb --version
|
||||
# mariadb from 12.1.2-MariaDB
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/mariadb
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/mariadb.log
|
||||
touch /Users/accusys/momentry/log/mariadb.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/mariadb
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/mariadb
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
**注意**: 如果需要從舊數據遷移,需要先初始化新目錄:
|
||||
```bash
|
||||
# 初始化新數據目錄
|
||||
mysql_install_db --datadir=/Users/accusys/momentry/var/mariadb
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.mariadb.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
mariadb:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 3306
|
||||
user: "root"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/mariadb/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/mariadb/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/mariadb/` | 安裝 | **刪除** - MariaDB 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 MariaDB
|
||||
|
||||
```bash
|
||||
# 找到 MariaDB 進程
|
||||
ps aux | grep mariadb | grep -v grep
|
||||
|
||||
# 停止 MariaDB
|
||||
mysqladmin -u root -p shutdown
|
||||
# 或
|
||||
pkill mariadbd
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep mariadb | grep -v grep || echo "MariaDB 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 MariaDB
|
||||
|
||||
```bash
|
||||
# 卸載 MariaDB
|
||||
brew uninstall mariadb
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/mariadb.log
|
||||
rm -f /Users/accusys/momentry/log/mariadb.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== MariaDB 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 MariaDB 進程
|
||||
echo "1. MariaDB 進程:"
|
||||
ps aux | grep mariadb | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 3306
|
||||
echo "2. Port 3306:"
|
||||
lsof -i :3306 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. mariadb 命令
|
||||
echo "3. mariadb 命令:"
|
||||
which mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/mariadb" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== MariaDB 卸載後檢查 ===
|
||||
1. MariaDB 進程:
|
||||
✓ 已停止
|
||||
2. Port 3306:
|
||||
✓ 已釋放
|
||||
3. mariadb 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep mariadb | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :3306
|
||||
|
||||
# 3. 測試連線
|
||||
mariadb -u root -e "SELECT 1;"
|
||||
|
||||
# 4. 查看所有數據庫
|
||||
mariadb -u root -e "SHOW DATABASES;"
|
||||
|
||||
# 5. 查看用戶
|
||||
mariadb -u root -e "SELECT User, Host FROM mysql.user;"
|
||||
|
||||
# 6. 查看表
|
||||
mariadb -u root -e "USE mysql; SHOW TABLES;"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/mariadb.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 3306 |
|
||||
| User | root |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
MARIADB_URL=mariadb://root@localhost:3306
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- MariaDB 綁定到所有網路介面 (0.0.0.0)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請設定用戶權限限制訪問
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MariaDB 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/mariadb.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/mariadb/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/mariadb
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 3306
|
||||
lsof -i :3306
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mariadb.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/mariadb/` | MariaDB 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/mariadb/bin/mariadbd` | MariaDB 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/mariadb/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/mariadb.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/mariadb.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.mariadb.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/mariadb_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份用戶配置
|
||||
|
||||
已創建專用備份用戶:
|
||||
- 用戶名:`momentry_backup`
|
||||
- 密碼:`momentry_backup_pwd_2026`
|
||||
- 權限:SELECT, LOCK TABLES, SHOW VIEW, EVENT, TRIGGER
|
||||
|
||||
### 備份 (mysqldump)
|
||||
|
||||
```bash
|
||||
# 備份所有數據庫
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
mysqldump -u momentry_backup -pmomentry_backup_pwd_2026 --all-databases | gzip > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_all_${TIMESTAMP}.sql.gz
|
||||
|
||||
# 備份指定數據庫 (WordPress)
|
||||
mysqldump -u momentry_backup -pmomentry_backup_pwd_2026 wordpress | gzip > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_wordpress_${TIMESTAMP}.sql.gz
|
||||
|
||||
# 驗證
|
||||
sha256sum /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_*.sql.gz > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_${TIMESTAMP}.sha256
|
||||
```
|
||||
|
||||
### 恢復 (mysql)
|
||||
|
||||
```bash
|
||||
# 恢復所有數據庫
|
||||
gunzip < /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_all_20260316_101802.sql.gz | \
|
||||
mysql -u momentry_backup -pmomentry_backup_pwd_2026
|
||||
|
||||
# 恢復指定數據庫
|
||||
gunzip < /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_wordpress_20260316_101802.sql.gz | \
|
||||
mysql -u momentry_backup -pmomentry_backup_pwd_2026 wordpress
|
||||
```
|
||||
|
||||
### 數據目錄複製 (完整遷移) - 離線
|
||||
|
||||
```bash
|
||||
# 1. 停止 MariaDB
|
||||
mysqladmin -u momentry_backup -pmomentry_backup_pwd_2026 shutdown
|
||||
|
||||
# 2. 複製數據目錄
|
||||
cp -r /opt/homebrew/var/mysql/* /Users/accusys/momentry/var/mariadb/
|
||||
|
||||
# 3. 設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 4. 啟動 MariaDB
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 12.1.2
|
||||
- Port: 3306
|
||||
- User: root
|
||||
- 數據目錄: /Users/accusys/momentry/var/mariadb/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,490 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry Core API 安裝指南 (本地部署)"
|
||||
date: "2026-03-23"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry-core"
|
||||
- "api-server"
|
||||
- "rust"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Momentry Core API?"
|
||||
- "API 伺服器啟動命令為何?"
|
||||
- "如何配置 API 環境變數?"
|
||||
---
|
||||
|
||||
# Momentry Core API 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | OpenCode | - |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Momentry Core API 服務,配置為本地部署,並設定開機自動啟動。
|
||||
|
||||
Momentry Core API 是一個 Rust 編寫的數位資產管理 API 服務,提供:
|
||||
- 影片搜尋 API (`/api/v1/search`)
|
||||
- n8n 整合 API (`/api/v1/n8n/search`)
|
||||
- 健康檢查端點 (`/health`)
|
||||
- 影片註冊與處理功能
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Momentry Core API | ✅ 已安裝 v0.1.0 |
|
||||
| Binary | `/Users/accusys/momentry_core_0.1/target/release/momentry` |
|
||||
| Port | 3002 |
|
||||
| 反向代理 | Caddy (`api.momentry.ddns.net`) |
|
||||
| 數據庫 | PostgreSQL (momentry) |
|
||||
| 向量庫 | Qdrant |
|
||||
| Cache | Redis |
|
||||
| launchd plist | ✅ 已建立 (/Library/LaunchDaemons/com.momentry.api.plist) |
|
||||
|
||||
---
|
||||
|
||||
## 系統需求
|
||||
|
||||
### 必要服務
|
||||
|
||||
| 服務 | 版本 | 用途 |
|
||||
|------|------|------|
|
||||
| PostgreSQL | 16+ | 主數據庫 |
|
||||
| Redis | 1.0+ | 快取與佇列 |
|
||||
| Qdrant | 1.7+ | 向量搜尋 |
|
||||
| Ollama | 最新 | LLM 與 Embedding |
|
||||
|
||||
### Rust 環境
|
||||
|
||||
```bash
|
||||
# 檢查 Rust 版本
|
||||
rustc --version
|
||||
cargo --version
|
||||
|
||||
# 如需安裝 Rust
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 編譯 Momentry Core
|
||||
|
||||
```bash
|
||||
# 進入專案目錄
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
|
||||
# 編譯 release 版本
|
||||
cargo build --release
|
||||
|
||||
# 驗證編譯結果
|
||||
ls -la target/release/momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 設定環境變數
|
||||
|
||||
建立環境變數檔案:
|
||||
|
||||
```bash
|
||||
# 建立執行目錄
|
||||
mkdir -p /Users/accusys/momentry_core_0.1/momentry_runtime/env
|
||||
|
||||
# 建立環境變數檔案
|
||||
cat > /Users/accusys/momentry_core_0.1/momentry_runtime/env/momentry.env << 'EOF'
|
||||
# Database Configuration
|
||||
DATABASE_URL=postgres://accusys@localhost:5432/momentry
|
||||
|
||||
# Redis Configuration
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
REDIS_PASSWORD=accusys
|
||||
|
||||
# API Server
|
||||
API_HOST=127.0.0.1
|
||||
API_PORT=3002
|
||||
|
||||
# Ollama (LLM)
|
||||
OLLAMA_HOST=http://localhost:11434
|
||||
|
||||
# Qdrant (Vector Database)
|
||||
QDRANT_URL=http://localhost:6333
|
||||
QDRANT_COLLECTION=momentry_chunks
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 手動啟動服務
|
||||
|
||||
```bash
|
||||
# 啟動 API 服務
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
./target/release/momentry server --port 3002
|
||||
|
||||
# 驗證服務
|
||||
curl http://localhost:3002/health
|
||||
# {"status":"ok","version":"0.1.0","uptime_ms":1234}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 設定 Caddy 反向代理
|
||||
|
||||
在 `/Users/accusys/momentry/etc/Caddyfile` 中新增:
|
||||
|
||||
```caddy
|
||||
# Momentry Core API
|
||||
api.momentry.ddns.net {
|
||||
reverse_proxy localhost:3002
|
||||
import common_log momentry_api_access
|
||||
}
|
||||
```
|
||||
|
||||
重新載入 Caddy:
|
||||
|
||||
```bash
|
||||
# 重新載入配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 驗證
|
||||
curl -sk https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 建立 launchd plist (開機自動啟動)
|
||||
|
||||
建立 plist 檔案:
|
||||
|
||||
```bash
|
||||
sudo tee /Library/LaunchDaemons/com.momentry.api.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.api</string>
|
||||
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
|
||||
<key>GroupName</key>
|
||||
<string>staff</string>
|
||||
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/momentry_core_0.1</string>
|
||||
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/Users/accusys/momentry_core_0.1/target/release/momentry</string>
|
||||
<string>server</string>
|
||||
<string>--port</string>
|
||||
<string>3002</string>
|
||||
</array>
|
||||
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>PATH</key>
|
||||
<string>/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>
|
||||
|
||||
<key>DATABASE_URL</key>
|
||||
<string>postgres://accusys@localhost:5432/momentry</string>
|
||||
|
||||
<key>REDIS_URL</key>
|
||||
<string>redis://:accusys@localhost:6379</string>
|
||||
|
||||
<key>REDIS_PASSWORD</key>
|
||||
<string>accusys</string>
|
||||
|
||||
<key>OLLAMA_HOST</key>
|
||||
<string>http://localhost:11434</string>
|
||||
|
||||
<key>QDRANT_URL</key>
|
||||
<string>http://localhost:6333</string>
|
||||
</dict>
|
||||
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry_api.log</string>
|
||||
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry_api.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
```
|
||||
|
||||
建立日誌檔案:
|
||||
|
||||
```bash
|
||||
# 建立日誌目錄(如不存在)
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌檔案
|
||||
touch /Users/accusys/momentry/log/momentry_api.log
|
||||
touch /Users/accusys/momentry/log/momentry_api.error.log
|
||||
|
||||
# 設定權限
|
||||
chown accusys:staff /Users/accusys/momentry/log/momentry_api.log
|
||||
chown accusys:staff /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
載入服務:
|
||||
|
||||
```bash
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 驗證服務
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 檢查服務狀態
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### Step 1: 停止並移除服務
|
||||
|
||||
```bash
|
||||
# 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
### Step 2: 移除 Caddy 配置
|
||||
|
||||
從 `/Users/accusys/momentry/etc/Caddyfile` 中移除 `api.momentry.ddns.net` 區塊。
|
||||
|
||||
```bash
|
||||
# 重新載入 Caddy
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### API 返回 502 Bad Gateway
|
||||
|
||||
**問題**: `api.momentry.ddns.net` 返回 502 錯誤
|
||||
|
||||
**原因**: Momentry Core API 服務未啟動
|
||||
|
||||
**解決方案**:
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 如服務未啟動,手動啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 或手動啟動測試
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
./target/release/momentry server --port 3002
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### API 返回 404 Not Found
|
||||
|
||||
**問題**: 端點返回 404
|
||||
|
||||
**原因**: Binary 過舊,缺少該端點
|
||||
|
||||
**解決方案**:
|
||||
|
||||
```bash
|
||||
# 重新編譯
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
cargo build --release
|
||||
|
||||
# 重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 服務無法啟動
|
||||
|
||||
**問題**: launchd 無法啟動服務
|
||||
|
||||
**檢查步驟**:
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
|
||||
# 檢查 plist 語法
|
||||
plutil -lint /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 檢查權限
|
||||
ls -la /Users/accusys/momentry_core_0.1/target/release/momentry
|
||||
|
||||
# 手動測試
|
||||
/Users/accusys/momentry_core_0.1/target/release/momentry server --port 3002
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| Binary | `/Users/accusys/momentry_core_0.1/target/release/momentry` | 執行檔 |
|
||||
| 環境變數 | `/Users/accusys/momentry_core_0.1/momentry_runtime/env/momentry.env` | 環境設定 |
|
||||
| launchd plist | `/Library/LaunchDaemons/com.momentry.api.plist` | 開機啟動配置 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/momentry_api.log` | 標準輸出 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/momentry_api.error.log` | 錯誤輸出 |
|
||||
| Caddy 配置 | `/Users/accusys/momentry/etc/Caddyfile` | 反向代理配置 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
### 服務管理
|
||||
|
||||
```bash
|
||||
# 啟動服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
```
|
||||
|
||||
### 健康檢查
|
||||
|
||||
```bash
|
||||
# 本地健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查
|
||||
curl http://localhost:3002/health/detailed
|
||||
|
||||
# 外部健康檢查
|
||||
curl -sk https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
### API 測試
|
||||
|
||||
```bash
|
||||
# 搜尋 API
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"test"}'
|
||||
|
||||
# n8n 搜尋 API
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"test"}'
|
||||
|
||||
# 列出影片
|
||||
curl http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 日誌查看
|
||||
|
||||
```bash
|
||||
# 查看最近的日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.log
|
||||
|
||||
# 即時監控日誌
|
||||
tail -f /Users/accusys/momentry/log/momentry_api.log
|
||||
|
||||
# 查看錯誤日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
### 重新編譯
|
||||
|
||||
```bash
|
||||
# 編譯 release 版本
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
cargo build --release
|
||||
|
||||
# 編譯後重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 端點
|
||||
|
||||
完整端點清單請參考 [API_REFERENCE.md](../REFERENCE/API_REFERENCE.md)。
|
||||
|
||||
**快速總覽**:
|
||||
|
||||
| 類別 | 端點數 | 說明 |
|
||||
|------|--------|------|
|
||||
| Health & Stats | 5 | 健康檢查與統計(公開) |
|
||||
| Core Asset | 6 | 影片註冊、查詢、進度 |
|
||||
| Processing | 7 | 探針、處理、任務 |
|
||||
| Search | 7 | 向量、BM25、混合搜索 |
|
||||
| Visual Chunk | 5 | 視覺分片搜索 |
|
||||
| Face Recognition | 7 | 人臉識別 |
|
||||
| Person Identity | 21 | 人物身份管理 |
|
||||
| Global Identities | 6 | 全局身份 |
|
||||
| Identity Binding | 6 | 身份綁定 |
|
||||
| Configuration | 1 | 緩存配置 |
|
||||
| **Total** | **71** | **可達端點** |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 0.1.0
|
||||
- 安裝日期: 2026-03-23
|
||||
- Rust 版本: 1.xx
|
||||
- 文件更新: 2026-03-23
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- `docs_v1.0/REFERENCE/SERVICES.md` - 服務總覽
|
||||
- `docs_v1.0/REFERENCE/API_REFERENCE.md` - API 參考
|
||||
- `docs_v1.0/IMPLEMENTATION/INSTALL_POSTGRESQL.md` - PostgreSQL 安裝
|
||||
- `docs_v1.0/IMPLEMENTATION/INSTALL_REDIS.md` - Redis 安裝
|
||||
- `docs_v1.0/IMPLEMENTATION/INSTALL_QDRANT.md` - Qdrant 安裝
|
||||
- `docs_v1.0/REFERENCE/PENDING_ISSUES.md` - 待解決問題
|
||||
@@ -1,412 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "MONGODB"
|
||||
title: "MongoDB 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "mongodb"
|
||||
- "nosql"
|
||||
- "database"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 MongoDB 資料庫?"
|
||||
- "MongoDB 連線資訊為何?"
|
||||
- "如何配置 MongoDB 開機自動啟動?"
|
||||
---
|
||||
|
||||
# MongoDB 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 MongoDB Community Edition,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| MongoDB (mongodb-community) | ✅ 已安裝 v8.2.6 |
|
||||
| 數據目錄 | /opt/homebrew/var/mongodb |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 MongoDB Community
|
||||
|
||||
```bash
|
||||
# 安裝 MongoDB Community
|
||||
brew tap mongodb/brew
|
||||
brew install mongodb-community
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
mongod --version
|
||||
# db version v8.x.x
|
||||
mongosh --version
|
||||
# 2.7.x
|
||||
sudo launchctl list | grep mongo
|
||||
# 確認 MongoDB 服務已載入
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 數據目錄 (已存在 - 共用)
|
||||
|
||||
數據目錄使用 homebrew 預設位置:
|
||||
- 數據目錄: `/opt/homebrew/var/mongodb`
|
||||
- 配置目錄: `/opt/homebrew/etc/mongod.conf`
|
||||
- 日誌目錄: `/Users/accusys/momentry/log`
|
||||
|
||||
**建立配置目錄和日誌文件**:
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/mongodb
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/mongodb.log
|
||||
touch /Users/accusys/momentry/log/mongodb.error.log
|
||||
|
||||
# 確認權限:
|
||||
ls -la /Users/accusys/momentry/
|
||||
chown -R accusys:staff /Users/accusys/momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 LaunchAgent 啟動 (開機自動)
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄 (開機自動需要 root 權限)
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.mongodb.plist \
|
||||
/Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mongodb.plist
|
||||
|
||||
# 驗證
|
||||
launchctl list | grep mongodb
|
||||
pgrep -a mongod
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 建立資料庫用戶
|
||||
|
||||
```bash
|
||||
mongosh --eval '
|
||||
use admin
|
||||
db.createUser({
|
||||
user: "accusys",
|
||||
pwd: "Test3200Test3200",
|
||||
roles: [
|
||||
{ role: "readWrite", db: "momentry" },
|
||||
{ role: "dbAdmin", db: "momentry" }
|
||||
]
|
||||
})
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 驗證安裝
|
||||
|
||||
```bash
|
||||
# 檢查進程
|
||||
pgrep -a mongod
|
||||
|
||||
# 檢查端口
|
||||
lsof -i :27017
|
||||
|
||||
# 測試連線
|
||||
mongosh --eval "db.adminCommand('ping')"
|
||||
|
||||
# 檢查 LaunchAgent
|
||||
launchctl list | grep mongodb
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
mongodb:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 27017
|
||||
user: "accusys"
|
||||
database: "momentry"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/` | 共用 | **不要刪除** - 多個系統共用 |
|
||||
| `/Users/accusys/momentry/var` | 共用 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/mongodb/` | 配置 | **不要刪除** - MongoDB 配置 |
|
||||
| `/Users/accusys/momentry/log` | 共用 | **不要刪除** - 日誌目錄 |
|
||||
| `~/.mongosh_history` | 專屬 | 可選刪除 - Mongo Shell 歷史 |
|
||||
|
||||
### Step 1: 停止 MongoDB
|
||||
|
||||
```bash
|
||||
# 找到 MongoDB 進程
|
||||
ps aux | grep mongod | grep -v grep
|
||||
|
||||
# 停止 MongoDB
|
||||
pkill mongod
|
||||
# 或
|
||||
kill <PID>
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep mongod | grep -v grep || echo "MongoDB 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 MongoDB
|
||||
|
||||
```bash
|
||||
# 完全卸載 (保留數據)
|
||||
brew uninstall mongodb-community
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除 MongoDB 專屬配置 (如果有)
|
||||
rm -f ~/.mongosh_history
|
||||
|
||||
# 刪除臨時文件 (可選)
|
||||
rm -rf /tmp/mongodb-*
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== MongoDB 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 MongoDB 進程
|
||||
echo "1. MongoDB 進程:"
|
||||
ps aux | grep mongod | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. 檢查 Port 27017
|
||||
echo "2. Port 27017:"
|
||||
lsof -i :27017 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. 檢查 mongod 命令
|
||||
echo "3. mongod 命令:"
|
||||
which mongod > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. 檢查 launchctl
|
||||
echo "4. launchctl 服務:"
|
||||
sudo launchctl list | grep mongo > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. 檢查 Homebrew
|
||||
echo "5. Homebrew 移除:"
|
||||
brew list mongo > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 檢查數據目錄 (應該存在)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 檢查日誌目錄 (應該存在)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== MongoDB 卸載後檢查 ===
|
||||
1. MongoDB 進程:
|
||||
✓ 已停止
|
||||
2. Port 27017:
|
||||
✓ 已釋放
|
||||
3. mongod 命令:
|
||||
✓ 已移除
|
||||
4. launchctl 服務:
|
||||
✓ 已移除
|
||||
5. Homebrew 移除:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留
|
||||
7. 日誌目錄:
|
||||
✓ 保留
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查 Process 是否運行
|
||||
ps aux | grep mongo | grep -v grep
|
||||
|
||||
# 2. 檢查 Port 27017
|
||||
lsof -i :27017
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
mongosh --eval "db.adminCommand('ping')"
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --eval "db.adminCommand('ping')"
|
||||
|
||||
# 5. 查看所有資料庫
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --quiet --eval "db.adminCommand({listDatabases:1}).databases"
|
||||
|
||||
# 6. 查看用戶
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --quiet --eval "db.getUser('accusys')"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/mongodb.log
|
||||
tail -20 /Users/accusys/momentry/log/mongodb.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 管理命令
|
||||
|
||||
### 啟動/停止
|
||||
|
||||
```bash
|
||||
# 使用 LaunchAgent (開機自動 - LaunchDaemons 目錄)
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mongodb.plist # 啟動
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mongodb.plist # 停止
|
||||
|
||||
# 手動啟動 (僅除錯用)
|
||||
nohup /opt/homebrew/bin/mongod \
|
||||
--dbpath /Users/accusys/momentry/var \
|
||||
--logpath /Users/accusys/momentry/log/mongodb.log \
|
||||
--port 27017 \
|
||||
--bind_ip 0.0.0.0 \
|
||||
> /Users/accusys/momentry/log/mongodb.log 2>&1 &
|
||||
|
||||
# 強制停止
|
||||
pkill mongod
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線字串
|
||||
|
||||
```bash
|
||||
# 無認證 (本地)
|
||||
mongodb://localhost:27017
|
||||
|
||||
# 有認證 (admin 資料庫)
|
||||
mongodb://accusys:Test3200Test3200@localhost:27017/admin
|
||||
|
||||
# 有認證 (momentry 資料庫)
|
||||
mongodb://accusys:Test3200Test3200@localhost:27017/momentry?authSource=admin
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
MONGODB_URL=mongodb://accusys:Test3200Test3200@localhost:27017/admin
|
||||
MONGODB_DATABASE=momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- MongoDB 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 建議設定防火牆規則限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MongoDB 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/mongodb.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 27017
|
||||
lsof -i :27017
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 數據目錄 | `/Users/accusys/momentry/var` | **共用 - 不要刪除** |
|
||||
| 日誌目錄 | `/Users/accusys/momentry/log` | **共用 - 不要刪除** |
|
||||
| mongod | `/opt/homebrew/bin/mongod` | 安裝後存在 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongodb-community/` | 卸載時刪除 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongodb-database-tools/` | 卸載時刪除 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongosh/` | 卸載時刪除 |
|
||||
| 配置檔 | `/opt/homebrew/etc/mongod.conf` | 卸載時刪除 |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 用戶: accusys
|
||||
- 密碼: Test3200Test3200
|
||||
- 數據目錄: /Users/accusys/momentry/var (共用 - 不要刪除!)
|
||||
- 日誌目錄: /Users/accusys/momentry/log (共用 - 不要刪除!)
|
||||
@@ -1,509 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n 安裝指南 (本地部署)"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "n8n"
|
||||
- "workflow"
|
||||
- "automation"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 n8n 自動化平台?"
|
||||
- "n8n Webhook 配置方式為何?"
|
||||
- "如何匯出匯入 n8n Workflow?"
|
||||
---
|
||||
|
||||
# n8n 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 n8n 工作流自動化平台,配置為本地部署,使用 Queue 模式。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| n8n | ✅ 已安裝 v2.12.3 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/n8n/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Main Plist | /Library/LaunchDaemons/com.momentry.n8n.main.plist |
|
||||
| Worker Plist | /Library/LaunchDaemons/com.momentry.n8n.worker.plist |
|
||||
| 數據庫 | PostgreSQL (n8n) |
|
||||
| 隊列 | Redis |
|
||||
| Launchd 狀態 | ✅ Main + Worker 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
### 重要更新 (2026-03-24)
|
||||
|
||||
1. **n8n Main + Worker**: 兩個服務都使用自定義 plist
|
||||
2. **Runner 禁用**: 為避免端口衝突,Main 服務設定 `N8N_RUNNERS_ENABLED=false`
|
||||
3. **Worker 端口**: Worker 使用 5681, 5682, 5690, 5691 端口
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 n8n (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 n8n
|
||||
brew install n8n
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
n8n --version
|
||||
# 2.12.3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/n8n
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/n8n.main.log
|
||||
touch /Users/accusys/momentry/log/n8n.main.error.log
|
||||
touch /Users/accusys/momentry/log/n8n.worker.log
|
||||
touch /Users/accusys/momentry/log/n8n.worker.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 數據遷移 (如果從舊位置遷移)
|
||||
|
||||
```bash
|
||||
# 停止舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.worker.plist
|
||||
|
||||
# 複製數據
|
||||
cp -r /Users/accusys/.n8n/* /Users/accusys/momentry/var/n8n/
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.n8n.main.plist /Library/LaunchDaemons/
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.n8n.worker.plist /Library/LaunchDaemons/
|
||||
|
||||
# 移除舊 plist (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.main.plist 2>/dev/null
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.worker.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.n8n.main.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.n8n.worker.plist 2>/dev/null
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "n8n"
|
||||
type: "http"
|
||||
port: 5678
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:5678/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_n8n() {
|
||||
local start=$(date +%s%N)
|
||||
if curl -s http://localhost:5678/ > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} n8n (5678) - ${ms}ms"
|
||||
record_service "n8n" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} n8n (5678) - Down"
|
||||
record_service "n8n" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
### n8n Workflow 監控
|
||||
|
||||
n8n 有專門的工作流監控腳本,請參考 `monitor/workflow/n8n_workflow_monitor.sh`。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/n8n/` | 數據 | **不要刪除** - n8n 數據 |
|
||||
| `/Users/accusys/momentry/etc/n8n/` | 配置 | **不要刪除** - n8n 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - n8n 日誌 |
|
||||
| `/opt/homebrew/lib/node_modules/n8n/` | 安裝 | **刪除** - n8n 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 n8n
|
||||
|
||||
```bash
|
||||
# 停止 n8n 服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep n8n | grep -v grep || echo "n8n 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 n8n
|
||||
|
||||
```bash
|
||||
# 卸載 n8n
|
||||
brew uninstall n8n
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/n8n-*.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
# PostgreSQL n8n 數據庫 (如需保留)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== n8n 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 n8n 進程
|
||||
echo "1. n8n Main 進程:"
|
||||
ps aux | grep "n8n.*start" | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
echo "2. n8n Worker 進程:"
|
||||
ps aux | grep "n8n.*worker" | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 8085
|
||||
echo "3. Port 8085:"
|
||||
lsof -i :8085 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. Port 5679 (Worker)
|
||||
echo "4. Port 5679 (Worker):"
|
||||
lsof -i :5679 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 4. n8n 命令
|
||||
echo "5. n8n 命令:"
|
||||
which n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. brew 安裝
|
||||
echo "6. brew 安裝:"
|
||||
brew list n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. launchctl 服務
|
||||
echo "7. launchctl 服務:"
|
||||
sudo launchctl list | grep n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份步驟
|
||||
|
||||
### 備份 n8n 數據
|
||||
|
||||
```bash
|
||||
# 建立備份目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n_backup
|
||||
|
||||
# 1. 備份 PostgreSQL 數據庫
|
||||
PGPASSWORD=accusys pg_dump -U accusys -d n8n > /Users/accusys/momentry/var/n8n_backup/n8n_database_$(date +%Y%m%d).sql
|
||||
|
||||
# 2. 備份用戶數據夾
|
||||
cp -r /Users/accusys/momentry/var/n8n /Users/accusys/momentry/var/n8n_backup/
|
||||
|
||||
# 3. 壓縮備份
|
||||
cd /Users/accusys/momentry/var && tar -czvf n8n_backup_$(date +%Y%m%d).tar.gz n8n_backup/
|
||||
|
||||
# 4. 清理臨時備份
|
||||
rm -rf /Users/accusys/momentry/var/n8n_backup
|
||||
```
|
||||
|
||||
### 還原數據
|
||||
|
||||
```bash
|
||||
# 1. 停止 n8n
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 2. 還原 PostgreSQL 數據庫
|
||||
PGPASSWORD=accusys psql -U accusys -d n8n < /Users/accusys/momentry/var/n8n_backup/n8n_database_20260314.sql
|
||||
|
||||
# 3. 還原用戶數據夾
|
||||
rm -rf /Users/accusys/momentry/var/n8n
|
||||
cp -r /Users/accusys/momentry/var/n8n_backup/n8n /Users/accusys/momentry/var/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 4. 啟動 n8n
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep n8n | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :5678
|
||||
lsof -i :5679
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:5678/
|
||||
|
||||
# 4. 查看版本
|
||||
n8n --version
|
||||
|
||||
# 5. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/n8n-main.log
|
||||
tail -20 /Users/accusys/momentry/log/n8n-worker.log
|
||||
|
||||
# 6. 查看錯誤日誌
|
||||
tail -20 /Users/accusys/momentry/log/n8n-main.error.log
|
||||
tail -20 /Users/accusys/momentry/log/n8n-worker.error.log
|
||||
|
||||
# 7. 檢查 launchctl 狀態
|
||||
sudo launchctl list | grep n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| URL | http://localhost:5678 |
|
||||
| Domain | n8n.momentry.ddns.net |
|
||||
| 數據庫 | PostgreSQL (n8n) |
|
||||
| 隊列 | Redis |
|
||||
| Encryption Key | Test3200Test3200Test3200 |
|
||||
|
||||
### Queue 模式端口
|
||||
|
||||
| 服務 | Port |
|
||||
|------|------|
|
||||
| Main | 5678 |
|
||||
| Task Broker (Worker 連接) | 5679 |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
N8N_URL=http://localhost:5678
|
||||
N8N_USER_FOLDER=/Users/accusys/momentry/var/n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### n8n 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/n8n-main.log
|
||||
tail -f /Users/accusys/momentry/log/n8n-worker.log
|
||||
|
||||
# 檢查環境變數
|
||||
launchctl list | grep n8n
|
||||
|
||||
# 檢查數據庫連線
|
||||
PGPASSWORD=accusys psql -U accusys -d n8n -c "SELECT 1"
|
||||
|
||||
# 檢查 Redis 連線
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port
|
||||
lsof -i :8085
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 數據庫連線失敗
|
||||
|
||||
```bash
|
||||
# 檢查 PostgreSQL
|
||||
pg_isready -h 127.0.0.1 -p 5432 -U n8n
|
||||
|
||||
# 測試連線
|
||||
PGPASSWORD=accusys psql -h 127.0.0.1 -U n8n -d n8n -c "SELECT version();"
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/lib/node_modules/n8n/` | n8n 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/bin/n8n` | n8n 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/n8n/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/n8n/` | 配置儲存 |
|
||||
| Main 日誌 | `/Users/accusys/momentry/log/n8n.main.log` | 主服務日誌 |
|
||||
| Main 錯誤日誌 | `/Users/accusys/momentry/log/n8n.main.error.log` | 主服務錯誤日誌 |
|
||||
| Worker 日誌 | `/Users/accusys/momentry/log/n8n.worker.log` | Worker 日誌 |
|
||||
| Worker 錯誤日誌 | `/Users/accusys/momentry/log/n8n.worker.error.log` | Worker 錯誤日誌 |
|
||||
| Main Plist | `/Library/LaunchDaemons/com.momentry.n8n.main.plist` | 主服務開機啟動 |
|
||||
| Worker Plist | `/Library/LaunchDaemons/com.momentry.n8n.worker.plist` | Worker 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/n8n_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 數據庫資訊
|
||||
|
||||
n8n 使用 PostgreSQL 作為數據庫:
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Database | n8n |
|
||||
| User | n8n |
|
||||
| Host | 127.0.0.1:5432 |
|
||||
| Password | accusys |
|
||||
|
||||
### Redis 隊列資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | 127.0.0.1:6379 |
|
||||
| Password | accusys |
|
||||
| Mode | Queue (Bull) |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 啟動 n8n Main
|
||||
n8n start
|
||||
|
||||
# 啟動 n8n Worker
|
||||
n8n worker
|
||||
|
||||
# 查看版本
|
||||
n8n --version
|
||||
|
||||
# 備份數據
|
||||
PGPASSWORD=accusys pg_dump -U accusys -d n8n > n8n_backup.sql
|
||||
|
||||
# 重新載入服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 2.3.5
|
||||
- Main Port: 5678
|
||||
- Task Broker (Worker): 5679
|
||||
- 數據目錄: /Users/accusys/momentry/var/n8n/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
- 數據庫: PostgreSQL n8n
|
||||
- 隊列: Redis
|
||||
@@ -1,395 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "OLLAMA"
|
||||
title: "Ollama 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "ollama"
|
||||
- "llm"
|
||||
- "ai-inference"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Ollama 本地 LLM 推理引擎?"
|
||||
- "如何下載 Ollama 模型?"
|
||||
- "Ollama API 端點為何?"
|
||||
---
|
||||
|
||||
# Ollama 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Ollama,配置為本地部署,用於運行大型語言模型 (LLM)。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Ollama | ✅ 已安裝 v0.13.5 |
|
||||
| Port | 11434 |
|
||||
| Models 目錄 | /Users/accusys/momentry/var/ollama/models |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.ollama.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Ollama (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Ollama
|
||||
brew install ollama
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
ollama --version
|
||||
# ollama version is 0.13.5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/ollama
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/ollama
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/ollama.log
|
||||
touch /Users/accusys/momentry/log/ollama.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/ollama
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/ollama
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.ollama.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "ollama"
|
||||
type: "http"
|
||||
port: 11434
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:11434/api/tags"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_ollama() {
|
||||
local start=$(date +%s%N)
|
||||
if curl -s http://localhost:11434/api/tags > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} Ollama (11434) - ${ms}ms"
|
||||
record_service "ollama" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} Ollama (11434) - Down"
|
||||
record_service "ollama" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/ollama/` | 數據 | **不要刪除** - Ollama 數據 |
|
||||
| `/Users/accusys/momentry/etc/ollama/` | 配置 | **不要刪除** - Ollama 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/ollama/` | 安裝 | **刪除** - Ollama 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Ollama
|
||||
|
||||
```bash
|
||||
# 找到 Ollama 進程
|
||||
ps aux | grep ollama | grep -v grep
|
||||
|
||||
# 停止 Ollama
|
||||
pkill ollama
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep ollama | grep -v grep || echo "Ollama 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Ollama
|
||||
|
||||
```bash
|
||||
# 卸載 Ollama
|
||||
brew uninstall ollama
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/ollama.log
|
||||
rm -f /Users/accusys/momentry/log/ollama.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下目錄**:
|
||||
```bash
|
||||
# 這些是重要的,不要刪除!
|
||||
# /Users/accusys/.ollama/models
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Ollama 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Ollama 進程
|
||||
echo "1. Ollama 進程:"
|
||||
ps aux | grep ollama | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 11434
|
||||
echo "2. Port 11434:"
|
||||
lsof -i :11434 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. ollama 命令
|
||||
echo "3. ollama 命令:"
|
||||
which ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 模型目錄 (應該保留)
|
||||
echo "6. 模型目錄:"
|
||||
[ -d "/Users/accusys/.ollama/models" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep ollama | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :11434
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:11434/
|
||||
|
||||
# 4. 查看版本
|
||||
ollama --version
|
||||
|
||||
# 5. 查看已安裝的模型
|
||||
ollama list
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/ollama.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 11434 |
|
||||
| Models | /Users/accusys/.ollama/models |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
OLLAMA_HOST=0.0.0.0:11434
|
||||
OLLAMA_MODELS=/Users/accusys/.ollama/models
|
||||
OLLAMA_FLASH_ATTENTION=1
|
||||
OLLAMA_KV_CACHE_TYPE=q8_0
|
||||
```
|
||||
|
||||
### 環境變數說明
|
||||
|
||||
| 變數 | 說明 | 預設值 |
|
||||
|------|------|---------|
|
||||
| OLLAMA_HOST | 綁定主機和端口 | 127.0.0.1:11434 |
|
||||
| OLLAMA_MODELS | 模型儲存目錄 | ~/.ollama/models |
|
||||
| OLLAMA_FLASH_ATTENTION | 啟用 Flash Attention | 0 |
|
||||
| OLLAMA_KV_CACHE_TYPE | KV 緩存類型 | f16 |
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Ollama 綁定到 `0.0.0.0:11434` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請注意安全風險
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Ollama 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/ollama.log
|
||||
|
||||
# 檢查模型目錄權限
|
||||
ls -la /Users/accusys/.ollama/models/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/.ollama
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 11434
|
||||
lsof -i :11434
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.ollama.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/ollama/` | Ollama 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/ollama/bin/ollama` | Ollama 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/ollama/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/ollama/` | 配置儲存 |
|
||||
| 模型目錄 | `/Users/accusys/.ollama/models/` | AI 模型儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/ollama.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/ollama.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.ollama.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/ollama_backup/environment.txt` | 環境變數備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 查看版本
|
||||
ollama --version
|
||||
|
||||
# 查看已安裝的模型
|
||||
ollama list
|
||||
|
||||
# 拉取模型
|
||||
ollama pull mistral
|
||||
ollama pull llama2
|
||||
|
||||
# 運行模型
|
||||
ollama run mistral
|
||||
|
||||
# 刪除模型
|
||||
ollama remove mistral
|
||||
|
||||
# 查看模型資訊
|
||||
ollama show mistral
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 已安裝的模型
|
||||
|
||||
查看已安裝的模型:
|
||||
```bash
|
||||
ollama list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 0.13.5
|
||||
- Port: 11434
|
||||
- Models: /Users/accusys/.ollama/models/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,415 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "PHP"
|
||||
title: "PHP 安裝指南 (本地部署)"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "php"
|
||||
- "web-server"
|
||||
- "wordpress"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 PHP 環境?"
|
||||
- "PHP 配置優化建議為何?"
|
||||
- "如何配置 PHP-FPM 與 Nginx/Caddy?"
|
||||
---
|
||||
|
||||
# PHP 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 PHP 及 PHP-FPM,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| PHP | ✅ 已安裝 v8.5.2 |
|
||||
| PHP-FPM | ✅ 執行中 |
|
||||
| 配置目錄 | /Users/accusys/momentry/etc/php/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.php.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 PHP (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 PHP
|
||||
brew install php
|
||||
|
||||
# 安裝 PHP-FPM (通常包含在 php 中)
|
||||
brew install php --fpm
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
php --version
|
||||
# PHP 8.5.2 (cli)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/php
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/php.log
|
||||
touch /Users/accusys/momentry/log/php.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/php
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/php/php-fpm.conf`:
|
||||
|
||||
```ini
|
||||
[global]
|
||||
pid = /Users/accusys/momentry/var/php-fpm.pid
|
||||
error_log = /Users/accusys/momentry/log/php.error.log
|
||||
log_level = notice
|
||||
|
||||
[www]
|
||||
user = accusys
|
||||
group = staff
|
||||
listen = 127.0.0.1:9000
|
||||
listen.owner = accusys
|
||||
listen.group = staff
|
||||
pm = dynamic
|
||||
pm.max_children = 5
|
||||
pm.start_servers = 2
|
||||
pm.min_spare_servers = 1
|
||||
pm.max_spare_servers = 3
|
||||
```
|
||||
|
||||
複製 php.ini:
|
||||
```bash
|
||||
cp /opt/homebrew/etc/php/8.5/php.ini /Users/accusys/momentry/etc/php/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.php.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "php-fpm"
|
||||
type: "tcp"
|
||||
port: 9000
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/etc/php/` | 配置 | **不要刪除** - PHP 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/php/` | 安裝 | **刪除** - PHP 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 PHP-FPM
|
||||
|
||||
```bash
|
||||
# 找到 PHP-FPM 進程
|
||||
ps aux | grep php-fpm | grep -v grep
|
||||
|
||||
# 停止 PHP-FPM
|
||||
pkill php-fpm
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep php-fpm | grep -v grep || echo "PHP-FPM 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 PHP
|
||||
|
||||
```bash
|
||||
# 卸載 PHP
|
||||
brew uninstall php
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.php.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/php
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/php.log
|
||||
rm -f /Users/accusys/momentry/log/php.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== PHP 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 PHP-FPM 進程
|
||||
echo "1. PHP-FPM 進程:"
|
||||
ps aux | grep php-fpm | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 9000
|
||||
echo "2. Port 9000:"
|
||||
lsof -i :9000 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. php 命令
|
||||
echo "3. php 命令:"
|
||||
which php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 配置目錄 (可選刪除)
|
||||
echo "6. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc/php" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查 PHP 版本
|
||||
php --version
|
||||
|
||||
# 2. 檢查 PHP-FPM 進程
|
||||
ps aux | grep php-fpm | grep -v grep
|
||||
|
||||
# 3. 檢查 Port
|
||||
lsof -i :9000
|
||||
|
||||
# 4. 測試 PHP
|
||||
php -r "echo 'PHP OK' . PHP_EOL;"
|
||||
|
||||
# 5. 查看 PHP 模組
|
||||
php -m
|
||||
|
||||
# 6. 查看 PHP 配置
|
||||
php -i | grep "Loaded Configuration File"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/php.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| PHP-FPM Port | 9000 |
|
||||
| PHP Version | 8.5.2 |
|
||||
| Config | /Users/accusys/momentry/etc/php/php-fpm.conf |
|
||||
| php.ini | /Users/accusys/momentry/etc/php/php.ini |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
PHP_INI_SCAN_DIR=/Users/accusys/momentry/etc/php/conf.d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### PHP-FPM 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/php.error.log
|
||||
|
||||
# 檢查配置語法
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/php-fpm.conf
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/etc/php/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/etc/php
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 9000
|
||||
lsof -i :9000
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.php.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/php/` | PHP 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/bin/php` | PHP 執行檔 |
|
||||
| PHP-FPM | `/opt/homebrew/opt/php/sbin/php-fpm` | PHP-FPM 執行檔 |
|
||||
| php.ini | `/Users/accusys/momentry/etc/php/8.5/php.ini` | PHP 配置 |
|
||||
| PHP-FPM 配置 | `/Users/accusys/momentry/etc/php/8.5/php-fpm.conf` | PHP-FPM 主配置 |
|
||||
| PHP-FPM pool | `/Users/accusys/momentry/etc/php/8.5/php-fpm.d/` | Pool 配置 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/php.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/opt/homebrew/var/log/php-fpm.log` | PHP-FPM 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.php.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/backup/daily/php/` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 測試 PHP-FPM 配置
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/php-fpm.conf
|
||||
|
||||
# 查看 PHP 模組
|
||||
php -m
|
||||
|
||||
# 查看已載入的配置
|
||||
php -i
|
||||
|
||||
# 測試 PHP 腳本
|
||||
php -r "echo 'Hello World' . PHP_EOL;"
|
||||
|
||||
# 查看 PHP-FPM 狀態
|
||||
curl http://127.0.0.1:9000/status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/daily/php"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 備份配置 (注意:PHP-FPM 實際使用 /Users/accusys/momentry/etc/php/8.5/ 配置)
|
||||
tar -czf "$BACKUP_DIR/php_cfg_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/etc/php/8.5/php.ini \
|
||||
/Users/accusys/momentry/etc/php/8.5/php-fpm.conf \
|
||||
/Users/accusys/momentry/etc/php/8.5/php-fpm.d/
|
||||
|
||||
# 驗證
|
||||
sha256sum "$BACKUP_DIR/php_cfg_${TIMESTAMP}.tar.gz" > "$BACKUP_DIR/php_${TIMESTAMP}.sha256"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 解壓配置
|
||||
tar -xzf /Users/accusys/momentry/backup/daily/php/php_cfg_20260316_102727.tar.gz -C /
|
||||
|
||||
# 測試配置
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/8.5/php-fpm.conf
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- PHP Version: 8.5.2
|
||||
- PHP-FPM Port: 9000
|
||||
- 配置目錄: /Users/accusys/momentry/etc/php/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,417 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "POSTGRESQL"
|
||||
title: "PostgreSQL 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "postgresql"
|
||||
- "database"
|
||||
- "macos"
|
||||
- "sql"
|
||||
ai_query_hints:
|
||||
- "如何安裝 PostgreSQL 資料庫?"
|
||||
- "PostgreSQL 數據目錄路徑在哪裡?"
|
||||
- "如何卸載 PostgreSQL 並保留數據?"
|
||||
---
|
||||
|
||||
# PostgreSQL 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 PostgreSQL,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| PostgreSQL | ✅ 已安裝 v18.1 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/postgresql |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.postgresql.plist |
|
||||
| Launchd 狀態 | ✅ 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
### 重要更新 (2026-03-24)
|
||||
|
||||
1. **資料目錄已變更**: 從 `/opt/homebrew/var/postgresql@18` 遷移到 `/Users/accusys/momentry/var/postgresql`
|
||||
2. **統一管理**: 所有 Momentry 服務現在都使用 `/Library/LaunchDaemons/` 下的自定義 plist
|
||||
3. **避免衝突**: 刪除了 homebrew plist,避免 reboot 後使用舊資料目錄
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 PostgreSQL (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 PostgreSQL
|
||||
brew install postgresql@18
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
postgres --version
|
||||
# postgres (PostgreSQL) 18.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/postgresql
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/postgresql.log
|
||||
touch /Users/accusys/momentry/log/postgresql.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/postgresql
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/postgresql
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
**注意**: 如果需要從舊數據遷移,需要先初始化新目錄:
|
||||
```bash
|
||||
# 初始化新數據目錄 (會創建默認數據庫)
|
||||
initdb -D /Users/accusys/momentry/var/postgresql -U accusys
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.postgresql.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
postgresql:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 5432
|
||||
user: "accusys"
|
||||
database: "momentry"
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/database/postgres_monitor.sh` 中已包含 PostgreSQL 監控。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/postgresql/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/postgresql/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/postgresql@18/` | 安裝 | **刪除** - PostgreSQL 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 找到 PostgreSQL 進程
|
||||
ps aux | grep postgres | grep -v grep
|
||||
|
||||
# 停止 PostgreSQL
|
||||
pg_ctl -D /opt/homebrew/var/postgresql@18 stop
|
||||
# 或
|
||||
pkill -f postgresql
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep postgres | grep -v grep || echo "PostgreSQL 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 卸載 PostgreSQL
|
||||
brew uninstall postgresql@18
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/postgresql.log
|
||||
rm -f /Users/accusys/momentry/log/postgresql.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== PostgreSQL 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 PostgreSQL 進程
|
||||
echo "1. PostgreSQL 進程:"
|
||||
ps aux | grep postgres | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 5432
|
||||
echo "2. Port 5432:"
|
||||
lsof -i :5432 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. postgres 命令
|
||||
echo "3. postgres 命令:"
|
||||
which postgres > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list postgresql@18 > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep postgresql > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/postgresql" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== PostgreSQL 卸載後檢查 ===
|
||||
1. PostgreSQL 進程:
|
||||
✓ 已停止
|
||||
2. Port 5432:
|
||||
✓ 已釋放
|
||||
3. postgres 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep postgres | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :5432
|
||||
|
||||
# 3. 測試連線
|
||||
psql -U accusys -l
|
||||
|
||||
# 4. 查看所有數據庫
|
||||
psql -U accusys -c "\l"
|
||||
|
||||
# 5. 查看連接
|
||||
psql -U accusys -c "\conninfo"
|
||||
|
||||
# 6. 查看表
|
||||
psql -U accusys -d momentry -c "\dt"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/postgresql.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 5432 |
|
||||
| User | accusys |
|
||||
| Database | momentry, video_register, gitea, n8n |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
POSTGRES_URL=postgresql://accusys@localhost:5432
|
||||
POSTGRES_DB=momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- PostgreSQL 綁定到所有網路介面 (0.0.0.0)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請設定 `pg_hba.conf` 限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### PostgreSQL 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/postgresql.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/postgresql/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/postgresql
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 5432
|
||||
lsof -i :5432
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.postgresql.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/postgresql@18/` | PostgreSQL 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/postgresql@18/bin/postgres` | PostgreSQL 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/postgresql/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/postgresql.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/postgresql.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.postgresql.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/momentry_db_backup_latest.sql` | momentry 數據庫備份 |
|
||||
| 備份 | `/Users/accusys/momentry/var/video_register_db_backup_latest.sql` | video_register 數據庫備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份 (pg_dump)
|
||||
|
||||
```bash
|
||||
# 備份 momentry 數據庫
|
||||
pg_dump -U accusys momentry > /Users/accusys/momentry/var/momentry_db_backup_latest.sql
|
||||
|
||||
# 備份 video_register 數據庫
|
||||
pg_dump -U accusys video_register > /Users/accusys/momentry/var/video_register_db_backup_latest.sql
|
||||
```
|
||||
|
||||
### 恢復 (psql)
|
||||
|
||||
```bash
|
||||
# 恢復 momentry 數據庫
|
||||
psql -U accusys -d momentry < /Users/accusys/momentry/var/momentry_db_backup_latest.sql
|
||||
|
||||
# 恢復 video_register 數據庫
|
||||
psql -U accusys -d video_register < /Users/accusys/momentry/var/video_register_db_backup_latest.sql
|
||||
```
|
||||
|
||||
### 數據目錄複製 (完整遷移)
|
||||
|
||||
```bash
|
||||
# 1. 停止 PostgreSQL
|
||||
pg_ctl -D /Users/accusys/momentry/var/postgresql stop
|
||||
|
||||
# 2. 複製數據目錄
|
||||
cp -r /opt/homebrew/var/postgresql@18/* /Users/accusys/momentry/var/postgresql/
|
||||
|
||||
# 3. 設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 4. 啟動 PostgreSQL
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 18.1
|
||||
- Port: 5432
|
||||
- User: accusys
|
||||
- 數據目錄: /Users/accusys/momentry/var/postgresql/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,492 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "QDRANT"
|
||||
title: "Qdrant 安裝指南 (本地部署)"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "qdrant"
|
||||
- "vector-database"
|
||||
- "ai-search"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Qdrant 向量資料庫?"
|
||||
- "Qdrant 連線資訊為何?"
|
||||
- "如何配置 Qdrant Collection?"
|
||||
---
|
||||
|
||||
# Qdrant 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Qdrant Vector Database,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Qdrant | ✅ 已安裝 v1.17.0 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/qdrant/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.qdrant.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Qdrant (使用 cargo)
|
||||
|
||||
```bash
|
||||
# 安裝 Qdrant 從 GitHub
|
||||
cargo install --git https://github.com/qdrant/qdrant.git --locked
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
qdrant --version
|
||||
# qdrant 1.17.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 驗證 Qdrant 安裝
|
||||
|
||||
```bash
|
||||
# 驗證 Qdrant 安裝
|
||||
~/.cargo/bin/qdrant --version
|
||||
# qdrant 1.17.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/qdrant
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/qdrant.log
|
||||
touch /Users/accusys/momentry/log/qdrant.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/qdrant
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/qdrant
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.qdrant.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
qdrant:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 6333
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/database/qdrant_monitor.sh` 中已包含 Qdrant 監控。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/qdrant/` | 數據 | **不要刪除** - Qdrant 數據 |
|
||||
| `/Users/accusys/momentry/etc/qdrant/` | 配置 | **不要刪除** - Qdrant 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `~/.cargo/bin/qdrant` | 安裝 | **刪除** - Qdrant 執行檔 |
|
||||
|
||||
### Step 1: 停止 Qdrant
|
||||
|
||||
```bash
|
||||
# 找到 Qdrant 進程
|
||||
ps aux | grep qdrant | grep -v grep
|
||||
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
# 或
|
||||
kill <PID>
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep qdrant | grep -v grep || echo "Qdrant 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Qdrant (cargo)
|
||||
|
||||
```bash
|
||||
# 移除 cargo 安裝的 Qdrant
|
||||
cargo uninstall qdrant
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/qdrant
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/qdrant.log
|
||||
rm -f /opt/homebrew/var/log/qdrant.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Qdrant 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Qdrant 進程
|
||||
echo "1. Qdrant 進程:"
|
||||
ps aux | grep qdrant | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 6333
|
||||
echo "2. Port 6333:"
|
||||
lsof -i :6333 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. Port 6334
|
||||
echo "3. Port 6334:"
|
||||
lsof -i :6334 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 4. qdrant 命令
|
||||
echo "4. qdrant 命令:"
|
||||
which qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. cargo 安裝
|
||||
echo "5. cargo 安裝:"
|
||||
cargo install --list | grep qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. launchctl 服務
|
||||
echo "6. launchctl 服務:"
|
||||
sudo launchctl list | grep qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 7. 數據目錄 (可選刪除)
|
||||
echo "7. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/qdrant" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 8. 日誌目錄 (可選刪除)
|
||||
echo "8. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Qdrant 卸載後檢查 ===
|
||||
1. Qdrant 進程:
|
||||
✓ 已停止
|
||||
2. Port 6333:
|
||||
✓ 已釋放
|
||||
3. Port 6334:
|
||||
✓ 已釋放
|
||||
4. qdrant 命令:
|
||||
✓ 已移除
|
||||
5. cargo 安裝:
|
||||
✓ 已移除
|
||||
6. launchctl 服務:
|
||||
✓ 已移除
|
||||
7. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
8. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep qdrant | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :6333
|
||||
lsof -i :6334
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
curl http://localhost:6333/collections
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
curl -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
|
||||
# 5. 查看所有 collections
|
||||
curl -s -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/qdrant.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| REST API | http://localhost:6333 |
|
||||
| gRPC | localhost:6334 |
|
||||
| API Key | Test3200Test3200Test3200 |
|
||||
| Qdrant UI | http://localhost:6333/dashboard |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
QDRANT_URL=http://localhost:6333
|
||||
QDRANT_API_KEY=Test3200Test3200Test3200
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Qdrant 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 建議設定防火牆規則限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Qdrant 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/qdrant.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/qdrant/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/qdrant
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 6333
|
||||
lsof -i :6333
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.qdrant.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/.cargo/bin/qdrant` | 二進制 | cargo 安裝位置 (直接使用) |
|
||||
| `/opt/homebrew/bin/qdrant` | 符號連結 | ~~已棄用~~ - 不再需要 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/qdrant/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/qdrant.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/opt/homebrew/var/log/qdrant.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.qdrant.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/qdrant_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
Qdrant 提供兩種備份方式:Snapshots (推薦) 和手動複製。
|
||||
|
||||
#### 方式一:使用 Snapshots API (推薦)
|
||||
|
||||
```bash
|
||||
# 創建備份目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant_backup
|
||||
|
||||
# 獲取所有 collections
|
||||
curl -s -H "api-key: Test3200Test3200Test3200" \
|
||||
http://localhost:6333/collections | jq -r '.result[].name'
|
||||
|
||||
# 為每個 collection 創建 snapshot
|
||||
# 假設 collection 名稱為 "chunks"
|
||||
curl -X POST -H "api-key: Test3200Test3200Test3200" \
|
||||
http://localhost:6333/collections/chunks/snapshots \
|
||||
-o /Users/accusys/momentry/var/qdrant_backup/chunks_snapshot_$(date +%Y%m%d).tar.gz
|
||||
```
|
||||
|
||||
#### 方式二:手動複製數據目錄 (停機備份)
|
||||
|
||||
```bash
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
|
||||
# 等待停止
|
||||
sleep 2
|
||||
|
||||
# 複製數據目錄
|
||||
TIMESTAMP=$(date +%Y%m%d)
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant_backup
|
||||
tar -czf /Users/accusys/momentry/var/qdrant_backup/qdrant_data_${TIMESTAMP}.tar.gz \
|
||||
-C /Users/accusys/momentry/var qdrant/
|
||||
|
||||
# 啟動 Qdrant
|
||||
launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
#### 自動備份腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# backup_qdrant.sh
|
||||
set -e
|
||||
|
||||
QDRANT_HOST="localhost"
|
||||
QDRANT_PORT="6333"
|
||||
QDRANT_API_KEY="Test3200Test3200Test3200"
|
||||
BACKUP_DIR="/Users/accusys/momentry/var/qdrant_backup"
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
echo "開始 Qdrant 備份..."
|
||||
|
||||
# 獲取所有 collections
|
||||
COLLECTIONS=$(curl -s -H "api-key: $QDRANT_API_KEY" \
|
||||
http://${QDRANT_HOST}:${QDRANT_PORT}/collections | \
|
||||
jq -r '.result[].name')
|
||||
|
||||
if [ -z "$COLLECTIONS" ]; then
|
||||
echo "警告: 沒有找到任何 collections"
|
||||
else
|
||||
for COLLECTION in $COLLECTIONS; do
|
||||
echo "備份 collection: $COLLECTION"
|
||||
curl -X POST -H "api-key: $QDRANT_API_KEY" \
|
||||
"http://${QDRANT_HOST}:${QDRANT_PORT}/collections/${COLLECTION}/snapshots" \
|
||||
-o "${BACKUP_DIR}/${COLLECTION}_${TIMESTAMP}.tar.gz" 2>/dev/null || \
|
||||
echo "警告: $COLLECTION 備份失敗"
|
||||
done
|
||||
fi
|
||||
|
||||
# 壓縮所有 snapshot
|
||||
cd "$BACKUP_DIR"
|
||||
tar -czf qdrant_snapshots_${TIMESTAMP}.tar.gz *.tar.gz 2>/dev/null || true
|
||||
rm -f *.tar.gz
|
||||
|
||||
# 清理 30 天前的備份
|
||||
find "$BACKUP_DIR" -name "qdrant_snapshots_*.tar.gz" -mtime +30 -delete
|
||||
|
||||
echo "Qdrant 備份完成: ${BACKUP_DIR}/qdrant_snapshots_${TIMESTAMP}.tar.gz"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
sleep 2
|
||||
|
||||
# 解壓縮備份
|
||||
TIMESTAMP="20260315"
|
||||
tar -xzf /Users/accusys/momentry/var/qdrant_backup/qdrant_snapshots_${TIMESTAMP}.tar.gz \
|
||||
-C /Users/accusys/momentry/var/qdrant_backup/
|
||||
|
||||
# 恢復數據目錄 (方式二備份)
|
||||
# rm -rf /Users/accusys/momentry/var/qdrant/*
|
||||
# tar -xzf /Users/accusys/momentry/var/qdrant_backup/qdrant_data_${TIMESTAMP}.tar.gz \
|
||||
# -C /Users/accusys/momentry/var/
|
||||
|
||||
# 啟動 Qdrant
|
||||
launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
### 排程備份
|
||||
|
||||
```bash
|
||||
# 編輯 crontab
|
||||
crontab -e
|
||||
|
||||
# 添加每天凌晨 3 點執行備份
|
||||
0 3 * * * /Users/accusys/momentry/scripts/backup_qdrant.sh >> /Users/accusys/momentry/log/backup.log 2>&1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.17.0
|
||||
- API Key: Test3200Test3200Test3200
|
||||
- 數據目錄: /Users/accusys/momentry/var/qdrant/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,501 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "REDIS"
|
||||
title: "Redis 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "redis"
|
||||
- "cache"
|
||||
- "key-value"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 Redis 快取伺服器?"
|
||||
- "Redis 連線資訊為何?"
|
||||
- "如何配置 Redis 持久化?"
|
||||
---
|
||||
|
||||
# Redis 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-21 | 更新 rust redis crate 版本至 0.32.7 | OpenCode | - |
|
||||
| V1.2 | 2026-03-21 | 添加 Redis 用戶配置說明 | OpenCode | - |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Redis,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Redis | ✅ 已安裝 v8.4.0 |
|
||||
| 數據目錄 | /opt/homebrew/var/db/redis/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.redis.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Redis (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Redis
|
||||
brew install redis
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
redis-server --version
|
||||
# Redis server v8.4.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/redis
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/redis.log
|
||||
touch /Users/accusys/momentry/log/redis.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/redis
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/redis
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.redis.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/redis/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/redis/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/redis/` | 安裝 | **刪除** - Redis 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Redis
|
||||
|
||||
```bash
|
||||
# 找到 Redis 進程
|
||||
ps aux | grep redis | grep -v grep
|
||||
|
||||
# 停止 Redis
|
||||
redis-cli -a accusys SHUTDOWN
|
||||
# 或
|
||||
pkill redis-server
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep redis | grep -v grep || echo "Redis 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Redis
|
||||
|
||||
```bash
|
||||
# 卸載 Redis
|
||||
brew uninstall redis
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/redis
|
||||
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/redis.log
|
||||
rm -f /Users/accusys/momentry/log/redis.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Redis 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Redis 進程
|
||||
echo "1. Redis 進程:"
|
||||
ps aux | grep redis | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 6379
|
||||
echo "2. Port 6379:"
|
||||
lsof -i :6379 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. redis-server 命令
|
||||
echo "3. redis-server 命令:"
|
||||
which redis-server > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list redis > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep redis > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/redis" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Redis 卸載後檢查 ===
|
||||
1. Redis 進程:
|
||||
✓ 已停止
|
||||
2. Port 6379:
|
||||
✓ 已釋放
|
||||
3. redis-server 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "redis"
|
||||
type: "tcp"
|
||||
port: 6379
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_redis() {
|
||||
local start=$(date +%s%N)
|
||||
if redis-cli -a accusys ping > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} Redis (6379) - ${ms}ms"
|
||||
record_service "redis" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} Redis (6379) - Down"
|
||||
record_service "redis" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep redis | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :6379
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
redis-cli -a accusys PING
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
redis-cli -a accusys -e "PING"
|
||||
|
||||
# 5. 查看所有 keys
|
||||
redis-cli -a accusys KEYS '*'
|
||||
|
||||
# 6. 查看 info
|
||||
redis-cli -a accusys INFO
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/redis.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 6379 |
|
||||
| Password | accusys |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Redis 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 密碼認證: `accusys`
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Redis 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/redis.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/redis/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/redis
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 6379
|
||||
lsof -i :6379
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/redis/` | Redis 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/redis/bin/redis-server` | Redis 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/redis/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/redis/` | 配置儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/redis.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/redis.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.redis.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/redis_backup_latest.rdb` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
# 觸發保存並備份
|
||||
redis-cli -a accusys SAVE
|
||||
cp /opt/homebrew/var/db/redis/dump.rdb /Users/accusys/momentry/var/redis_backup_latest.rdb
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 停止 Redis
|
||||
redis-cli -a accusys SHUTDOWN
|
||||
|
||||
# 複製備份文件覆蓋
|
||||
cp /Users/accusys/momentry/var/redis_backup_latest.rdb /Users/accusys/momentry/var/redis/dump.rdb
|
||||
|
||||
# 啟動 Redis
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Redis Server | 8.4.0 |
|
||||
| Rust redis crate | 0.32.7 |
|
||||
| Port | 6379 |
|
||||
| Password | accusys |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/redis/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
|
||||
---
|
||||
|
||||
## Rust redis crate 版本
|
||||
|
||||
Cargo.toml 中的 redis 依賴:
|
||||
|
||||
```toml
|
||||
redis = { version = "0.32", features = ["tokio-comp"] }
|
||||
```
|
||||
|
||||
### 版本歷史
|
||||
|
||||
| 版本 | 日期 | 變更 |
|
||||
|------|------|-------|
|
||||
| 0.25.4 | - | 原始版本(有未來相容性警告) |
|
||||
| 0.32.7 | 2026-03-21 | **升級** - 修復 Rust 2024 never type 回退問題 |
|
||||
|
||||
### 升級說明
|
||||
|
||||
升級到 0.32.x 的優點:
|
||||
- 修復 Rust 2024 edition 未來相容性問題
|
||||
- API 完全向後相容
|
||||
- 無需修改現有程式碼
|
||||
|
||||
---
|
||||
|
||||
## Redis 用戶配置說明
|
||||
|
||||
### 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| 用戶類型 | 僅有 `default` 用戶 |
|
||||
| 自訂用戶 | ❌ 未配置 |
|
||||
| ACL 持久化 | ❌ 未配置 |
|
||||
|
||||
### Redis ACL 狀態
|
||||
|
||||
```bash
|
||||
# 查看 ACL
|
||||
redis-cli -a accusys ACL LIST
|
||||
|
||||
# 輸出:
|
||||
# user default on sanitize-payload #hash ~* &* +@all
|
||||
```
|
||||
|
||||
### 連線格式說明
|
||||
|
||||
| 格式 | 狀態 | 說明 |
|
||||
|------|------|------|
|
||||
| `redis://:accusys@localhost:6379` | ✅ 正確 | 使用默認用戶 + 密碼 |
|
||||
| `redis://accusys:accusys@localhost:6379` | ❌ 失敗 | 用戶 `accusys` 不存在 |
|
||||
|
||||
### 為何用戶名不可用
|
||||
|
||||
1. **Redis 啟動方式**:使用 `--requirepass` 參數,僅設定默認用戶密碼
|
||||
2. **無 ACL 配置文件**:未指定 `--aclfile` 參數
|
||||
3. **動態建立用戶**:手動建立的用戶不會持久化(重啟後消失)
|
||||
|
||||
### 解決方案
|
||||
|
||||
#### 方案 A:使用默認用戶(現行)
|
||||
|
||||
```env
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
**適用於**:單一應用、簡單部署
|
||||
|
||||
#### 方案 B:建立 ACL 配置文件
|
||||
|
||||
```bash
|
||||
# 1. 建立 ACL 文件
|
||||
cat > /Users/accusys/momentry/etc/redis/users.acl << 'EOF'
|
||||
user default on sanitize-payload ~* &* +@all >accusys
|
||||
user accusys on sanitize-payload ~* &* +@all >accusys
|
||||
EOF
|
||||
|
||||
# 2. 修改 plist (添加 --aclfile 參數)
|
||||
# --aclfile /Users/accusys/momentry/etc/redis/users.acl
|
||||
|
||||
# 3. 重啟 Redis
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
**適用於**:多應用、需要用戶隔離
|
||||
|
||||
### 參考
|
||||
|
||||
- 問題追蹤:`docs_v1.0/REFERENCE/PENDING_ISSUES.md` 問題 #5
|
||||
- 測試結果:2026-03-21 Redis 認證測試
|
||||
@@ -1,320 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "RUSTDESK"
|
||||
title: "RustDesk 安裝指南 (本地部署)"
|
||||
date: "2026-03-15"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "rustdesk"
|
||||
- "remote-desktop"
|
||||
- "screen-sharing"
|
||||
- "macos"
|
||||
ai_query_hints:
|
||||
- "如何安裝 RustDesk 遠端桌面?"
|
||||
- "RustDesk 伺服器配置方式為何?"
|
||||
- "如何配置 RustDesk 中繼伺服器?"
|
||||
---
|
||||
|
||||
# RustDesk 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 RustDesk 遠端桌面服務,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| RustDesk | ✅ 已安裝 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/rustdesk/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| HBBS Plist | /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist |
|
||||
| HBBR Plist | /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist |
|
||||
|
||||
---
|
||||
|
||||
## 服務端口
|
||||
|
||||
| 服務 | Port | 協議 |
|
||||
|------|------|------|
|
||||
| hbbs (TCP) | 21115 | 主端口 |
|
||||
| hbbs (TCP/UDP) | 21116 | NAT 測試 |
|
||||
| hbbs (WebSocket) | 21118 | WebSocket |
|
||||
| hbbr (TCP) | 21117 | 中繼端口 |
|
||||
| hbbr (TCP) | 21119 | 中繼 extra |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 RustDesk (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 RustDesk
|
||||
brew install rustdesk
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
hbbs --version
|
||||
hbbr --version
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/rustdesk
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/rustdesk
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbs.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbs.error.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbr.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbr.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/rustdesk
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/rustdesk
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.rustdesk.hbbs.plist /Library/LaunchDaemons/
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.rustdesk.hbbr.plist /Library/LaunchDaemons/
|
||||
|
||||
# 移除舊 plist (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.rustdesk.hbbs.plist 2>/dev/null
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.rustdesk.hbbr.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.rustdesk.hbbs.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.rustdesk.hbbr.plist 2>/dev/null
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "rustdesk-hbbs"
|
||||
type: "tcp"
|
||||
port: 21115
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
- name: "rustdesk-hbbr"
|
||||
type: "tcp"
|
||||
port: 21117
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/rustdesk/` | 數據 | **不要刪除** - RustDesk 數據 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/bin/hbbr` | 安裝 | **刪除** - RustDesk 安裝 |
|
||||
| `/opt/homebrew/bin/hbbs` | 安裝 | **刪除** - RustDesk 安裝 |
|
||||
|
||||
### Step 1: 停止 RustDesk
|
||||
|
||||
```bash
|
||||
# 停止 RustDesk 服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep rustdesk | grep -v grep || echo "RustDesk 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 RustDesk
|
||||
|
||||
```bash
|
||||
# 卸載 RustDesk
|
||||
brew uninstall rustdesk
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/rustdesk
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/rustdesk-*.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep rustdesk | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :21115
|
||||
lsof -i :21116
|
||||
lsof -i :21117
|
||||
lsof -i :21118
|
||||
lsof -i :21119
|
||||
|
||||
# 3. 測試連線
|
||||
nc -zv localhost 21115
|
||||
nc -zv localhost 21116
|
||||
|
||||
# 4. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/rustdesk-hbbs.log
|
||||
tail -20 /Users/accusys/momentry/log/rustdesk-hbbr.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Server ID | 59.124.167.225 |
|
||||
| NAT Test Port | 21116 |
|
||||
| Relay Port | 21117, 21119 |
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### RustDesk 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/rustdesk-hbbs.log
|
||||
tail -f /Users/accusys/momentry/log/rustdesk-hbbr.log
|
||||
|
||||
# 檢查數據目錄權限
|
||||
ls -la /Users/accusys/momentry/var/rustdesk/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/rustdesk
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port
|
||||
lsof -i :21116
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/bin/hbbs` | RustDesk Server 執行檔 |
|
||||
| 安裝 | `/opt/homebrew/bin/hbbr` | RustDesk Relay 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/rustdesk/` | 數據儲存 |
|
||||
| HBBS 日誌 | `/Users/accusys/momentry/log/rustdesk-hbbs.log` | 服務日誌 |
|
||||
| HBBR 日誌 | `/Users/accusys/momentry/log/rustdesk-hbbr.log` | 中繼日誌 |
|
||||
| HBBS Plist | `/Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist` | 開機啟動 |
|
||||
| HBBR Plist | `/Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist` | 開機啟動 |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 安裝方式: Homebrew (Cask)
|
||||
- Client 版本: 1.4.6
|
||||
- Server 版本: 1.1.15 (hbbs/hbbr binaries from homebrew)
|
||||
- 數據目錄: /Users/accusys/momentry/var/rustdesk/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
|
||||
---
|
||||
|
||||
## 注意事項
|
||||
|
||||
### Server 版本
|
||||
|
||||
Homebrew 的 RustDesk Cask 只提供客戶端應用程序。服務器二進制文件 (hbbs, hbbr) 需要從其他來源安裝或自行編譯。當前使用的版本較舊 (1.1.15)。
|
||||
|
||||
如需更新服務器版本,可以考慮:
|
||||
1. 從源代碼編譯最新版本
|
||||
2. 使用 RustDesk 官方提供的 Docker 鏡像
|
||||
3. 等待 Homebrew 添加服務器公式
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,352 +0,0 @@
|
||||
---
|
||||
document_type: "installation_guide"
|
||||
service: "WORDPRESS"
|
||||
title: "WordPress 安裝指南 (Portal)"
|
||||
date: "2026-03-22"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "Warren"
|
||||
tags:
|
||||
- "wordpress"
|
||||
- "portal"
|
||||
- "cms"
|
||||
- "php"
|
||||
ai_query_hints:
|
||||
- "如何安裝 WordPress Portal?"
|
||||
- "WordPress 與 Momentry 整合方式為何?"
|
||||
- "如何配置 WordPress 外掛?"
|
||||
---
|
||||
|
||||
# WordPress 安裝指南 (Portal)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-22 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建文件 | Warren | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 1. 概述
|
||||
|
||||
本文檔說明 Momentry Portal 的 WordPress 安裝配置,作為系統入口整合 n8n 自動化與 sftpgo 檔案服務。
|
||||
|
||||
---
|
||||
|
||||
## 2. 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| WordPress 版本 | 6.x |
|
||||
| URL | https://wp.momentry.ddns.net |
|
||||
| 安裝路徑 | `/Users/accusys/wordpress/web` |
|
||||
| 資料庫 | wordpress (MariaDB) |
|
||||
| 資料庫用戶 | wp_user |
|
||||
|
||||
---
|
||||
|
||||
## 3. 目錄結構
|
||||
|
||||
```
|
||||
/Users/accusys/wordpress/
|
||||
├── web/ # WordPress 主目錄
|
||||
│ ├── wp-admin/ # WordPress 管理面板
|
||||
│ ├── wp-content/ # 內容目錄
|
||||
│ │ ├── ai1wm-backups/ # 備份檔案 (*.wpress)
|
||||
│ │ ├── languages/ # 語言檔案
|
||||
│ │ ├── plugins/ # 插件目錄
|
||||
│ │ ├── themes/ # 主題目錄
|
||||
│ │ ├── uploads/ # 上傳檔案
|
||||
│ │ └── cache/ # 快取目錄
|
||||
│ ├── wp-includes/ # WordPress 核心
|
||||
│ └── wp-config.php # 配置文件
|
||||
├── docker-compose.yml # Docker 配置
|
||||
└── wordpress_backup.sql # 資料庫備份
|
||||
```
|
||||
|
||||
### 空間使用
|
||||
|
||||
| 目錄 | 大小 | 說明 |
|
||||
|------|------|------|
|
||||
| `ai1wm-backups/` | ~250MB | 完整備份 (保留 2 個) |
|
||||
| `plugins/` | 80MB | 插件 |
|
||||
| `themes/` | 14MB | 主題 |
|
||||
| `uploads/` | 12MB | 上傳檔案 |
|
||||
|
||||
---
|
||||
|
||||
## 4. 程式碼位置
|
||||
|
||||
自訂程式碼存放位置:
|
||||
|
||||
| 類型 | 路徑 |
|
||||
|------|------|
|
||||
| 主題 | `/Users/accusys/wordpress/web/wp-content/themes/` |
|
||||
| 插件 | `/Users/accusys/wordpress/web/wp-content/plugins/` |
|
||||
| 必須插件 | `/Users/accusys/wordpress/web/wp-content/mu-plugins/` |
|
||||
|
||||
---
|
||||
|
||||
## 5. 插件清單
|
||||
|
||||
| 插件 | 用途 | 說明 |
|
||||
|------|------|------|
|
||||
| elementor | 頁面建構 | 視覺化頁面編輯器 |
|
||||
| all-in-one-wp-migration | 網站遷移/備份 | 完整網站備份工具 |
|
||||
| akismet | 垃圾留言過濾 | 保護留言區域 |
|
||||
| code-snippets | 自訂程式碼 | 無需修改主題即可添加 PHP |
|
||||
|
||||
### Elementor 版本
|
||||
- 版本: 最新穩定版
|
||||
- 用途: 頁面建構(開發階段)
|
||||
|
||||
### 未來計畫
|
||||
- Phase 2: OpenCode 重構
|
||||
- 目標: 交付無 Elementor 依賴版本
|
||||
|
||||
---
|
||||
|
||||
## 6. 主題清單
|
||||
|
||||
| 主題 | 說明 |
|
||||
|------|------|
|
||||
| twentytwentyfive | 目前使用主題 |
|
||||
| twentytwentyfour | 備用 |
|
||||
| twentytwentythree | 備用 |
|
||||
|
||||
---
|
||||
|
||||
## 7. 整合計畫
|
||||
|
||||
### 7.1 n8n 整合
|
||||
|
||||
n8n 作為自動化引擎,WordPress 頁面透過 REST API 或 Webhook 與 n8n 通訊。
|
||||
|
||||
| 整合方式 | 說明 |
|
||||
|----------|------|
|
||||
| REST API | WordPress 呼叫 n8n API |
|
||||
| Webhook | n8n 觸發 WordPress 動作 |
|
||||
|
||||
### 7.2 sftpgo 整合
|
||||
|
||||
sftpgo 作為檔案服務,WordPress 頁面提供檔案上傳/下載功能。
|
||||
|
||||
| 整合方式 | 說明 |
|
||||
|----------|------|
|
||||
| WebDAV | 透過 WebDAV API 操作檔案 |
|
||||
| REST API | 透過 sftpgo API 操作檔案 |
|
||||
|
||||
---
|
||||
|
||||
## 8. 管理命令
|
||||
|
||||
### 8.1 清理 ai1wm 備份
|
||||
|
||||
```bash
|
||||
# 查看現有備份
|
||||
ls -lt /Users/accusys/wordpress/web/wp-content/ai1wm-backups/*.wpress
|
||||
|
||||
# 保留最近 2 個,刪除舊的
|
||||
ls -t /Users/accusys/wordpress/web/wp-content/ai1wm-backups/*.wpress | tail -n +3 | xargs rm
|
||||
|
||||
# 驗證結果
|
||||
du -sh /Users/accusys/wordpress/web/wp-content/ai1wm-backups/
|
||||
```
|
||||
|
||||
### 8.2 清理 WordPress 快取
|
||||
|
||||
```bash
|
||||
# 刪除 Object Cache
|
||||
wp cache flush
|
||||
|
||||
# 刪除 Elementor 快取
|
||||
wp elementor flush_css
|
||||
|
||||
# 刪除全部快取
|
||||
wp cache flush && wp elementor flush_css
|
||||
```
|
||||
|
||||
### 8.3 資料庫操作
|
||||
|
||||
```bash
|
||||
# 匯出資料庫
|
||||
mysqldump -u wp_user -p wordpress > wordpress_backup.sql
|
||||
|
||||
# 匯入資料庫
|
||||
mysql -u wp_user -p wordpress < wordpress_backup.sql
|
||||
```
|
||||
|
||||
### 8.4 權限檢查
|
||||
|
||||
```bash
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/wordpress/web/wp-content/
|
||||
|
||||
# 確認 wp-content 可寫入
|
||||
chown -R _www:_www /Users/accusys/wordpress/web/wp-content/
|
||||
chmod -R 755 /Users/accusys/wordpress/web/wp-content/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. 故障排除
|
||||
|
||||
### 9.1 常見問題
|
||||
|
||||
| 問題 | 解決方案 |
|
||||
|------|----------|
|
||||
| 頁面載入緩慢 | 清理 Elementor/Object Cache |
|
||||
| 上傳檔案失敗 | 檢查 wp-content/uploads 權限 |
|
||||
| 502/504 錯誤 | 重啟 PHP-FPM |
|
||||
| 資料庫連線失敗 | 檢查 wp-config.php 設定 |
|
||||
|
||||
### 9.2 診斷命令
|
||||
|
||||
```bash
|
||||
# 檢查 PHP-FPM 狀態
|
||||
lsof -i :9000
|
||||
|
||||
# 檢查 MySQL/MariaDB 狀態
|
||||
lsof -i :3306
|
||||
|
||||
# 檢查 Apache/Nginx 狀態
|
||||
lsof -i :80
|
||||
|
||||
# 查看 WordPress 錯誤日誌
|
||||
tail -100 /Users/accusys/momentry/log/php-fpm.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. 開發協作
|
||||
|
||||
### 10.1 與 marcom 團隊協作
|
||||
|
||||
| 角色 | 負責 |
|
||||
|------|------|
|
||||
| marcom 團隊 | Figma 設計 / Elementor 建構 |
|
||||
| OpenCode | 程式碼實作 / 重構 |
|
||||
|
||||
### 10.2 開發流程
|
||||
|
||||
```
|
||||
Phase 1: marcom 建構 (現在)
|
||||
└── Elementor 頁面建構
|
||||
|
||||
Phase 2: 交付審視 (TBD)
|
||||
└── 功能確認 / 重構評估
|
||||
|
||||
Phase 3: OpenCode 重構 (討論後)
|
||||
└── 純程式碼實作
|
||||
└── 交付客戶 (無 Elementor 依賴)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. PHP LSP 開發環境
|
||||
|
||||
### 11.1 軟體需求
|
||||
|
||||
| 軟體 | 版本 | 安裝方式 |
|
||||
|------|------|----------|
|
||||
| PHP | 8.0+ | 已安裝 (8.5.2) |
|
||||
| Composer | 2.0+ | `brew install composer` |
|
||||
| phpactor | Latest | PHAR 安裝 |
|
||||
|
||||
### 11.2 安裝步驟
|
||||
|
||||
#### 1. 安裝 Composer
|
||||
|
||||
```bash
|
||||
brew install composer
|
||||
```
|
||||
|
||||
#### 2. 安裝 phpactor
|
||||
|
||||
```bash
|
||||
curl -sSL https://github.com/phpactor/phpactor/releases/latest/download/phpactor.phar -o ~/bin/phpactor
|
||||
chmod +x ~/bin/phpactor
|
||||
export PATH="$HOME/bin:$PATH"
|
||||
```
|
||||
|
||||
#### 3. 安裝 WordPress Stubs
|
||||
|
||||
```bash
|
||||
cd /Users/accusys/wordpress/web
|
||||
composer require --dev php-stubs/wordpress-stubs
|
||||
```
|
||||
|
||||
#### 4. 設定 phpactor
|
||||
|
||||
```bash
|
||||
# 設定檔位置
|
||||
mkdir -p ~/.config/phpactor
|
||||
|
||||
# 設定內容
|
||||
cat > ~/.config/phpactor/phpactor.json << 'EOF'
|
||||
{
|
||||
"core.min_memory_limit": 1610612736,
|
||||
"worse_reflection.additive_stubs": [
|
||||
"/Users/accusys/wordpress/web/vendor/php-stubs/wordpress-stubs/wordpress-stubs.php"
|
||||
]
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
#### 5. 建立索引
|
||||
|
||||
```bash
|
||||
cd /Users/accusys/wordpress/web
|
||||
~/bin/phpactor index:build --reset
|
||||
```
|
||||
|
||||
### 11.3 OpenCode 使用方式
|
||||
|
||||
```bash
|
||||
# 確認安裝
|
||||
~/bin/phpactor --version
|
||||
|
||||
# 查詢類別
|
||||
~/bin/phpactor class:search "WP_User"
|
||||
|
||||
# 查看類別資訊
|
||||
~/bin/phpactor index:query WP_User
|
||||
|
||||
# 導航到定義
|
||||
~/bin/phpactor navigate /path/to/file.php
|
||||
|
||||
# 查詢參照
|
||||
~/bin/phpactor references /path/to/file.php
|
||||
```
|
||||
|
||||
### 11.4 常用指令
|
||||
|
||||
| 指令 | 用途 |
|
||||
|------|------|
|
||||
| `phpactor class:search` | 搜尋類別 |
|
||||
| `phpactor index:query` | 查詢索引 |
|
||||
| `phpactor index:build` | 建立索引 |
|
||||
| `phpactor index:clean` | 清除索引 |
|
||||
| `phpactor config:dump` | 顯示設定 |
|
||||
|
||||
---
|
||||
|
||||
## 12. 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| WordPress 主目錄 | `/Users/accusys/wordpress/web` | 網站根目錄 |
|
||||
| 備份目錄 | `/Users/accusys/momentry/backup/wordpress/` | 每日備份 |
|
||||
| 日誌目錄 | `/Users/accusys/momentry/log/` | PHP/Apache 日誌 |
|
||||
| phpactor | `~/bin/phpactor` | PHP LSP 主程式 |
|
||||
| phpactor 設定 | `~/.config/phpactor/phpactor.json` | LSP 設定檔 |
|
||||
| WordPress Stubs | `/Users/accusys/wordpress/web/vendor/php-stubs/` | WordPress 函數定義 |
|
||||
@@ -1,266 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n 整合範例"
|
||||
date: "2026-03-18"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "整合範例"
|
||||
ai_query_hints:
|
||||
- "查詢 n8n 整合範例 的內容"
|
||||
- "n8n 整合範例 的主要目的是什麼?"
|
||||
- "如何操作或實施 n8n 整合範例?"
|
||||
---
|
||||
|
||||
# n8n 整合範例
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-18 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-18 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-25 | 更新API回應格式 (media_url→file_path) 與認證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## 基本設定
|
||||
|
||||
### API 端點
|
||||
- **Base URL:** `http://localhost:3002/api/v1`
|
||||
- **Method:** `POST`
|
||||
- **Content-Type:** `application/json`
|
||||
- **Authentication:** `X-API-Key: YOUR_API_KEY` (所有 `/api/v1/*` 端點皆需要)
|
||||
|
||||
---
|
||||
|
||||
## Workflow 1: 基礎搜尋
|
||||
|
||||
### Trigger: Manual / Webhook
|
||||
|
||||
```
|
||||
[Manual Trigger]
|
||||
↓
|
||||
[HTTP Request] → POST http://localhost:3002/api/v1/search
|
||||
↓
|
||||
[Set] → 設定搜尋詞 "charade"
|
||||
↓
|
||||
[Code] → 處理回傳結果
|
||||
↓
|
||||
[Respond]
|
||||
```
|
||||
|
||||
### HTTP Request 設定
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:3002/api/v1/search",
|
||||
"method": "POST",
|
||||
"body": {
|
||||
"query": "={{ $json.searchTerm }}",
|
||||
"limit": 5
|
||||
},
|
||||
"options": {
|
||||
"headers": {
|
||||
"Content-Type": "application/json",
|
||||
"X-API-Key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Code (處理結果)
|
||||
```javascript
|
||||
const results = $input.first().json.results;
|
||||
|
||||
const videoUrl = "https://wp.momentry.ddns.net/Old_Time_Movie_Show_-_Charade_1963.HD.mov";
|
||||
|
||||
return results.map(r => ({
|
||||
chunk_id: r.chunk_id,
|
||||
text: r.text,
|
||||
start: r.start_time,
|
||||
end: r.end_time,
|
||||
score: r.score,
|
||||
video_url: `${videoUrl}#t=${r.start_time},${r.end_time}`
|
||||
}));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 2: n8n 專用格式
|
||||
|
||||
使用 `/n8n/search` 端點(已包含 file_path)
|
||||
|
||||
### HTTP Request
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:3002/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"body": {
|
||||
"query": "={{ $json.searchTerm }}",
|
||||
"limit": 5
|
||||
},
|
||||
"options": {
|
||||
"headers": {
|
||||
"Content-Type": "application/json",
|
||||
"X-API-Key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 回傳格式
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 5,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0006",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0006",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.526,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> **注意**: API 現在返回 `file_path`(檔案系統路徑)而非 `media_url`(網頁 URL)。如需在網頁中播放影片,請將檔案路徑轉換為可訪問的 URL(例如透過 SFTPGo 分享連結)。
|
||||
|
||||
---
|
||||
|
||||
## Workflow 3: 訊息機器人整合
|
||||
|
||||
### Telegram Bot 範例
|
||||
|
||||
```
|
||||
[Webhook: Telegram]
|
||||
↓
|
||||
[Extract: /search charade]
|
||||
↓
|
||||
[HTTP Request] → POST /api/v1/search
|
||||
↓
|
||||
[Format Response]
|
||||
↓
|
||||
[Telegram: Send Message]
|
||||
```
|
||||
|
||||
### 回傳格式
|
||||
```
|
||||
🎬 搜尋結果: "charade"
|
||||
|
||||
1. "fun plot twists, Woody Dialog and charming performances..."
|
||||
⏱ 48.8s - 55.4s
|
||||
📊 分數: 0.526
|
||||
|
||||
2. "Don't you like me to say that a pretty girl..."
|
||||
⏱ 4745.6s - 4748.6s
|
||||
📊 分數: 0.525
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 4: 多影片搜尋
|
||||
|
||||
### 取得所有影片
|
||||
```
|
||||
[HTTP Request]
|
||||
GET http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 依 UUID 篩選
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 5,
|
||||
"uuid": "a1b10138a6bbb0cd"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 5: 定時更新
|
||||
|
||||
```
|
||||
[Cron: 每小時]
|
||||
↓
|
||||
[HTTP Request] → GET /api/v1/videos
|
||||
↓
|
||||
[Loop Over Items]
|
||||
↓
|
||||
[Check: 新影片?]
|
||||
↓
|
||||
[Process: 執行 vectorize]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 實用場景
|
||||
|
||||
### 1. 客服機器人
|
||||
用戶問「這部片在哪一段有談到 charade?」
|
||||
→ 搜尋 API → 回傳時戳 → 直接播放該片段
|
||||
|
||||
### 2. 內容推薦
|
||||
根據用戶輸入的關鍵字,找到相關影片片段
|
||||
|
||||
### 3. 自動化剪輯
|
||||
搜尋多個片段 → 組合成精華影片
|
||||
|
||||
---
|
||||
|
||||
## 錯誤處理
|
||||
|
||||
```javascript
|
||||
const response = $input.first();
|
||||
|
||||
if (!response.json.results || response.json.results.length === 0) {
|
||||
return {
|
||||
success: false,
|
||||
message: "找不到相關結果"
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
count: response.json.results.length,
|
||||
data: response.json.results
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 測試用 cURL
|
||||
|
||||
```bash
|
||||
# 基本搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}'
|
||||
|
||||
# n8n 格式
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}'
|
||||
|
||||
# 取得影片列表
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 取得特定影片的區塊
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos/a1b10138a6bbb0cd/chunks
|
||||
```
|
||||
@@ -1,374 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n Video RAG Demo - API 執行記錄"
|
||||
date: "2026-03-22"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "demo"
|
||||
- "video"
|
||||
- "執行記錄"
|
||||
ai_query_hints:
|
||||
- "查詢 n8n Video RAG Demo - API 執行記錄 的內容"
|
||||
- "n8n Video RAG Demo - API 執行記錄 的主要目的是什麼?"
|
||||
- "如何操作或實施 n8n Video RAG Demo - API 執行記錄?"
|
||||
---
|
||||
|
||||
# n8n Video RAG Demo - API 執行記錄
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-22 |
|
||||
| 文件版本 | V1.1 |
|
||||
| 目標 | 完整執行 n8n Video RAG Workflow 並記錄所有 API 呼叫 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建文件 | Warren | OpenCode |
|
||||
| V1.1 | 2026-03-26 | 更新 API 範例,新增 X-API-Key 驗證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: SFTPGo 準備
|
||||
|
||||
### Step 1.1: 取得 Demo User Token
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:8080/api/v2/user/token" \
|
||||
-u "demo:demopassword123"
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```
|
||||
GET /api/v2/user/token
|
||||
Authorization: Basic ZG9tbzpkZW1vcGFzc3dvcmQxMjM=
|
||||
```
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
|
||||
"expires_at": "2026-03-22T07:05:57Z"
|
||||
}
|
||||
```
|
||||
|
||||
**Token 有效期限:** 20 分鐘
|
||||
|
||||
**Session Token (Demo User):**
|
||||
```
|
||||
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiQVBJVXNlciIsIjo6MSJdLCJleHAiOjE3NzQxNjMxNTcsImlhdCI6MTc3NDE2MTk1NywianRpIjoiZDZ2cDA5YWcyZnIwMnY3aTlybDAiLCJuYmYiOjE3NzQxNjE5NDcsInN1YiI6IjE3NzQxNjE5NTM0OTMiLCJ1c2VybmFtZSI6ImRlbW8ifQ.yw0UCv8sQXXCkOr7qmK2ejLzuoA8IDrmC9bpgFE4R_Q
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.2: 上傳測試影片到 SFTPGo
|
||||
|
||||
**影片選擇:** `Old_Time_Movie_Show_-_Charade_1963.HD.mov` (2.3 GB)
|
||||
- 路徑: `/Users/accusys/test_video/Old_Time_Movie_Show_-_Charade_1963.HD.mov`
|
||||
- ASR Segments: 1,917 (已預處理)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
curl -X POST "http://localhost:8080/api/v2/user/files" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-F "path=/demo" \
|
||||
-F "mkdir_parents=true" \
|
||||
-F "filenames=@/Users/accusys/test_video/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```
|
||||
POST /api/v2/user/files
|
||||
Authorization: Bearer <token>
|
||||
Content-Type: multipart/form-data
|
||||
|
||||
path: /demo
|
||||
mkdir_parents: true
|
||||
filenames: @/path/to/Old_Time_Movie_Show_-_Charade_1963.HD.mov
|
||||
```
|
||||
|
||||
**Response (201 Created):**
|
||||
```json
|
||||
{"message":"Upload completed"}
|
||||
```
|
||||
|
||||
**上傳統計:**
|
||||
- 檔案大小: 2,361,629,896 bytes (2.3 GB)
|
||||
- 上傳時間: 7 秒
|
||||
- 平均速度: ~337 MB/s
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.3: 建立分享連結
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:8080/api/v2/user/shares" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "Charade_1963_Demo",
|
||||
"paths": ["/Old_Time_Movie_Show_-_Charade_1963.HD.mov"],
|
||||
"scope": 1,
|
||||
"expires_at": 0
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v2/user/shares
|
||||
Authorization: Bearer <token>
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "Charade_1963_Demo",
|
||||
"paths": ["/Old_Time_Movie_Show_-_Charade_1963.HD.mov"],
|
||||
"scope": 1,
|
||||
"expires_at": 0
|
||||
}
|
||||
```
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{"message":"Share created"}
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.4: 驗證上傳結果
|
||||
|
||||
**API 呼叫 - 列出分享:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:8080/api/v2/user/shares" \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "CjmQfrkXY5qDtC46WVZY2S",
|
||||
"name": "Charade_1963_Demo",
|
||||
"scope": 1,
|
||||
"paths": [
|
||||
"/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
],
|
||||
"username": "demo",
|
||||
"created_at": 1774162072853,
|
||||
"updated_at": 1774162072853,
|
||||
"password": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
**分享連結:**
|
||||
- Share ID: `CjmQfrkXY5qDtC46WVZY2S`
|
||||
- Browse URL: `http://localhost:8080/web/client/pubshares/CjmQfrkXY5qDtC46WVZY2S/browse`
|
||||
|
||||
**本地目錄驗證:**
|
||||
```
|
||||
/Users/accusys/sftpgo_test/demo/
|
||||
└── Old_Time_Movie_Show_-_Charade_1963.HD.mov (2,361,629,896 bytes)
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Momentry 註冊
|
||||
|
||||
### Step 2.1: 健康檢查
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:3002/health"
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2.2: 註冊影片
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/register" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"path": "/Users/accusys/sftpgo_test/demo/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v1/register
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"path": "/Users/accusys/sftpgo_test/demo/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
{
|
||||
"uuid": "...",
|
||||
"video_id": ...,
|
||||
"file_name": "...",
|
||||
"duration": ...,
|
||||
"width": ...,
|
||||
"height": ...
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: 處理進度追蹤
|
||||
|
||||
### Step 3.1: 查詢處理進度 (新版 API)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:3002/api/v1/progress/{uuid}"
|
||||
```
|
||||
|
||||
**Response (新版 - 包含影片資訊與系統資源):**
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"user": null,
|
||||
"group": null,
|
||||
"file_name": "Old_Time_Movie_Show_-_Charade_1963.HD.mov",
|
||||
"duration": 6879.33,
|
||||
"overall_progress": 28,
|
||||
"cpu_percent": 3.7,
|
||||
"gpu_percent": null,
|
||||
"memory_percent": 0.1,
|
||||
"memory_mb": 19328,
|
||||
"processors": [
|
||||
{"name": "asr", "status": "complete", "current": 1867, "total": 0, "progress": 100, "message": "1867 segments"},
|
||||
{"name": "cut", "status": "complete", "current": 1331, "total": 1331, "progress": 100, "message": "1331 scenes"},
|
||||
{"name": "asrx", "status": "error", "current": 0, "total": 0, "progress": 0, "message": "0 segments"},
|
||||
{"name": "yolo", "status": "progress", "current": 69400, "total": 412343, "progress": 16, "message": "frame 69400"},
|
||||
{"name": "ocr", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""},
|
||||
{"name": "face", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""},
|
||||
{"name": "pose", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**欄位說明:**
|
||||
| 欄位 | 說明 |
|
||||
|------|------|
|
||||
| uuid | 影片唯一識別碼 |
|
||||
| user | 處理所屬用戶 (如已設定) |
|
||||
| group | 處理所屬群組 (如已設定) |
|
||||
| file_name | 影片檔案名稱 |
|
||||
| duration | 影片時長 (秒) |
|
||||
| overall_progress | 整體進度 (百分比) |
|
||||
| cpu_percent | CPU 使用率 (%) |
|
||||
| gpu_percent | GPU 使用率 (%),無 GPU 則為 null |
|
||||
| memory_percent | 記憶體使用率 (%) |
|
||||
| memory_mb | 記憶體使用量 (MB) |
|
||||
| processors | 各處理器狀態陣列 |
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: 自然語言檢索
|
||||
|
||||
### Step 4.1: RAG 搜尋
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "..."
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v1/search
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "<uuid from registration>"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4.2: n8n 搜尋 (含 file_path)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/n8n/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: muser_68600856036340bcafc01930eb4bd839" \
|
||||
-d '{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "..."
|
||||
}'
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 憑證彙整
|
||||
|
||||
| 服務 | 項目 | 值 |
|
||||
|------|------|------|
|
||||
| SFTPGo | API Base | `http://localhost:8080/api/v2` |
|
||||
| SFTPGo | Demo User | `demo` |
|
||||
| SFTPGo | Demo Password | `demopassword123` (已重設) |
|
||||
| SFTPGo | Demo Home | `/Users/accusys/sftpgo_test/demo` |
|
||||
| SFTPGo | Token Endpoint | `/api/v2/user/token` |
|
||||
| SFTPGo | Share ID | `CjmQfrkXY5qDtC46WVZY2S` |
|
||||
| Momentry | Server | `http://localhost:3002` |
|
||||
| Momentry | MEDIA_BASE_URL | `https://wp.momentry.ddns.net` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 日期 | 版本 | 變更 |
|
||||
|------|------|------|
|
||||
| 2026-03-22 | v1.0 | 初始建立文件 |
|
||||
| 2026-03-22 | v1.1 | 成功取得 Demo Token |
|
||||
| 2026-03-22 | v1.2 | Phase 1 完成 (上傳 Charade 2.3GB) |
|
||||
@@ -1,690 +0,0 @@
|
||||
# n8n Video RAG Workflow - Node 設計
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-22 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-25 | 更新API回應格式 (media_url→file_path) 與認證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## 完整 Workflow 架構
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||
│ n8n Workflow: Video RAG Demo │
|
||||
├─────────────────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 1: SFTPGo 準備 (全部在 n8n Node 內執行) │ │
|
||||
│ │ │ │
|
||||
│ │ ① Webhook Trigger │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ② Set Variables (解析 file_name, query) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ③ Get SFTPGo Token │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ④ Upload to SFTPGo │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑤ Create Share Link │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑥ Verify Upload (List Files + List Shares) │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 2: Momentry 註冊 (只處理 ASR, ASRX, STORY) │ │
|
||||
│ │ │ │
|
||||
│ │ ⑦ Register Video (modules=asr,asrx,story) │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 3: Progress Loop (n8n Logs 記錄) │ │
|
||||
│ │ │ │
|
||||
│ │ ⑧ Wait 10s ─────────────────────────────────────────────────┐ │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑨ Check Progress (API) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑩ Log Progress (Code Node → n8n Logs) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑪ Is Complete? (IF) │ │
|
||||
│ │ │ │ │
|
||||
│ │ ├── NO ──────────────────────────────── Loop Back ─────────┘ │ │
|
||||
│ │ └── YES ────────────────────────────────────────────── Exit ──┘ │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 4: 搜尋與回應 │ │
|
||||
│ │ │ │
|
||||
│ │ ⑫ Hybrid Search (Vector + BM25) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑬ Build Response │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑭ Respond to Webhook │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 模組說明
|
||||
|
||||
| 模組 | 用途 | 輸出 |
|
||||
|------|------|------|
|
||||
| `asr` | 語音轉文字 (Whisper) | 字幕/文字稿 |
|
||||
| `asrx` | 說話者分離 (WhisperX) | 誰在什麼時候說什麼 |
|
||||
| `story` | 故事線生成 (Parent-Child Chunks) | 敘事結構 + 父子區塊關聯 |
|
||||
|
||||
**注意**: 只處理語音和故事相關模組,跳過 YOLO、OCR、Face、Pose 等視覺分析。
|
||||
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||
│ n8n Workflow: Video RAG Demo │
|
||||
├─────────────────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 1: SFTPGo 準備 (全部在 n8n Node 內執行) │ │
|
||||
│ │ │ │
|
||||
│ │ ① Webhook Trigger │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ② Set Variables (解析 file_name, query) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ③ Get SFTPGo Token │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ④ Upload to SFTPGo │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑤ Create Share Link │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑥ Verify Upload (List Files + List Shares) │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 2: Momentry 註冊 │ │
|
||||
│ │ │ │
|
||||
│ │ ⑦ Register Video │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 3: Progress Loop (n8n Logs 記錄) │ │
|
||||
│ │ │ │
|
||||
│ │ ⑧ Wait 10s ─────────────────────────────────────────────────┐ │ │
|
||||
│ │ ↓ │ │ │
|
||||
│ │ ⑨ Check Progress (API) │ │ │
|
||||
│ │ ↓ │ │ │
|
||||
│ │ ⑩ Log Progress (Code Node → n8n Logs) │ │ │
|
||||
│ │ ↓ │ │ │
|
||||
│ │ ⑪ Is Complete? (IF) │ │ │
|
||||
│ │ │ │ │ │
|
||||
│ │ ├── NO ──────────────────────────────── Loop Back ─────────┘ │ │
|
||||
│ │ └── YES ────────────────────────────────────────────── Exit ──┘ │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Phase 4: 搜尋與回應 │ │
|
||||
│ │ │ │
|
||||
│ │ ⑫ Natural Language Search │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑬ Get File Path (含 file_path) │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑭ Build Response │ │
|
||||
│ │ ↓ │ │
|
||||
│ │ ⑮ Respond to Webhook │ │
|
||||
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Node 詳細配置
|
||||
|
||||
### Node ①: Webhook Trigger (觸發器)
|
||||
|
||||
```yaml
|
||||
Node Name: "Webhook Trigger"
|
||||
Node Type: "Webhook"
|
||||
|
||||
Configuration:
|
||||
HTTP Method: POST
|
||||
Path: "video-rag"
|
||||
Response Mode: "Response Node"
|
||||
Response Node: "Respond to Webhook"
|
||||
|
||||
Input JSON Example:
|
||||
{
|
||||
"file_name": "Old_Time_Movie_Show_-_Charade_1963.HD.mov",
|
||||
"query": "What is the movie about?"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ②: Set Variables (變數設定)
|
||||
|
||||
```yaml
|
||||
Node Name: "Set Variables"
|
||||
Node Type: "Set"
|
||||
|
||||
Configuration:
|
||||
Keep Only Set: true
|
||||
|
||||
Variables:
|
||||
- Name: "file_name"
|
||||
Value: "{{ $json.body.file_name }}"
|
||||
|
||||
- Name: "query"
|
||||
Value: "{{ $json.body.query }}"
|
||||
|
||||
- Name: "sftpgo_path"
|
||||
Value: "/{{ $json.body.file_name }}"
|
||||
|
||||
- Name: "register_path"
|
||||
Value: "/Users/accusys/sftpgo_test/demo/{{ $json.body.file_name }}"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ③: Get SFTPGo Token (取得權杖)
|
||||
|
||||
```yaml
|
||||
Node Name: "Get SFTPGo Token"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: GET
|
||||
URL: "http://localhost:8080/api/v2/user/token"
|
||||
Authentication: "Basic Auth"
|
||||
User: "demo"
|
||||
Password: "demopassword123"
|
||||
|
||||
Output:
|
||||
{
|
||||
"access_token": "eyJhbGci...",
|
||||
"expires_at": "2026-03-22T07:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ④: Upload to SFTPGo (上傳檔案)
|
||||
|
||||
```yaml
|
||||
Node Name: "Upload to SFTPGo"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:8080/api/v2/user/files"
|
||||
Authentication: "Bearer Token"
|
||||
Bearer Token: "{{ $json.access_token }}"
|
||||
|
||||
Body Content Type: "Form-Data Multipart"
|
||||
|
||||
Body:
|
||||
path: /demo
|
||||
mkdir_parents: true
|
||||
filenames: @{{ $json.file_name }}
|
||||
|
||||
Output:
|
||||
{"message":"Upload completed"}
|
||||
```
|
||||
|
||||
**檔案來源選項:**
|
||||
1. **Webhook 接收**: 從 Webhook 的 binary data 取得
|
||||
2. **固定路徑**: 指定本地檔案路徑
|
||||
3. **URL 下載**: 先下載遠端檔案再上傳
|
||||
|
||||
---
|
||||
|
||||
### Node ⑤: Create Share Link (建立分享連結)
|
||||
|
||||
```yaml
|
||||
Node Name: "Create Share Link"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:8080/api/v2/user/shares"
|
||||
Authentication: "Bearer Token"
|
||||
Bearer Token: "{{ $json.access_token }}"
|
||||
|
||||
Body Content Type: "JSON"
|
||||
|
||||
Body:
|
||||
{
|
||||
"name": "{{ $json.file_name }}_share",
|
||||
"paths": ["/{{ $json.file_name }}"],
|
||||
"scope": 1,
|
||||
"expires_at": 0
|
||||
}
|
||||
|
||||
Output:
|
||||
{
|
||||
"id": "CjmQfrkXY5qDtC46WVZY2S",
|
||||
"name": "Charade_share"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑥: Verify Upload (驗證上傳)
|
||||
|
||||
```yaml
|
||||
Node Name: "Verify Upload - List Shares"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: GET
|
||||
URL: "http://localhost:8080/api/v2/user/shares"
|
||||
Authentication: "Bearer Token"
|
||||
Bearer Token: "{{ $json.access_token }}"
|
||||
|
||||
Output:
|
||||
[
|
||||
{
|
||||
"id": "CjmQfrkXY5qDtC46WVZY2S",
|
||||
"name": "Charade_share",
|
||||
"paths": ["/Old_Time_Movie_Show_-_Charade_1963.HD.mov"]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑦: Register Video (註冊影片)
|
||||
|
||||
**說明**: 只註冊 ASR、ASRX、STORY 模組處理
|
||||
|
||||
```yaml
|
||||
Node Name: "Register Video"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:3002/api/v1/register"
|
||||
|
||||
Body Content Type: "JSON"
|
||||
|
||||
Body:
|
||||
{
|
||||
"path": "{{ $json.register_path }}",
|
||||
"modules": "asr,asrx,story"
|
||||
}
|
||||
|
||||
Output:
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"video_id": 7,
|
||||
"file_name": "Old_Time_Movie_Show_-_Charade_1963.HD.mov",
|
||||
"duration": 6879.33,
|
||||
"width": 1920,
|
||||
"height": 1080
|
||||
}
|
||||
```
|
||||
|
||||
**可用模組**:
|
||||
| 模組 | 說明 |
|
||||
|------|------|
|
||||
| `asr` | 語音轉文字 (Whisper) |
|
||||
| `asrx` | 說話者分離 (WhisperX) |
|
||||
| `story` | 故事線生成 (Parent-Child) |
|
||||
| `yolo` | 物體偵測 (可選) |
|
||||
| `cut` | 場景偵測 (可選) |
|
||||
| `ocr` | 文字辨識 (可選) |
|
||||
| `face` | 人臉偵測 (可選) |
|
||||
| `pose` | 姿態估計 (可選) |
|
||||
|
||||
---
|
||||
|
||||
### Node ⑧: Wait 10 Seconds (輪詢間隔)
|
||||
|
||||
```yaml
|
||||
Node Name: "Wait 10 Seconds"
|
||||
Node Type: "Wait"
|
||||
|
||||
Configuration:
|
||||
Amount: 10
|
||||
Unit: "Seconds"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑨: Check Progress (檢查進度)
|
||||
|
||||
```yaml
|
||||
Node Name: "Check Progress"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: GET
|
||||
URL: "http://localhost:3002/api/v1/progress/{{ $('Register Video').item.json.uuid }}"
|
||||
|
||||
Output:
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"processors": [
|
||||
{"name": "asr", "status": "complete", "message": "1867 segments"},
|
||||
{"name": "asrx", "status": "progress", "message": "ASRX_TRANSCRIBING"},
|
||||
{"name": "story", "status": "pending", "message": ""}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> **注意**: API 現在返回 `file_path`(檔案系統路徑)而非 `media_url`(網頁 URL)。如需在網頁中播放影片,請將檔案路徑轉換為可訪問的 URL(例如透過 SFTPGo 分享連結)。
|
||||
|
||||
---
|
||||
|
||||
### Node ⑩: Log Progress (記錄進度)
|
||||
|
||||
```yaml
|
||||
Node Name: "Log Progress"
|
||||
Node Type: "Code"
|
||||
|
||||
Configuration:
|
||||
Language: "JavaScript"
|
||||
|
||||
Code:
|
||||
```javascript
|
||||
const progress = $input.first().json;
|
||||
const processors = progress.processors;
|
||||
|
||||
const totalProcessors = processors.length;
|
||||
const completedProcessors = processors.filter(p => p.status === 'complete').length;
|
||||
const overallProgress = Math.round((completedProcessors / totalProcessors) * 100);
|
||||
|
||||
const currentProcessor = processors.find(p =>
|
||||
p.status === 'progress' || p.status === 'info'
|
||||
);
|
||||
|
||||
const progressMessage = `
|
||||
═══════════════════════════════════════════════
|
||||
📹 Video RAG Processing: ${overallProgress}%
|
||||
UUID: ${progress.uuid}
|
||||
|
||||
${processors.map(p => {
|
||||
const icon = p.status === 'complete' ? '✅' :
|
||||
p.status === 'progress' || p.status === 'info' ? '🔄' : '⏳';
|
||||
return ` ${icon} ${p.name.padEnd(6)} ${p.message || p.status}`;
|
||||
}).join('\n')}
|
||||
|
||||
${currentProcessor ? `Current: ${currentProcessor.name}` : 'All complete!'}
|
||||
═══════════════════════════════════════════════
|
||||
`.trim();
|
||||
|
||||
console.log(progressMessage);
|
||||
|
||||
return {
|
||||
json: {
|
||||
uuid: progress.uuid,
|
||||
overall_progress: overallProgress,
|
||||
completed_processors: completedProcessors,
|
||||
total_processors: totalProcessors,
|
||||
current_processor: currentProcessor?.name || 'idle',
|
||||
processors: processors,
|
||||
log_message: progressMessage
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
Output:
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"overall_progress": 33,
|
||||
"log_message": "📹 Video RAG Processing: 33%..."
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑪: Is Complete? (判斷分支)
|
||||
|
||||
```yaml
|
||||
Node Name: "Is Complete?"
|
||||
Node Type: "IF"
|
||||
|
||||
Configuration:
|
||||
Condition:
|
||||
$json.processors.every(p => p.status === 'complete')
|
||||
|
||||
Connections:
|
||||
TRUE (完成): → Node ⑫ Natural Language Search
|
||||
FALSE (未完成): → Node ⑧ Wait 10 Seconds (Loop)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑫: Natural Language Search (RAG 搜尋)
|
||||
|
||||
```yaml
|
||||
Node Name: "Natural Language Search"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:3002/api/v1/search"
|
||||
|
||||
Body Content Type: "JSON"
|
||||
|
||||
Body:
|
||||
{
|
||||
"query": "{{ $('Set Variables').item.json.query }}",
|
||||
"limit": 10,
|
||||
"uuid": "{{ $('Register Video').item.json.uuid }}"
|
||||
}
|
||||
|
||||
Output:
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "c_001",
|
||||
"text": "Hello and welcome to the old-time movie show...",
|
||||
"score": 0.92
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑫B: Hybrid Search (Vector + BM25)
|
||||
|
||||
**說明**: 使用混合搜尋,結合向量相似度和全文檢索
|
||||
|
||||
```yaml
|
||||
Node Name: "Hybrid Search"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:3002/api/v1/search/hybrid"
|
||||
|
||||
Body Content Type: "JSON"
|
||||
|
||||
Body:
|
||||
{
|
||||
"query": "{{ $('Set Variables').item.json.query }}",
|
||||
"limit": 10,
|
||||
"uuid": "{{ $('Register Video').item.json.uuid }}",
|
||||
"vector_weight": 0.7,
|
||||
"bm25_weight": 0.3
|
||||
}
|
||||
|
||||
Output:
|
||||
{
|
||||
"query": "What is the movie about?",
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "c_001",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 0.0,
|
||||
"end_time": 5.0,
|
||||
"text": "Hello and welcome to the old-time movie show...",
|
||||
"vector_score": 0.85,
|
||||
"bm25_score": 0.75,
|
||||
"combined_score": 0.80
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**權重建議**:
|
||||
| 查詢類型 | vector_weight | bm25_weight |
|
||||
|----------|---------------|-------------|
|
||||
| 主題查詢 | 0.8 | 0.2 |
|
||||
| 事實查找 | 0.5 | 0.5 |
|
||||
| 平衡查詢 | 0.7 | 0.3 |
|
||||
|
||||
---
|
||||
|
||||
### Node ⑬: Get Media URL (取得媒體連結)
|
||||
|
||||
```yaml
|
||||
Node Name: "Get Media URL"
|
||||
Node Type: "HTTP Request"
|
||||
|
||||
Configuration:
|
||||
Method: POST
|
||||
URL: "http://localhost:3002/api/v1/n8n/search"
|
||||
|
||||
Body Content Type: "JSON"
|
||||
|
||||
Body:
|
||||
{
|
||||
"query": "{{ $('Set Variables').item.json.query }}",
|
||||
"limit": 10,
|
||||
"uuid": "{{ $('Register Video').item.json.uuid }}"
|
||||
}
|
||||
|
||||
Output:
|
||||
{
|
||||
"count": 10,
|
||||
"hits": [
|
||||
{
|
||||
"id": "c_001",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"text": "Hello and welcome to the old-time movie show...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑭: Build Response (組合結果)
|
||||
|
||||
```yaml
|
||||
Node Name: "Build Response"
|
||||
Node Type: "Set"
|
||||
|
||||
Configuration:
|
||||
Keep Only Set: true
|
||||
|
||||
Variables:
|
||||
- Name: "ok"
|
||||
Value: true
|
||||
|
||||
- Name: "uuid"
|
||||
Value: "{{ $('Register Video').item.json.uuid }}"
|
||||
|
||||
- Name: "file_name"
|
||||
Value: "{{ $('Set Variables').item.json.file_name }}"
|
||||
|
||||
- Name: "query"
|
||||
Value: "{{ $('Set Variables').item.json.query }}"
|
||||
|
||||
- Name: "count"
|
||||
Value: "{{ $('Get Media URL').item.json.count }}"
|
||||
|
||||
- Name: "results"
|
||||
Value: "{{ $('Get Media URL').item.json.hits }}"
|
||||
|
||||
- Name: "overall_progress"
|
||||
Value: "{{ $('Log Progress').item.json.overall_progress }}"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Node ⑮: Respond to Webhook (回傳結果)
|
||||
|
||||
```yaml
|
||||
Node Name: "Respond to Webhook"
|
||||
Node Type: "Respond to Webhook"
|
||||
|
||||
Configuration:
|
||||
Respond With: "JSON"
|
||||
|
||||
Response Body:
|
||||
{
|
||||
"ok": true,
|
||||
"uuid": "{{ $json.uuid }}",
|
||||
"file_name": "{{ $json.file_name }}",
|
||||
"query": "{{ $json.query }}",
|
||||
"count": {{ $json.count }},
|
||||
"results": {{ $json.results }},
|
||||
"overall_progress": {{ $json.overall_progress }},
|
||||
"message": "Video RAG completed successfully"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 快速複製所需資訊
|
||||
|
||||
### SFTPGo 設定
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| API Base | `http://localhost:8080/api/v2` |
|
||||
| Demo User | `demo` |
|
||||
| Demo Password | `demopassword123` |
|
||||
| Demo Home | `/Users/accusys/sftpgo_test/demo` |
|
||||
| Token Endpoint | `/api/v2/user/token` |
|
||||
| Upload Endpoint | `/api/v2/user/files` |
|
||||
| Share Endpoint | `/api/v2/user/shares` |
|
||||
|
||||
### Momentry 設定
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| API Base | `http://localhost:3002` |
|
||||
| Authentication | `X-API-Key` header (所有 `/api/v1/*` 端點) |
|
||||
| Register | `POST /api/v1/register` |
|
||||
| Progress | `GET /api/v1/progress/{uuid}` |
|
||||
| Search | `POST /api/v1/search` |
|
||||
| n8n Search | `POST /api/v1/n8n/search` |
|
||||
| Hybrid Search | `POST /api/v1/search/hybrid` |
|
||||
| Media Base | `https://wp.momentry.ddns.net` (僅供參考,API 返回 `file_path` 而非 URL) |
|
||||
|
||||
### Demo 測試資料
|
||||
|
||||
**Charade (1963) Demo Video**
|
||||
- UUID: `a1b10138a6bbb0cd`
|
||||
- 位置: `/Users/accusys/test_video/Old_Time_Movie_Show_-_Charade_1963.HD.mov`
|
||||
- 時長: 6872 秒 (~1.9 小時)
|
||||
|
||||
**已處理檔案**:
|
||||
| 檔案 | 大小 | 內容 |
|
||||
|------|------|------|
|
||||
| `asr.json` | 210KB | 1867 語音區段 |
|
||||
| `cut.json` | 220KB | 1331 場景 |
|
||||
| `story.json` | 1.8MB | 641 父子區塊 |
|
||||
| `transcript.txt` | 40KB | 可讀文字稿 |
|
||||
|
||||
**Output 目錄**: `/Users/accusys/momentry_core_0.1/output`
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 日期 | 版本 | 變更 |
|
||||
|------|------|------|
|
||||
| 2026-03-22 | v1.0 | 初始建立 |
|
||||
| 2026-03-22 | v1.1 | 新增 Hybrid Search (Vector + BM25) 節點 |
|
||||
| 2026-03-22 | v1.2 | 簡化為只處理 ASR、ASRX、STORY 模組 |
|
||||
@@ -1,289 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n HTTP Request Node 設定指南"
|
||||
date: "2026-03-26"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "http"
|
||||
- "設定指南"
|
||||
- "request"
|
||||
- "node"
|
||||
ai_query_hints:
|
||||
- "查詢 n8n HTTP Request Node 設定指南 的內容"
|
||||
- "n8n HTTP Request Node 設定指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 n8n HTTP Request Node 設定指南?"
|
||||
---
|
||||
|
||||
# n8n HTTP Request Node 設定指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-26 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-26 | 新增 API Key 驗證說明,更新 curl 範例 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
> **API URL 說明**:
|
||||
> - **本地測試**: `http://localhost:3002`
|
||||
> - **n8n workflow**: `https://api.momentry.ddns.net`
|
||||
>
|
||||
> ⚠️ 在 n8n 中請使用 `api.momentry.ddns.net`,不要使用 `localhost:3002`
|
||||
|
||||
---
|
||||
|
||||
## 錯誤排除
|
||||
|
||||
### 錯誤訊息: "Your request is invalid or could not be processed by the service"
|
||||
|
||||
這通常表示 HTTP Request Node 的設定不正確。
|
||||
|
||||
---
|
||||
|
||||
## 正確的 Node 設定方式
|
||||
|
||||
### 方法 1: 使用 JSON Body (推薦)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 方法 2: 使用 Raw Body + Headers
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Specify Body: Using JSON
|
||||
├── JSON Body:
|
||||
│ {
|
||||
│ "query": "charade",
|
||||
│ "limit": 3
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
├── Content-Type: application/json
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 方法 3: 最簡單的 Hardcoded 測試
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Send Body: ✓
|
||||
├── Content Type: JSON
|
||||
└── Body:
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤與解決
|
||||
|
||||
### ❌ 錯誤 1: Body 格式錯誤
|
||||
|
||||
**錯誤設定:**
|
||||
```
|
||||
Body Parameters:
|
||||
query = {{ $json.query }}
|
||||
limit = {{ $json.limit }}
|
||||
```
|
||||
|
||||
**正確設定:**
|
||||
```
|
||||
Content Type: JSON
|
||||
Body:
|
||||
{
|
||||
"query": "={{ $json.query }}",
|
||||
"limit": "={{ $json.limit }}"
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ 錯誤 2: 缺少引號
|
||||
|
||||
**錯誤:**
|
||||
```json
|
||||
{
|
||||
query: "charade",
|
||||
limit: 3
|
||||
}
|
||||
```
|
||||
|
||||
**正確:**
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ 錯誤 3: URL 錯誤
|
||||
|
||||
**錯誤:**
|
||||
```
|
||||
URL: http://localhost:3002/api/v1/n8n/search
|
||||
```
|
||||
|
||||
**正確:**
|
||||
```
|
||||
URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 測試步驟
|
||||
|
||||
### 步驟 1: 創建最簡單的測試
|
||||
|
||||
1. 新建工作流程
|
||||
2. 添加 **Manual Trigger** Node
|
||||
3. 添加 **HTTP Request** Node
|
||||
4. 設定如下:
|
||||
- URL: `https://api.momentry.ddns.net/api/v1/n8n/search`
|
||||
- Method: POST
|
||||
- Send Body: ✓
|
||||
- Content Type: JSON
|
||||
- Body: `{"query": "charade", "limit": 2}`
|
||||
|
||||
### 步驟 2: 執行測試
|
||||
|
||||
1. 點擊 **Execute Workflow**
|
||||
2. 查看 HTTP Request Node 的輸出
|
||||
3. 應該看到 JSON 回應
|
||||
|
||||
### 步驟 3: 確認成功
|
||||
|
||||
成功的回應應該包含:
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 2,
|
||||
"hits": [...]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 直接複製使用的工作流程 JSON
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Video Search - Working Example",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "When clicking \"Execute Workflow\"",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"typeVersion": 1,
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
},
|
||||
"options": {}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"typeVersion": 4.1,
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"When clicking \"Execute Workflow\"": {
|
||||
"main": [
|
||||
[
|
||||
{
|
||||
"node": "Search Video API",
|
||||
"type": "main",
|
||||
"index": 0
|
||||
}
|
||||
]
|
||||
]
|
||||
}
|
||||
},
|
||||
"settings": {
|
||||
"executionOrder": "v1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**導入方式:**
|
||||
1. 在 n8n UI 中,點擊左上角的 Menu
|
||||
2. 選擇 **Import from File**
|
||||
3. 選擇上面的 JSON 文件
|
||||
|
||||
---
|
||||
|
||||
## 驗證 API 可用性
|
||||
|
||||
在終端機測試:
|
||||
```bash
|
||||
# 需要 API Key 驗證 (設定環境變數或直接替換)
|
||||
export MOMENTRY_API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: $MOMENTRY_API_KEY" \
|
||||
-d '{"query":"charade","limit":2}'
|
||||
```
|
||||
|
||||
如果 curl 成功但 n8n 失敗,問題在於 n8n HTTP Request Node 的設定。
|
||||
|
||||
---
|
||||
|
||||
## 需要幫助?
|
||||
|
||||
如果仍然無法工作:
|
||||
1. 開啟工作流程
|
||||
2. 點擊 HTTP Request Node
|
||||
3. 點擊右上角的 **Execute Node** 單獨執行
|
||||
4. 查看錯誤訊息的詳細內容
|
||||
5. 檢查 Network tab 中的 request/response
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽(起點)
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 快速使用指南
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
@@ -1,593 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "Momentry n8n 整合使用手冊"
|
||||
date: "2026-03-23"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "整合使用手冊"
|
||||
- "momentry"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry n8n 整合使用手冊 的內容"
|
||||
- "Momentry n8n 整合使用手冊 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry n8n 整合使用手冊?"
|
||||
---
|
||||
|
||||
# Momentry n8n 整合使用手冊
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建 n8n 整合手冊 | Warren | OpenCode |
|
||||
| V1.1 | 2026-03-23 | 新增 API Key 驗證與完整工作流範例 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
**目標讀者**: n8n 使用者、DevOps
|
||||
|
||||
---
|
||||
|
||||
## 目錄
|
||||
|
||||
1. [概述](#1-概述)
|
||||
2. [前置作業](#2-前置作業)
|
||||
3. [建立 n8n API Key](#3-建立-n8n-api-key)
|
||||
4. [在 n8n 中使用 Momentry API](#4-在-n8n-中使用-momentry-api)
|
||||
5. [工作流範例](#5-工作流範例)
|
||||
6. [常見問題](#6-常見問題)
|
||||
|
||||
---
|
||||
|
||||
## 1. 概述
|
||||
|
||||
### 1.1 什麼是 n8n?
|
||||
|
||||
n8n 是一個開源的工作流自動化工具,可以連接各種服務和 API。
|
||||
|
||||
### 1.2 為什麼需要整合?
|
||||
|
||||
| 場景 | 說明 |
|
||||
|------|------|
|
||||
| 自動化影片處理 | 新影片上傳時自動觸發處理流程 |
|
||||
| 監控告警 | API Key 異常時發送通知 |
|
||||
| 定時備份 | 定期備份 API Key 資料 |
|
||||
| 跨系統同步 | 與其他系統同步 API Key 狀態 |
|
||||
|
||||
### 1.3 架構圖
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ 觸發器 │────▶│ n8n 工作流 │────▶│ Momentry │
|
||||
│ (Webhook/ │ │ (處理邏輯) │ │ API │
|
||||
│ Cron) │ └─────────────┘ └─────────────┘
|
||||
└─────────────┘ │ │
|
||||
│ │
|
||||
▼ ▼
|
||||
┌─────────────┐ ┌─────────────┐
|
||||
│ 通知 │ │ 動作 │
|
||||
│ (Slack/Email)│ │ (建立/查詢) │
|
||||
└─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 1.4 API URL 選擇
|
||||
|
||||
| 環境 | URL | 說明 |
|
||||
|------|-----|------|
|
||||
| **本地測試** | `http://localhost:3002` | 直接訪問 API |
|
||||
| **n8n workflow** | `https://api.momentry.ddns.net` | 通過反向代理 |
|
||||
|
||||
> ⚠️ **重要**: 在 n8n HTTP Request Node 中,請使用 `https://api.momentry.ddns.net` 而非 `localhost:3002`,因為 n8n 需要從外部訪問 API。
|
||||
|
||||
**本地測試時**:
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**n8n Workflow 中**:
|
||||
```
|
||||
URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. 前置作業
|
||||
|
||||
### 2.1 確認服務狀態
|
||||
|
||||
```bash
|
||||
# 檢查 Momentry API
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 檢查 n8n
|
||||
curl https://n8n.momentry.ddns.net/api/v1/workflows \
|
||||
-H "X-N8N-API-KEY: your-api-key"
|
||||
```
|
||||
|
||||
### 2.2 取得 n8n API Key
|
||||
|
||||
#### 方式 A: 透過 Momentry CLI
|
||||
|
||||
```bash
|
||||
# 建立 n8n API Key
|
||||
momentry n8n create \
|
||||
--api-key "your-existing-n8n-api-key" \
|
||||
--label "momentry-integration" \
|
||||
--expires-in-days 90
|
||||
|
||||
# 輸出:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# API Key: eyJhbGciOiJIUzI1NiIs...
|
||||
```
|
||||
|
||||
#### 方式 B: 透過 n8n 介面
|
||||
|
||||
1. 登入 n8n: https://n8n.momentry.ddns.net
|
||||
2. 前往 Settings → n8n API
|
||||
3. 點擊「Create an API Key」
|
||||
4. 複製 API Key
|
||||
|
||||
### 2.3 設定環境變數
|
||||
|
||||
在 n8n 中設定以下環境變數:
|
||||
|
||||
| 變數名稱 | 值 | 說明 |
|
||||
|----------|-----|------|
|
||||
| `MOMENTRY_API_URL` | `http://localhost:3002` | Momentry API URL |
|
||||
| `MOMENTRY_API_KEY` | `your-api-key` | Momentry API Key |
|
||||
|
||||
---
|
||||
|
||||
## 3. 建立 n8n API Key
|
||||
|
||||
### 3.1 CLI 命令
|
||||
|
||||
```bash
|
||||
# 基本建立
|
||||
momentry n8n create \
|
||||
--api-key <existing-n8n-key> \
|
||||
--label <key-name>
|
||||
|
||||
# 設定過期時間
|
||||
momentry n8n create \
|
||||
--api-key <existing-n8n-key> \
|
||||
--label "ci-pipeline" \
|
||||
--expires-in-days 30
|
||||
```
|
||||
|
||||
### 3.2 範例:建立監控用 Key
|
||||
|
||||
```bash
|
||||
momentry n8n create \
|
||||
--api-key "n8n_api_1234567890" \
|
||||
--label "monitoring-key" \
|
||||
--expires-in-days 180
|
||||
|
||||
# 輸出:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# Key ID: abc123-def456
|
||||
# Label: monitoring-key
|
||||
# API Key: eyJhbGciOiJIUz...
|
||||
```
|
||||
|
||||
### 3.3 列出已建立的 Key
|
||||
|
||||
```bash
|
||||
momentry n8n list --api-key <existing-n8n-key>
|
||||
|
||||
# 輸出:
|
||||
# 📋 n8n API Keys
|
||||
# ┌────────────────────────────────────────────────────────────────────────────┐
|
||||
# │ Label │ ID │
|
||||
# ├────────────────────────────────────────────────────────────────────────────┤
|
||||
# │ monitoring-key │ abc123-def456 │
|
||||
# │ ci-pipeline │ xyz789-abc123 │
|
||||
# └────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 在 n8n 中使用 Momentry API
|
||||
|
||||
> ⚠️ **注意**: API Key 管理端點 (`/api/v1/api-keys/*`) 目前仍在規劃中,尚未實作。以下為規劃中的 API 說明。
|
||||
|
||||
### 4.1 設定 HTTP Request 節點
|
||||
|
||||
```
|
||||
Method: POST
|
||||
URL: {{ $env.MOMENTRY_API_URL }}/api/v1/api-keys
|
||||
Headers:
|
||||
X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
Content-Type: application/json
|
||||
Body:
|
||||
{
|
||||
"name": "auto-generated-key",
|
||||
"key_type": "service",
|
||||
"ttl_days": 90
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 可用的 API 端點
|
||||
|
||||
> ⚠️ **API Key 管理端點為規劃功能,目前尚未實作**
|
||||
|
||||
#### 已實作端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋 |
|
||||
| POST | `/api/v1/n8n/search` | n8n 格式搜尋 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
|
||||
#### 規劃中端點 *(尚未實作)*
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/api/v1/api-keys` | 列出所有 API Keys |
|
||||
| POST | `/api/v1/api-keys` | 建立新的 API Key |
|
||||
| DELETE | `/api/v1/api-keys/{id}` | 刪除 API Key |
|
||||
| POST | `/api/v1/api-keys/{id}/rotate` | 請求 Key 輪換 |
|
||||
|
||||
---
|
||||
|
||||
## 5. 工作流範例
|
||||
|
||||
### 範例 1:定時檢查 API Key 狀態
|
||||
|
||||
**目的**: 每天早上 9 點檢查即將過期的 API Keys
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Filter │────▶│ Slack │
|
||||
│ (每天 9AM) │ │ Request │ │ (7天內過期) │ │ 通知 │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Filter 設定**:
|
||||
|
||||
```javascript
|
||||
// 檢查是否在 7 天內過期
|
||||
const expiresAt = new Date($json.expires_at);
|
||||
const now = new Date();
|
||||
const sevenDaysLater = new Date(now.getTime() + 7 * 24 * 60 * 60 * 1000);
|
||||
|
||||
return expiresAt <= sevenDaysLater && expiresAt > now;
|
||||
```
|
||||
|
||||
**Slack 通知格式**:
|
||||
|
||||
```
|
||||
⚠️ API Key 即將過期提醒
|
||||
|
||||
以下 API Key 將在 7 天內過期:
|
||||
{{ $json.map(k => `• ${k.name} (${k.key_id}) - 過期時間: ${k.expires_at}`).join('\n') }}
|
||||
|
||||
請及時處理!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 2:新影片上傳時自動建立 API Key
|
||||
|
||||
**目的**: 當有新影片上傳時,自動為該影片建立專用 API Key
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Webhook │────▶│ HTTP │────▶│ Set │────▶│ Respond │
|
||||
│ 觸發器 │ │ Request │ │ (組裝回應) │ │ Webhook │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Webhook 設定**:
|
||||
|
||||
```
|
||||
Method: POST
|
||||
Path: /new-video
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "POST",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
},
|
||||
"body": {
|
||||
"name": "video-{{ $json.video_id }}",
|
||||
"key_type": "service",
|
||||
"permissions": ["read"],
|
||||
"ttl_days": 30
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**回應格式**:
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"video_id": "{{ $json.video_id }}",
|
||||
"api_key_id": "{{ $json.key_id }}",
|
||||
"message": "API Key 已建立"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 3:API Key 異常告警
|
||||
|
||||
**目的**: 監控 API Key 異常使用,發送告警通知
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Webhook │────▶│ Switch │────▶│ Email │ │ Slack │
|
||||
│ (異常通知) │ │ (嚴重程度) │────▶│ 通知 │ │ 通知 │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Webhook 觸發設定** (在 Momentry 中):
|
||||
|
||||
```bash
|
||||
export WEBHOOK_URL="https://n8n.momentry.ddns.net/webhook/anomaly-alert"
|
||||
export WEBHOOK_EVENTS="anomaly_detected,rate_limited,ip_blocked"
|
||||
```
|
||||
|
||||
**Switch 節點設定**:
|
||||
|
||||
```javascript
|
||||
// 根據嚴重程度分流
|
||||
switch ($json.data.severity) {
|
||||
case 'critical':
|
||||
return 0; // Email + Slack
|
||||
case 'high':
|
||||
return 1; // Slack only
|
||||
default:
|
||||
return 2; // Log only
|
||||
}
|
||||
```
|
||||
|
||||
**Email 通知格式**:
|
||||
|
||||
```
|
||||
Subject: [{{ $json.data.severity }}] API Key 異常告警 - {{ $json.data.key_id }}
|
||||
|
||||
Dear Admin,
|
||||
|
||||
偵測到 API Key 異常使用:
|
||||
|
||||
Key ID: {{ $json.data.key_id }}
|
||||
異常類型: {{ $json.data.anomaly_type }}
|
||||
嚴重程度: {{ $json.data.severity }}
|
||||
時間: {{ $json.timestamp }}
|
||||
|
||||
請立即檢查系統狀態。
|
||||
|
||||
Best regards,
|
||||
Momentry Monitoring
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 4:定時備份 API Key 統計
|
||||
|
||||
**目的**: 每週一早上備份 API Key 統計報表
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Google │
|
||||
│ (每週一) │ │ Request │ │ Sheets │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys/stats",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Google Sheets 設定**:
|
||||
|
||||
```
|
||||
Spreadsheet: Momentry API Key Reports
|
||||
Sheet: Weekly Stats
|
||||
Append Row:
|
||||
- Date: {{ $now }}
|
||||
- Total Keys: {{ $json.total_keys }}
|
||||
- Active Keys: {{ $json.active_keys }}
|
||||
- Expired Keys: {{ $json.expired_keys }}
|
||||
- Anomalies (24h): {{ $json.anomalies_last_24h }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 5:自動輪換即將過期的 Key
|
||||
|
||||
**目的**: 自動為即將過期的 Key 請求輪換
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Filter │────▶│ HTTP │
|
||||
│ (每天) │ │ (取得 Keys) │ │ (即將過期) │ │ (請求輪換) │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**第一個 HTTP Request (取得 Keys)**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Filter 設定**:
|
||||
|
||||
```javascript
|
||||
// 14 天內過期且未請求輪換的 Key
|
||||
const expiresAt = new Date($json.expires_at);
|
||||
const now = new Date();
|
||||
const fourteenDaysLater = new Date(now.getTime() + 14 * 24 * 60 * 60 * 1000);
|
||||
|
||||
return expiresAt <= fourteenDaysLater &&
|
||||
!$json.rotation_required &&
|
||||
$json.status === 'active';
|
||||
```
|
||||
|
||||
**第二個 HTTP Request (請求輪換)**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "POST",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys/{{ $json.key_id }}/rotate",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
},
|
||||
"body": {
|
||||
"reason": "auto_rotation_approaching_expiry"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 常見問題
|
||||
|
||||
### Q1: n8n 無法連接到 Momentry API
|
||||
|
||||
**檢查項目**:
|
||||
|
||||
```bash
|
||||
# 1. 確認 API 是否運行
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 2. 確認 API Key 是否有效
|
||||
momentry api-key validate --key "your-key"
|
||||
|
||||
# 3. 檢查防火牆設定
|
||||
nc -zv localhost 3002
|
||||
```
|
||||
|
||||
### Q2: API Key 建立失敗
|
||||
|
||||
**可能原因**:
|
||||
- API Key 已存在
|
||||
- 權限不足
|
||||
- 格式錯誤
|
||||
|
||||
**解決方式**:
|
||||
|
||||
```bash
|
||||
# 檢查現有 Keys
|
||||
momentry api-key list
|
||||
|
||||
# 使用不同的 label
|
||||
momentry n8n create --api-key "..." --label "unique-label-$(date +%s)"
|
||||
```
|
||||
|
||||
### Q3: Webhook 通知沒有收到
|
||||
|
||||
**檢查項目**:
|
||||
|
||||
```bash
|
||||
# 1. 確認 Webhook URL 設定
|
||||
echo $WEBHOOK_URL
|
||||
|
||||
# 2. 測試 Webhook
|
||||
curl -X POST $WEBHOOK_URL \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"test": true}'
|
||||
|
||||
# 3. 檢查 n8n 工作流是否啟用
|
||||
# 登入 n8n → 檢查工作流狀態
|
||||
```
|
||||
|
||||
### Q4: 如何撤銷 n8n API Key
|
||||
|
||||
```bash
|
||||
# 列出所有 Keys
|
||||
momentry n8n list --api-key "your-admin-key"
|
||||
|
||||
# 刪除指定 Key
|
||||
momentry n8n delete \
|
||||
--api-key "your-admin-key" \
|
||||
--label "key-to-delete"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. n8n 工作流匯出
|
||||
|
||||
將上述範例工作流匯入 n8n:
|
||||
|
||||
1. 複製工作流 JSON
|
||||
2. 登入 n8n
|
||||
3. 點擊「+」→「Import from File」
|
||||
4. 貼上 JSON 並儲存
|
||||
|
||||
### B. 環境變數總覽
|
||||
|
||||
```bash
|
||||
# Momentry
|
||||
MOMENTRY_API_URL=http://localhost:3002
|
||||
MOMENTRY_API_KEY=your-api-key
|
||||
|
||||
# n8n
|
||||
N8N_URL=https://n8n.momentry.ddns.net
|
||||
N8N_API_KEY=your-n8n-api-key
|
||||
|
||||
# Webhook
|
||||
WEBHOOK_URL=https://n8n.momentry.ddns.net/webhook/alerts
|
||||
WEBHOOK_SECRET=your-secret
|
||||
WEBHOOK_EVENTS=anomaly_detected,key_expired,key_revoked
|
||||
```
|
||||
|
||||
### C. 相關文件
|
||||
|
||||
| 文件 | 說明 |
|
||||
|------|------|
|
||||
| [API_INDEX.md](./API_INDEX.md) | 文件總覽(起點) |
|
||||
| [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) | n8n 快速使用指南 |
|
||||
| `docs_v1.0/REFERENCE/API_KEY_MANAGEMENT.md` | API Key 管理系統設計 |
|
||||
| `docs_v1.0/ARCHITECTURE/API_KEY_ARCHITECTURE.md` | 系統架構圖 |
|
||||
| `docs_v1.0/IMPLEMENTATION/API_KEY_INTEGRATION_TESTS.md` | 整合測試文件 |
|
||||
@@ -1,245 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "OpenCode n8n MCP 整合設定"
|
||||
date: "2026-03-23"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "opencode"
|
||||
- "整合設定"
|
||||
ai_query_hints:
|
||||
- "查詢 OpenCode n8n MCP 整合設定 的內容"
|
||||
- "OpenCode n8n MCP 整合設定 的主要目的是什麼?"
|
||||
- "如何操作或實施 OpenCode n8n MCP 整合設定?"
|
||||
---
|
||||
|
||||
# OpenCode n8n MCP 整合設定
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建 n8n MCP 整合設定文件 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
> 建立時間: 2026-03-23
|
||||
> 更新時間: 2026-03-23
|
||||
|
||||
---
|
||||
|
||||
## n8n MCP 工具列表 (43 個)
|
||||
|
||||
### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_workflows` | 列出所有 workflows |
|
||||
| `n8n_get_workflow` | 取得 workflow 詳情 |
|
||||
| `n8n_create_workflow` | 建立新 workflow |
|
||||
| `n8n_update_workflow` | 更新 workflow |
|
||||
| `n8n_delete_workflow` | 刪除 workflow |
|
||||
| `n8n_activate_workflow` | 啟用 workflow |
|
||||
| `n8n_deactivate_workflow` | 停用 workflow |
|
||||
| `n8n_execute_workflow` | 執行 workflow |
|
||||
| `n8n_get_workflow_tags` | 取得 workflow 標籤 |
|
||||
| `n8n_update_workflow_tags` | 更新 workflow 標籤 |
|
||||
|
||||
### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_executions` | 列出執行記錄 |
|
||||
| `n8n_get_execution` | 取得執行詳情 |
|
||||
| `n8n_delete_execution` | 刪除執行記錄 |
|
||||
|
||||
### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_datatables` | 列出資料表 |
|
||||
| `n8n_create_datatable` | 建立資料表 |
|
||||
| `n8n_get_datatable` | 取得資料表結構 |
|
||||
| `n8n_get_datatable_rows` | 取得資料表列 |
|
||||
| `n8n_insert_datatable_rows` | 插入資料列 |
|
||||
| `n8n_update_datatable_rows` | 更新資料列 |
|
||||
| `n8n_upsert_datatable_row` | 插入或更新資料列 |
|
||||
| `n8n_delete_datatable_rows` | 刪除資料列 |
|
||||
|
||||
### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_tags` | 列出所有標籤 |
|
||||
| `n8n_get_tag` | 取得標籤 |
|
||||
| `n8n_create_tag` | 建立標籤 |
|
||||
| `n8n_update_tag` | 更新標籤 |
|
||||
| `n8n_delete_tag` | 刪除標籤 |
|
||||
|
||||
### Credentials (4)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_credentials` | 列出憑證 |
|
||||
| `n8n_create_credential` | 建立憑證 |
|
||||
| `n8n_delete_credential` | 刪除憑證 |
|
||||
| `n8n_get_credential_schema` | 取得憑證 schema |
|
||||
|
||||
### Users (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_users` | 列出使用者 |
|
||||
| `n8n_get_user` | 取得使用者 |
|
||||
| `n8n_delete_user` | 刪除使用者 |
|
||||
|
||||
### Variables (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_variables` | 列出變數 |
|
||||
| `n8n_create_variable` | 建立變數 |
|
||||
| `n8n_delete_variable` | 刪除變數 |
|
||||
|
||||
### 其他 (7)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_projects` | 列出專案 |
|
||||
| `n8n_create_project` | 建立專案 |
|
||||
| `n8n_update_project` | 更新專案 |
|
||||
| `n8n_delete_project` | 刪除專案 |
|
||||
| `n8n_generate_audit` | 產生安全審計報告 |
|
||||
| `n8n_health_check` | 健康檢查 |
|
||||
| `n8n_trigger_webhook` | 觸發 webhook |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### 1. 安裝 n8n MCP Server
|
||||
|
||||
```bash
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
```
|
||||
|
||||
驗證:
|
||||
```bash
|
||||
which mcp-n8n
|
||||
# /opt/homebrew/bin/mcp-n8n
|
||||
```
|
||||
|
||||
### 2. 取得 n8n API Key
|
||||
|
||||
1. 開啟 n8n UI: `http://localhost:5678`
|
||||
2. 登入後點擊右上角 **Settings** → **API**
|
||||
3. 點擊 **Create New API Key**
|
||||
4. 複製產生的 key
|
||||
|
||||
### 3. 設定 OpenCode MCP 設定檔
|
||||
|
||||
建立或編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 驗證 MCP 運作
|
||||
|
||||
重啟 OpenCode,確認 n8n MCP tools 可用。
|
||||
|
||||
---
|
||||
|
||||
## n8n API 端點
|
||||
|
||||
n8n v2 REST API 路徑為 `/rest/`(不是 `/api/v1/`)
|
||||
|
||||
| 端點 | 方法 | 說明 |
|
||||
|------|------|------|
|
||||
| `/rest/workflows` | GET | 列出 workflows |
|
||||
| `/rest/workflows/:id` | GET | 取得 workflow |
|
||||
| `/rest/workflows` | POST | 建立 workflow |
|
||||
| `/rest/workflows/:id` | PUT | 更新 workflow |
|
||||
| `/rest/workflows/:id` | DELETE | 刪除 workflow |
|
||||
| `/rest/workflows/:id/activate` | POST | 啟用 workflow |
|
||||
| `/rest/workflows/:id/deactivate` | POST | 停用 workflow |
|
||||
| `/rest/workflows/:id/execute` | POST | 執行 workflow |
|
||||
|
||||
**認證方式:**
|
||||
```bash
|
||||
curl -H "X-N8N-API-KEY: YOUR_API_KEY" \
|
||||
http://localhost:5678/rest/workflows
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 疑難排解
|
||||
|
||||
### API 404 問題
|
||||
|
||||
如果 API 傳回 404,檢查:
|
||||
|
||||
1. **n8n 是否運行中**
|
||||
```bash
|
||||
curl http://localhost:5678
|
||||
```
|
||||
|
||||
2. **n8n 初始設定(重要!)**
|
||||
- 第一次使用必須在瀏覽器完成初始化
|
||||
- 開啟 `http://localhost:5678`
|
||||
- 按照畫面指示建立管理員帳號
|
||||
- 完成後才能使用 API
|
||||
|
||||
3. **API Key 是否正確**
|
||||
```bash
|
||||
curl -H "X-N8N-API-KEY: YOUR_KEY" \
|
||||
http://localhost:5678/rest/workflows
|
||||
```
|
||||
|
||||
### n8n 初始設定(第一次使用)
|
||||
|
||||
1. 開啟瀏覽器: `http://localhost:5678`
|
||||
2. 輸入 email 和密碼建立管理員帳號
|
||||
3. 完成後進入 Settings → API
|
||||
4. 建立 API Key 並複製
|
||||
|
||||
### CLI Import vs PostgreSQL
|
||||
|
||||
n8n 使用 PostgreSQL 儲存資料:
|
||||
- CLI `n8n import:workflow` 可能寫入 SQLite
|
||||
- 手動在 UI import 會寫入 PostgreSQL
|
||||
|
||||
建議直接使用 UI 或 MCP import。
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OPENCODE_GUIDE.md](./OPENCODE_GUIDE.md) - OpenCode 使用規範
|
||||
- [INSTALL_N8N.md](./INSTALL_N8N.md) - n8n 安裝指南
|
||||
- [N8N_DEMO_WORKFLOW.md](./N8N_DEMO_WORKFLOW.md) - n8n Workflow 範例
|
||||
@@ -1,194 +0,0 @@
|
||||
# n8n MCP 整合測試報告
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建測試報告 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 測試日期
|
||||
2026-03-23
|
||||
|
||||
## 測試環境
|
||||
- **n8n Version**: 2.3.5
|
||||
- **n8n URL**: http://localhost:5678
|
||||
- **MCP Server**: @nextoolsolutions/mcp-n8n v2.0.0
|
||||
- **OpenCode Config**: ~/.config/opencode/opencode.json
|
||||
|
||||
## 測試結果
|
||||
|
||||
### ✅ 所有測試通過
|
||||
|
||||
| 測試項目 | 狀態 | 詳細說明 |
|
||||
|---------|------|---------|
|
||||
| MCP 伺服器初始化 | ✅ 通過 | Protocol version 2024-11-05 |
|
||||
| 工具列表載入 | ✅ 通過 | 43 個工具可用 |
|
||||
| 工具呼叫 (list_workflows) | ✅ 通過 | 成功返回 5 個 workflows |
|
||||
| API 連線 | ✅ 通過 | http://localhost:5678 |
|
||||
|
||||
## 可用工具 (43 個)
|
||||
|
||||
### Workflows (10)
|
||||
- `n8n_list_workflows` - 列出所有工作流程
|
||||
- `n8n_get_workflow` - 取得工作流程詳情
|
||||
- `n8n_create_workflow` - 建立新工作流程
|
||||
- `n8n_update_workflow` - 更新工作流程
|
||||
- `n8n_delete_workflow` - 刪除工作流程
|
||||
- `n8n_activate_workflow` - 啟動工作流程
|
||||
- `n8n_deactivate_workflow` - 停止工作流程
|
||||
- `n8n_execute_workflow` - 執行工作流程
|
||||
- `n8n_get_workflow_tags` - 取得工作流程標籤
|
||||
- `n8n_update_workflow_tags` - 更新工作流程標籤
|
||||
|
||||
### Executions (3)
|
||||
- `n8n_list_executions` - 列出執行記錄
|
||||
- `n8n_get_execution` - 取得執行詳情
|
||||
- `n8n_delete_execution` - 刪除執行記錄
|
||||
|
||||
### Data Tables (6)
|
||||
- `n8n_list_datatables` - 列出資料表
|
||||
- `n8n_create_datatable` - 建立資料表
|
||||
- `n8n_get_datatable` - 取得資料表
|
||||
- `n8n_get_datatable_rows` - 查詢資料表資料
|
||||
- `n8n_insert_datatable_rows` - 插入資料
|
||||
- `n8n_update_datatable_rows` - 更新資料
|
||||
- `n8n_upsert_datatable_row` - 更新或插入
|
||||
- `n8n_delete_datatable_rows` - 刪除資料
|
||||
|
||||
### Tags (5)
|
||||
- `n8n_list_tags` - 列出標籤
|
||||
- `n8n_get_tag` - 取得標籤
|
||||
- `n8n_create_tag` - 建立標籤
|
||||
- `n8n_update_tag` - 更新標籤
|
||||
- `n8n_delete_tag` - 刪除標籤
|
||||
|
||||
### Credentials (4)
|
||||
- `n8n_list_credentials` - 列出認證
|
||||
- `n8n_create_credential` - 建立認證
|
||||
- `n8n_delete_credential` - 刪除認證
|
||||
- `n8n_get_credential_schema` - 取得認證結構
|
||||
|
||||
### Users (3)
|
||||
- `n8n_list_users` - 列出使用者
|
||||
- `n8n_get_user` - 取得使用者
|
||||
- `n8n_delete_user` - 刪除使用者
|
||||
|
||||
### Variables (3)
|
||||
- `n8n_list_variables` - 列出變數
|
||||
- `n8n_create_variable` - 建立變數
|
||||
- `n8n_delete_variable` - 刪除變數
|
||||
|
||||
### Projects (4)
|
||||
- `n8n_list_projects` - 列出專案
|
||||
- `n8n_create_project` - 建立專案
|
||||
- `n8n_update_project` - 更新專案
|
||||
- `n8n_delete_project` - 刪除專案
|
||||
|
||||
### System (3)
|
||||
- `n8n_generate_audit` - 產生安全稽核報告
|
||||
- `n8n_health_check` - 健康檢查
|
||||
- `n8n_trigger_webhook` - 觸發 Webhook
|
||||
|
||||
## 配置檔案
|
||||
|
||||
### ~/.config/opencode/opencode.json
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 測試範例
|
||||
|
||||
### 列出工作流程
|
||||
```bash
|
||||
# 使用 curl
|
||||
curl -H "X-N8N-API-KEY: <API_KEY>" http://localhost:5678/api/v1/workflows
|
||||
|
||||
# 使用 MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"n8n_list_workflows","arguments":{"limit":5}}}' | mcp-n8n
|
||||
```
|
||||
|
||||
### 建立工作流程
|
||||
```bash
|
||||
# 使用 curl
|
||||
curl -X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-N8N-API-KEY: <API_KEY>" \
|
||||
-d '{"name":"My Workflow","nodes":[],"connections":{}}' \
|
||||
http://localhost:5678/api/v1/workflows
|
||||
|
||||
# 使用 MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"n8n_create_workflow","arguments":{"workflow":{"name":"My Workflow","nodes":[],"connections":{}}}}' | mcp-n8n
|
||||
```
|
||||
|
||||
## 現有工作流程 (範例)
|
||||
|
||||
測試中成功讀取的工作流程:
|
||||
|
||||
1. **Diagnostic: Environment Test** (ID: 4vaf6dKznkTccuyC)
|
||||
- 狀態: Active
|
||||
- 用途: 環境測試與時間同步驗證
|
||||
|
||||
2. **Simple Test Webhook v2** (ID: 38bbM14sGo0eVCuW)
|
||||
- 狀態: Active
|
||||
- 用途: Webhook 測試
|
||||
|
||||
3. **HL Chat Searching - RAG Only** (ID: 6Y9c7mGtye4DjuENR5Kbg)
|
||||
- 狀態: Inactive
|
||||
- 用途: RAG 聊天搜尋整合
|
||||
|
||||
4. **HL Embedding with AccusysDB** (ID: 61nRs3BeNGlBtuYJFLSFn)
|
||||
- 狀態: Inactive
|
||||
- 用途: Qdrant 向量資料庫嵌入
|
||||
|
||||
5. **HL Embedding with AccusysDB (local)** (ID: 017oYPE7cDpvybAn)
|
||||
- 狀態: Archived
|
||||
- 用途: 本地測試版本
|
||||
|
||||
## 結論
|
||||
|
||||
✅ **n8n MCP 整合測試全部通過!**
|
||||
|
||||
MCP 伺服器已成功配置並運作,可以透過 OpenCode 使用所有 43 個 n8n 管理工具。
|
||||
|
||||
### 建議用途
|
||||
1. **自動化工作流程管理** - 使用 AI 協助建立、修改、監控工作流程
|
||||
2. **批次執行** - 透過 MCP 批量管理工作流程
|
||||
3. **監控與稽核** - 自動化執行記錄檢視與安全稽核
|
||||
4. **整合測試** - 與 Momentry Core Video RAG 整合測試
|
||||
|
||||
### 下一步
|
||||
- 使用 OpenCode 建立 Video RAG 整合工作流程
|
||||
- 設定自動化監控與告警
|
||||
- 建立工作流程模板庫
|
||||
@@ -1,184 +0,0 @@
|
||||
# Momentry Search APIs 差異比較與使用指南
|
||||
|
||||
> **適用對象**: n8n 流程開發者、前端工程師
|
||||
> **更新日期**: 2026-04-17
|
||||
> **版本**: V1.0
|
||||
|
||||
---
|
||||
|
||||
## 1. 總覽: 四種搜尋模式
|
||||
|
||||
Momentry 提供四種搜尋 API,針對不同的情境進行優化。選擇正確的 API 可以大幅提升回應速度或準確度。
|
||||
|
||||
| API 端點 | 核心技術 | 主要優勢 | 推薦情境 |
|
||||
|----------|----------|----------|----------|
|
||||
| `/api/v1/search` | **語意向量 (Vector)** | 理解語境、同義詞匹配 | 標準搜尋、語意理解 |
|
||||
| `/api/v1/n8n/search` | **語意向量 + 擴充資訊** | **提供 file_path 與 5W1H Metadata** | **n8n 自動化、需播放路徑** |
|
||||
| `/api/v1/search/bm25` | **全文檢索 (Keyword)** | 精確匹配、零 Embedding 延遲 | 精確關鍵字、專有名詞 |
|
||||
| `/api/v1/search/hybrid` | **向量 + BM25 混合** | 綜合語境與關鍵字準確度 | 要求最高準確度的場景 |
|
||||
|
||||
---
|
||||
|
||||
## 2. JSON 結構比較
|
||||
|
||||
### A. 標準搜尋 (Vector) vs n8n 搜尋
|
||||
|
||||
兩者後端邏輯幾乎一致(都使用 Qdrant 向量搜尋),但 **n8n/search** 提供了額外的欄位以滿足 n8n 流程中直接存取檔案的需求。
|
||||
|
||||
#### 標準搜尋 (`/api/v1/search`)
|
||||
```json
|
||||
{
|
||||
"query": "證明",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0790",
|
||||
"vid": "384b0ff44aaaa1f14cb2cd63b3fea966",
|
||||
"chunk_type": "sentence",
|
||||
"start_frame": 187296,
|
||||
"end_frame": 187356,
|
||||
"fps": 59.94,
|
||||
"start_time": 3124.72,
|
||||
"end_time": 3125.73,
|
||||
"text": "I'm trying to prove it.",
|
||||
"score": 0.85,
|
||||
"vector_score": 0.85
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
**特點**:
|
||||
* 結構輕量,但包含完整定位資訊 (`start_frame`, `end_frame`, `fps`)。
|
||||
* 適合前端列表展示與影片播放器定位。
|
||||
* 現在與 `/n8n/search` 使用相同的欄位命名 (`id`, `vid`)。
|
||||
|
||||
#### n8n 搜尋 (`/api/v1/n8n/search`)
|
||||
```json
|
||||
{
|
||||
"query": "證明",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0790",
|
||||
"vid": "384b0ff44aaaa1f14cb2cd63b3fea966",
|
||||
"chunk_type": "sentence",
|
||||
"start_frame": 187296,
|
||||
"end_frame": 187356,
|
||||
"fps": 59.94,
|
||||
"start_time": 3124.72,
|
||||
"end_time": 3125.73,
|
||||
"text": "I'm trying to prove it.",
|
||||
"score": 0.85,
|
||||
"vector_score": 0.85,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/...",
|
||||
"metadata": {
|
||||
"structured_summary": { ... }
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
**特點**:
|
||||
* **欄位命名統一**: 現在與 `/search` 使用相同的 `id`, `vid` 命名。
|
||||
* **擴充資訊**: 包含 `file_path`(可直接用於 ffprobe/ffmpeg 或播放器)。
|
||||
* **Metadata**: 自動抓取該段落對應的 LLM 分析摘要(5W1H)。
|
||||
* **精確定位**: 提供 `start_frame`, `end_frame` 與 `fps`,方便計算幀號。
|
||||
|
||||
### B. 關鍵字搜尋 (BM25)
|
||||
|
||||
#### BM25 搜尋 (`/api/v1/search/bm25`)
|
||||
**特點**:
|
||||
* **不使用 Qdrant**: 直接使用 PostgreSQL 的 `tsvector` (全文檢索)。
|
||||
* **速度極快**: 省去了將 Query 轉換為向量的時間。
|
||||
* **匹配方式**: 嚴格匹配詞彙(或經過分詞處理的詞彙),不具備語意聯想能力。
|
||||
|
||||
### C. 混合搜尋 (Hybrid)
|
||||
|
||||
#### 混合搜尋 (`/api/v1/search/hybrid`)
|
||||
```json
|
||||
{
|
||||
"query": "證明",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0790",
|
||||
"vid": "384b0ff44aaaa1f14cb2cd63b3fea966",
|
||||
"chunk_type": "sentence",
|
||||
"start_frame": 187296,
|
||||
"end_frame": 187356,
|
||||
"fps": 59.94,
|
||||
"start_time": 3124.72,
|
||||
"end_time": 3125.73,
|
||||
"text": "I'm trying to prove it.",
|
||||
"score": 0.781,
|
||||
"vector_score": 0.85,
|
||||
"bm25_score": 0.62
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
**特點**:
|
||||
* **權重分配**: 預設 Vector 佔 70%,BM25 佔 30%。
|
||||
* **雙重評分**: 同時回傳兩個原始分數與加權後的 `score` (combined)。
|
||||
* **最準確**: 適合使用者輸入包含專有名詞(需 BM25)且帶有動作描述(需 Vector)的查詢。
|
||||
|
||||
---
|
||||
|
||||
## 3. 底層資源與效能分析
|
||||
|
||||
| 特性 | `/search` | `/n8n/search` | `/search/bm25` | `/search/hybrid` |
|
||||
|------|-----------|---------------|----------------|------------------|
|
||||
| **依賴資料庫** | Qdrant, Postgres | Qdrant, Postgres, MongoDB | Postgres | Postgres, MongoDB |
|
||||
| **AI 模型呼叫** | Ollama (Embedding) | Ollama (Embedding) | **無** | Ollama (Embedding) |
|
||||
| **Metadata 查詢** | 無 | **有 (Parent Chunk)** | **有 (Parent Chunk)** | 無 |
|
||||
| **多維度搜尋** | ✅ (ASR+Face+Object+Scene) | ✅ (ASR+Face+Object+Scene) | ❌ (僅文字) | ❌ (僅 ASR) |
|
||||
| **回應速度** | 快 (約 100-300ms) | 快 (約 100-300ms) | **極快 (<50ms)** | 中等 (計算較複雜) |
|
||||
| **快取機制** | MongoDB | MongoDB | MongoDB | MongoDB |
|
||||
|
||||
> **提示**: 如果 n8n 流程只需要知道「出現在哪裡」,不需要播放影片或詳細摘要,使用 `/api/v1/search/bm25` 會比向量搜尋更省資源且更快。
|
||||
> **新增**: 所有向量搜尋 API 現在支援多維度搜尋 (Multi-Modal),同時查詢 ASR、Face、Object (YOLO)、Scene 四個 Collection,自動合併去重後回傳。
|
||||
|
||||
---
|
||||
|
||||
## 4. 使用建議決策樹
|
||||
|
||||
```text
|
||||
你希望搜尋結果如何被使用?
|
||||
│
|
||||
├─ 用於 n8n 自動化流程,且需要播放影片片段或分析摘要?
|
||||
│ └─ 使用 /api/v1/n8n/search (或 /n8n/search/bm25)
|
||||
│
|
||||
├─ 使用者輸入的是精確的專有名詞或特定句子?
|
||||
│ └─ 使用 /api/v1/search/bm25
|
||||
│
|
||||
├─ 使用者輸入的是自然語言、意圖描述? (例如:"他在找什麼?")
|
||||
│ ├─ 希望最快回應? -> 使用 /api/v1/search
|
||||
│ └─ 希望最準確? -> 使用 /api/v1/search/hybrid
|
||||
│
|
||||
└─ 想要結合語意與關鍵字?
|
||||
└─ 使用 /api/v1/search/hybrid
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 常見問題 (FAQ)
|
||||
|
||||
### Q: 為什麼 `/n8n/search` 的回應裡有 `metadata`?
|
||||
A: 這是因為 `n8n/search` 會自動查詢該 Chunk 所屬的 **Parent Chunk**(通常是一段完整的場景或故事線)。Parent Chunk 包含了由 LLM (Gemma4) 分析出的結構化摘要(5W1H:Who, What, Where, When, Why)。這在 n8n 流程中可以省去再次呼叫 LLM 的成本。
|
||||
|
||||
### Q: 我應該如何處理 `file_path`?
|
||||
A: `file_path` 是伺服器上的實體路徑。如果你在 n8n 的同一台機器上執行腳本,可以直接將此路徑傳給 Python 或 ffprobe 進行處理。
|
||||
|
||||
### Q: 為什麼有時候搜不到東西?
|
||||
A:
|
||||
1. **Vector Search**: 如果 Query 太短或沒有明確語意,向量可能無法匹配到相似的 Context。
|
||||
2. **BM25 Search**: 如果 Query 沒有經過分詞處理,或者包含停用詞,可能導致匹配失敗。
|
||||
|
||||
---
|
||||
|
||||
## 6. 版本歷史
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|------|------|------|
|
||||
| V1.0 | 2026-04-17 | 建立比較文件,釐清各端點差異與底層資源 |
|
||||
| V1.1 | 2026-04-17 | 統一 JSON 結構 (`id`, `vid`, `chunk_type`, `start_frame`/`end_frame`),新增多維度搜尋說明 |
|
||||
@@ -1,161 +0,0 @@
|
||||
# Momentry N8n Search API 技術說明書
|
||||
|
||||
> **適用對象**: n8n 自動化流程開發者、前端開發者
|
||||
> **版本**: V1.0 | **日期**: 2026-04-17
|
||||
> **更新重點**: 統一欄位名稱 (`start_time`/`end_time`),新增底層邏輯說明
|
||||
|
||||
---
|
||||
|
||||
## 1. API 概覽
|
||||
|
||||
此 API 專為 **n8n 工作流**設計,提供影片內容的向量搜尋(語意搜尋)與關鍵字搜尋(BM25)。
|
||||
其回應格式已針對自動化腳本優化,直接提供影片路徑、時間軸與 5W1H 結構化摘要。
|
||||
|
||||
### 基本資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| **Vector Search** | `POST /api/v1/n8n/search` |
|
||||
| **Keyword Search** | `POST /api/v1/n8n/search/bm25` |
|
||||
| **Smart Search (LLM)**| `POST /api/v1/n8n/search/smart` |
|
||||
| **認證方式** | Header `X-API-Key` |
|
||||
|
||||
---
|
||||
|
||||
## 2. 請求格式 (Request)
|
||||
|
||||
適用於 `/api/v1/n8n/search` 與 `/api/v1/n8n/search/bm25`。
|
||||
|
||||
### Headers
|
||||
```http
|
||||
Content-Type: application/json
|
||||
X-API-Key: muser_68600856036340bcafc01930eb4bd839
|
||||
```
|
||||
|
||||
### Body (JSON)
|
||||
|
||||
| 參數 | 類型 | 必填 | 說明 |
|
||||
|------|------|------|------|
|
||||
| `query` | string | **是** | 搜尋關鍵字或句子 |
|
||||
| `uuid` | string | 否 | 限定搜尋特定影片 (16碼 hex) |
|
||||
| `limit` | int | 否 | 回傳筆數,預設 10 |
|
||||
|
||||
### 範例
|
||||
```json
|
||||
{
|
||||
"query": "主角開車離開的場景",
|
||||
"uuid": "384b0ff44aaaa1f14cb2cd63b3fea966",
|
||||
"limit": 5
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 回應格式 (Response)
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "主角開車離開的場景",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0790",
|
||||
"vid": "384b0ff44aaaa1f14cb2cd63b3fea966",
|
||||
"start_frame": 187296,
|
||||
"end_frame": 187356,
|
||||
"fps": 59.94,
|
||||
"start_time": 3124.72,
|
||||
"end_time": 3125.73,
|
||||
"title": "Chunk sentence_0790",
|
||||
"text": "I'm trying to prove it.",
|
||||
"score": 0.28,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4",
|
||||
"metadata": {
|
||||
"structured_summary": {
|
||||
"who": "...",
|
||||
"what": "..."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 欄位說明 (N8nSearchHit)
|
||||
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `id` | string | Chunk ID (例如 `sentence_0790`) |
|
||||
| `vid` | string | Video UUID |
|
||||
| `start_time` | float | **開始時間 (秒)** (V1.5 修正) |
|
||||
| `end_time` | float | **結束時間 (秒)** (V1.5 修正) |
|
||||
| `start_frame` | int | 開始幀號 (精準定位用) |
|
||||
| `end_frame` | int | 結束幀號 (精準定位用) |
|
||||
| `text` | string | 該分段轉錄文字 (已處理繁簡統一與標點) |
|
||||
| `score` | float | 相關性分數 (0.0 - 1.0) |
|
||||
| `file_path` | string | **影片絕對路徑** (n8n 可直接呼叫 ffplayer 播放) |
|
||||
| `metadata` | object | **5W1H 結構化摘要** (來自 LLM 分析) |
|
||||
|
||||
---
|
||||
|
||||
## 4. 底層操作邏輯 (Underlying Logic)
|
||||
|
||||
為了讓開發者理解效能與資料來源,以下是 `/api/v1/n8n/search` (Vector) 的完整執行流程:
|
||||
|
||||
### 步驟 1: 認證與快取 (Auth & Cache)
|
||||
1. **API Key 驗證**: 檢查 Header 中的 `X-API-Key`。
|
||||
2. **Query Hash**: 計算 `SHA256(query + uuid + limit)` 作為快取 Key。
|
||||
3. **MongoDB Cache 檢查**:
|
||||
* 若命中快取:直接返回 JSON,**跳過**後續繁重的向量運算。
|
||||
* 若未命中:進入步驟 2。
|
||||
|
||||
### 步驟 2: 向量化與搜尋 (Embedding & Search)
|
||||
1. **Embedding**: 呼叫 Ollama (Nomic-Embed-Text) 將 Query 轉換為向量 (Vector)。
|
||||
2. **Qdrant 搜尋**:
|
||||
* 若有 `uuid`: 在該影片的 Collection 中搜尋最相似的 Chunk。
|
||||
* 若無 `uuid`: 進行全域搜尋。
|
||||
* 返回 Top-N 個包含 `chunk_id` 與 `uuid` 的候选結果。
|
||||
|
||||
### 步驟 3: 資料豐富化 (Enrichment via PostgreSQL)
|
||||
拿到 Qdrant 結果後,系統會**逐筆**向 PostgreSQL 查詢詳細資訊:
|
||||
|
||||
1. **取得 Chunk 內容**:
|
||||
* 查詢 `chunks` 表格,獲取原始 JSON 內容、時間、幀號等。
|
||||
2. **取得影片路徑**:
|
||||
* 利用 `uuid` 查詢 `videos` 表格,獲取 `file_path`。
|
||||
3. **取得 5W1H 摘要**:
|
||||
* 檢查 Chunk 是否有 `parent_chunk_id` (所屬的故事段落)。
|
||||
* 若有,查詢 `parent_chunks` 表格的 `metadata` 欄位。
|
||||
* 該欄位包含由 Gemma4 LLM 生成的結構化摘要 (Who, What, Where, When, Why, Key Events)。
|
||||
|
||||
### 步驟 4: 格式化與回傳 (Formatting)
|
||||
1. **Text Processing**: 將 Chunk 原始內容中的文字提取,並進行繁簡轉換與分詞處理 (Tokenization)。
|
||||
2. **建構 Hit 物件**: 組合上述所有資料為 `N8nSearchHit`。
|
||||
3. **寫入快取**: 將最終結果寫入 MongoDB 以便下次秒回。
|
||||
4. **回應 JSON**: 返回給 n8n。
|
||||
|
||||
---
|
||||
|
||||
## 5. 進階搜尋模式
|
||||
|
||||
除了標準的 Vector Search,還有兩種變體:
|
||||
|
||||
### 5.1 BM25 Keyword Search
|
||||
* **Endpoint**: `/api/v1/n8n/search/bm25`
|
||||
* **邏輯**: 跳過向量運算,直接使用 PostgreSQL 的全文檢索 (Full Text Search) 功能。適合精確匹配專有名詞或關鍵字。
|
||||
|
||||
### 5.2 Smart Search (LLM 分析)
|
||||
* **Endpoint**: `/api/v1/n8n/search/smart`
|
||||
* **邏輯**:
|
||||
1. 將 Query 送至 Llama-server (Port 8081) 進行意圖分析 (5W1H)。
|
||||
2. 提取出關鍵實體 (人名、地點、動作)。
|
||||
3. 將提取出的實體轉換為更精確的 BM25 查詢語句進行搜尋。
|
||||
4. 適合自然語言提問 (例如:「誰在辦公室裡生氣了?」)。
|
||||
|
||||
---
|
||||
|
||||
## 6. 版本歷史
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|------|------|------|
|
||||
| V1.0 | 2026-04-17 | 建立完整技術說明書,包含底層邏輯與 5W1H 機制說明 |
|
||||
@@ -1,171 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "Momentry Video RAG - n8n 工作流程設定完成"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "工作流程設定完成"
|
||||
- "video"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry Video RAG - n8n 工作流程設定完成 的內容"
|
||||
- "Momentry Video RAG - n8n 工作流程設定完成 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry Video RAG - n8n 工作流程設定完成?"
|
||||
---
|
||||
|
||||
# Momentry Video RAG - n8n 工作流程設定完成
|
||||
|
||||
## ✅ 最終成功版本
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| **工作流程名稱** | Video Search - Working v3 |
|
||||
| **ID** | 4vQo8I4SXEaR5E1A |
|
||||
| **狀態** | ✅ SUCCESS |
|
||||
| **執行 ID** | 1620 |
|
||||
|
||||
---
|
||||
|
||||
## 成功關鍵
|
||||
|
||||
### HTTP Request Node 正確設定
|
||||
```json
|
||||
{
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"specifyBody": "json",
|
||||
"jsonBody": "{\"query\":\"charade\",\"limit\":3}",
|
||||
"options": {}
|
||||
}
|
||||
```
|
||||
|
||||
**重點**:
|
||||
- ✅ `specifyBody`: "json" (不是 "body")
|
||||
- ✅ `jsonBody`: 字串格式 (不是物件)
|
||||
- ✅ 使用 `"{\"query\":\"..."}` 轉義引號
|
||||
|
||||
---
|
||||
|
||||
## 所有可用工作流程
|
||||
|
||||
| 工作流程 | ID | 狀態 | 說明 |
|
||||
|---------|-----|------|------|
|
||||
| Video Search - Working v3 | 4vQo8I4SXEaR5E1A | ✅ 成功 | **推薦使用** |
|
||||
| Video Search - HTTP Only | tZbljQCFZDOJ4C0s | ❌ 失敗 | body 格式錯誤 |
|
||||
| Video Search - Debug Simple | e2CMjonwILMUYjp0 | ⚠️ 待測 | Code Node 版本 |
|
||||
| Video Search - Instant | zC5K3TbFzWGAh0la | ❌ 失敗 | `$httpRequest` 不可用 |
|
||||
|
||||
---
|
||||
|
||||
## 如何使用
|
||||
|
||||
### 方法 1: 直接執行
|
||||
```bash
|
||||
# 開啟工作流程
|
||||
open https://n8n.momentry.ddns.net/workflow/4vQo8I4SXEaR5E1A
|
||||
```
|
||||
|
||||
然後:
|
||||
1. 點擊 **"Execute Workflow"** ▶️
|
||||
2. 點擊 **"Show Result"** 節點
|
||||
3. 查看 JSON 結果
|
||||
|
||||
### 方法 2: 修改搜尋關鍵字
|
||||
1. 點擊 **"Search API"** 節點
|
||||
2. 修改 `jsonBody`:
|
||||
```json
|
||||
"{\"query\":\"您的關鍵字\",\"limit\":5}"
|
||||
```
|
||||
3. 儲存並重新執行
|
||||
|
||||
---
|
||||
|
||||
## API 端點
|
||||
|
||||
### Momentry Core API
|
||||
```
|
||||
POST https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
Content-Type: application/json
|
||||
|
||||
Body:
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3,
|
||||
"uuid": "可選的影片UUID"
|
||||
}
|
||||
```
|
||||
|
||||
### 直接測試
|
||||
```bash
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 已建立的文件
|
||||
|
||||
| 文件 | 路徑 | 內容 |
|
||||
|------|------|------|
|
||||
| API URL 範例 | `docs/API_URL_EXAMPLES.md` | 完整 URL 和 curl 指令 |
|
||||
| HTTP Request 指南 | `docs_v1.0/IMPLEMENTATION/N8N_HTTP_REQUEST_GUIDE.md` | Node 設定說明 |
|
||||
| 輸出查看指南 | `docs_v1.0/IMPLEMENTATION/N8N_VIEW_OUTPUT_GUIDE.md` | 如何查看結果 |
|
||||
| MCP 測試報告 | `docs_v1.0/OPERATIONS/maintenance_records/changes/CHANGE_N8N_MCP_INTEGRATION_TEST_2026_03_23.md` | 43 個 MCP 工具 |
|
||||
| API 修復總結 | `docs_v1.0/OPERATIONS/maintenance_records/rca/RCA_N8N_API_PORT_CONFLICT_2026_03_26.md` | 問題修復過程 |
|
||||
| 工作流程 JSON | `docs/n8n_workflow_video_rag_mcp.json` | 原始工作流程 |
|
||||
| 測試腳本 | `docs/test_all.sh` | 自動測試腳本 |
|
||||
|
||||
---
|
||||
|
||||
## 服務狀態
|
||||
|
||||
✅ **Momentry Core**: https://api.momentry.ddns.net (Port 3002)
|
||||
✅ **n8n**: https://n8n.momentry.ddns.net (Port 5678)
|
||||
✅ **MCP 整合**: 43 個工具可用
|
||||
|
||||
---
|
||||
|
||||
## 下一步建議
|
||||
|
||||
### 1. 建立帶有參數的工作流程
|
||||
修改現有工作流程,讓 query 和 limit 可以動態輸入:
|
||||
- 添加 Webhook Node 接收外部請求
|
||||
- 或使用 Set Node 設定變數
|
||||
|
||||
### 2. 建立完整的 RAG 流程
|
||||
結合 OpenAI:
|
||||
- 搜尋影片片段
|
||||
- 使用 GPT 生成回答
|
||||
- 回傳格式化的 RAG 結果
|
||||
|
||||
### 3. 自動化監控
|
||||
- 建立定時執行的工作流程
|
||||
- 監控 API 健康狀態
|
||||
- 發送 Telegram/Email 通知
|
||||
|
||||
---
|
||||
|
||||
## 問題排除
|
||||
|
||||
如果再次遇到 "Your request is invalid":
|
||||
1. 檢查 `specifyBody` 必須設為 `"json"`
|
||||
2. `jsonBody` 必須是字串格式,不是物件
|
||||
3. 確保使用正確的 JSON 轉義: `{\"key\":\"value\"}`
|
||||
|
||||
---
|
||||
|
||||
## 完成!🎉
|
||||
|
||||
所有設定已完成:
|
||||
- ✅ n8n REST API 修復並運作正常
|
||||
- ✅ MCP 整合完成 (43 個工具)
|
||||
- ✅ Momentry Core API 可外部存取
|
||||
- ✅ 成功的工作流程已創建並測試
|
||||
|
||||
您可以開始使用 n8n 自動化管理 Momentry Core 了!
|
||||
@@ -1,158 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "N8N"
|
||||
title: "n8n 工作流程輸出查看指南"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "工作流程輸出查看指南"
|
||||
ai_query_hints:
|
||||
- "查詢 n8n 工作流程輸出查看指南 的內容"
|
||||
- "n8n 工作流程輸出查看指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 n8n 工作流程輸出查看指南?"
|
||||
---
|
||||
|
||||
# n8n 工作流程輸出查看指南
|
||||
|
||||
## 問題:"Node executed successfully but no output data"
|
||||
|
||||
這是正常的!在 n8n 中,你需要**點擊節點**才能看到輸出資料。
|
||||
|
||||
---
|
||||
|
||||
## 如何查看輸出資料
|
||||
|
||||
### 方法 1: 點擊節點查看
|
||||
|
||||
1. 執行工作流程後(點擊 Execute Workflow)
|
||||
2. **點擊任何一個節點**(Node)
|
||||
3. 在右側面板會顯示該節點的輸出
|
||||
4. 查看 **JSON** 分頁看到完整資料
|
||||
|
||||
### 方法 2: 查看執行記錄
|
||||
|
||||
1. 執行工作流程
|
||||
2. 點擊左側的 **"Executions"** 選單
|
||||
3. 找到最近的執行記錄
|
||||
4. 點擊展開查看每個節點的輸出
|
||||
|
||||
### 方法 3: 使用 Respond to Webhook
|
||||
|
||||
如果你想直接看到結果,添加一個 Respond to Webhook 節點:
|
||||
|
||||
```javascript
|
||||
// 在最後一個節點之後添加:
|
||||
Node: Respond to Webhook
|
||||
├── Response Mode: Last Node
|
||||
└── Response Body: {{ JSON.stringify($json) }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 新增的工作流程
|
||||
|
||||
### ✅ Video Search - Debug Simple
|
||||
- **ID**: e2CMjonwILMUYjp0
|
||||
- **URL**: https://n8n.momentry.ddns.net/workflow/e2CMjonwILMUYjp0
|
||||
|
||||
這個版本保證有輸出!
|
||||
|
||||
### 執行步驟
|
||||
|
||||
1. 開啟工作流程
|
||||
2. 點擊 **"Execute Workflow"** ▶️
|
||||
3. 等待執行完成(約 3-5 秒)
|
||||
4. **點擊最後一個節點** "Step 3 - Show Results"
|
||||
5. 查看右側的 **JSON** 分頁
|
||||
|
||||
### 預期看到的輸出
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "SUCCESS",
|
||||
"query": "charade",
|
||||
"totalResults": 2,
|
||||
"firstHit": {
|
||||
"text": "fun plot twists, Woody Dialog and charming perform...",
|
||||
"time": "48.8s - 55.44s",
|
||||
"score": "53%"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
或如果失敗:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "FAILED",
|
||||
"error": "error message here"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 截圖說明
|
||||
|
||||
### 執行後的畫面
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ When clicking "Execute Workflow" │ ✅ (綠色勾)
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 1 - Set Query │ ✅ (綠色勾)
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 2 - Call API │ ✅ (綠色勾) ← 點擊這裡
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 3 - Show Results │ ✅ (綠色勾) ← 或這個
|
||||
└─────────────────────────────────────┘
|
||||
|
||||
[右側面板 - 點擊節點後顯示]
|
||||
┌─────────────────────────────────────┐
|
||||
│ Node: Step 2 - Call API │
|
||||
│ │
|
||||
│ [JSON] [Table] [Schema] │ ← 點擊 JSON
|
||||
│ │
|
||||
│ { │
|
||||
│ "success": true, │
|
||||
│ "query": "charade", │
|
||||
│ ... │
|
||||
│ } │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 快速測試
|
||||
|
||||
如果不想用瀏覽器,直接在這裡執行:
|
||||
|
||||
```bash
|
||||
# 開啟簡化版工作流程
|
||||
open https://n8n.momentry.ddns.net/workflow/e2CMjonwILMUYjp0
|
||||
```
|
||||
|
||||
然後:
|
||||
1. 點擊 **Execute Workflow**
|
||||
2. 點擊 **"Step 3 - Show Results"** 節點
|
||||
3. 看右側 JSON 面板
|
||||
|
||||
---
|
||||
|
||||
## 如果仍然看不到資料
|
||||
|
||||
檢查:
|
||||
1. ✅ 工作流程已儲存
|
||||
2. ✅ 點擊了正確的節點(有綠色勾的)
|
||||
3. ✅ 右側面板已展開(點擊 JSON 分頁)
|
||||
4. ✅ 沒有紅色錯誤訊息
|
||||
|
||||
---
|
||||
|
||||
## 聯絡支援
|
||||
|
||||
如果還是有問題,請告訴我:
|
||||
1. 你點擊的是哪個節點?
|
||||
2. 右側面板顯示什麼?
|
||||
3. 有沒有紅色錯誤訊息?
|
||||
@@ -1,448 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "OpenCode 使用規範"
|
||||
date: "2026-03-21"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "opencode"
|
||||
- "使用規範"
|
||||
ai_query_hints:
|
||||
- "查詢 OpenCode 使用規範 的內容"
|
||||
- "OpenCode 使用規範 的主要目的是什麼?"
|
||||
- "如何操作或實施 OpenCode 使用規範?"
|
||||
---
|
||||
|
||||
# OpenCode 使用規範
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-21 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-21 | 創建文件 | Warren |
|
||||
| V1.1 | 2026-03-21 | 新增 MCP 設定章節 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔定義使用 OpenCode 進行專案開發的最佳實踐,確保開發效率和程式碼品質。
|
||||
|
||||
---
|
||||
|
||||
## 任務管理
|
||||
|
||||
### 任務批次策略
|
||||
|
||||
**原則**: 一次處理 1-2 個功能,完成後驗證,再繼續下一個。
|
||||
|
||||
| 批次大小 | 適用場景 | 說明 |
|
||||
|----------|----------|------|
|
||||
| 1 個 | 緊急修復、簡單任務 | 快速完成 |
|
||||
| 2-3 個 | 一般功能開發 | 平衡效率與品質 |
|
||||
| 3+ 個 | 大型重構 | 需要更詳細的追蹤 |
|
||||
|
||||
### 驗證流程
|
||||
|
||||
每個任務完成後必須執行:
|
||||
|
||||
```bash
|
||||
# 1. 編譯檢查
|
||||
cargo check
|
||||
|
||||
# 2. Lint 檢查
|
||||
cargo clippy --lib
|
||||
|
||||
# 3. 單元測試
|
||||
cargo test --lib
|
||||
|
||||
# 4. 格式化檢查
|
||||
cargo fmt -- --check
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 溝通模式
|
||||
|
||||
### 有效的任務描述
|
||||
|
||||
**建議格式**:
|
||||
```
|
||||
執行 [功能名稱]
|
||||
- 優先級: 高/中/低
|
||||
- 驗收標準: [明確的標準]
|
||||
- 約束: [限制條件]
|
||||
```
|
||||
|
||||
**範例**:
|
||||
```
|
||||
實作 monitor_jobs 表
|
||||
- 優先級: 高
|
||||
- 驗收標準: CRUD 操作可用,單元測試通過
|
||||
- 約束: 使用現有架構
|
||||
```
|
||||
|
||||
### 明確的暫停點
|
||||
|
||||
在每個階段完成後主動詢問:
|
||||
|
||||
```
|
||||
[任務] 完成。要繼續:
|
||||
1. 實作功能 A
|
||||
2. 添加測試
|
||||
3. 更新文檔
|
||||
```
|
||||
|
||||
### 不建議的溝通
|
||||
|
||||
| 模式 | 問題 | 建議 |
|
||||
|------|------|------|
|
||||
| 一次指定太多項目 | 增加複雜度,難以追蹤 | 分批處理 |
|
||||
| 模糊的任務描述 | 難以評估進度 | 使用明確的驗收標準 |
|
||||
| 從不驗證 | 累積問題 | 每步驟完成後驗證 |
|
||||
|
||||
---
|
||||
|
||||
## 決策點
|
||||
|
||||
### 常見決策點
|
||||
|
||||
| 階段 | 問題 | 選項 |
|
||||
|------|------|------|
|
||||
| 開始 | 如何開始? | 先了解現況 / 直接實作 |
|
||||
| 實作 | 實作方式? | 保持現有架構 / 重構 |
|
||||
| 驗證 | 通過了嗎? | 繼續 / 修復問題 |
|
||||
| 完成 | 還有什麼? | 下一個任務 / 結束 |
|
||||
|
||||
### 決策準則
|
||||
|
||||
1. **安全優先**: 破壞性變更需要明確確認
|
||||
2. **驗證後繼續**: 每步驟完成後驗證
|
||||
3. **文檔同步**: 變更後更新文檔
|
||||
|
||||
---
|
||||
|
||||
## 文檔使用
|
||||
|
||||
### 必讀文檔
|
||||
|
||||
| 文檔 | 用途 | 查閱時機 |
|
||||
|------|------|----------|
|
||||
| `AGENTS.md` | 專案規範 | 每次對話開始 |
|
||||
| `docs/*.md` | 技術規格 | 功能實作前 |
|
||||
|
||||
### 文檔更新時機
|
||||
|
||||
| 變更類型 | 需要更新 |
|
||||
|----------|----------|
|
||||
| 新功能 | `AGENTS.md` + 相關技術文檔 |
|
||||
| 架構變更 | `ARCHITECTURE_EVALUATION.md` |
|
||||
| 問題修復 | `PENDING_ISSUES.md` |
|
||||
| 環境變更 | `INSTALL_*.md` |
|
||||
|
||||
---
|
||||
|
||||
## 審查清單
|
||||
|
||||
### 實作完成後檢查
|
||||
|
||||
- [ ] `cargo clippy --lib` 通過
|
||||
- [ ] `cargo test --lib` 通過
|
||||
- [ ] `cargo fmt -- --check` 通過
|
||||
- [ ] 文檔已更新
|
||||
- [ ] 新功能有單元測試
|
||||
- [ ] Pre-commit hook 通過
|
||||
|
||||
### 對話結束前
|
||||
|
||||
- [ ] 所有變更已驗證
|
||||
- [ ] 文檔已同步
|
||||
- [ ] 下一步計劃明確
|
||||
|
||||
---
|
||||
|
||||
## 範例流程
|
||||
|
||||
### 範例 1: 實作新功能
|
||||
|
||||
```
|
||||
用戶: 實作使用者認證功能
|
||||
|
||||
OpenCode:
|
||||
1. 分析現有架構
|
||||
2. 創建任務清單
|
||||
3. 實作核心功能
|
||||
4. 添加單元測試
|
||||
5. 更新文檔
|
||||
6. 驗證通過
|
||||
|
||||
用戶: 完成,繼續下一個
|
||||
```
|
||||
|
||||
### 範例 2: 修復問題
|
||||
|
||||
```
|
||||
用戶: 修復登入超時問題
|
||||
|
||||
OpenCode:
|
||||
1. 重現問題
|
||||
2. 分析根因
|
||||
3. 實作修復
|
||||
4. 驗證修復
|
||||
5. 添加測試防止回歸
|
||||
|
||||
用戶: 確認修復完成
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見問題
|
||||
|
||||
### Q: 如何避免一次處理太多?
|
||||
|
||||
**A**: 使用 `/todo` 追蹤任務,分批處理。
|
||||
|
||||
### Q: 如何確保文檔同步?
|
||||
|
||||
**A**: 每個任務完成後檢查是否需要更新文檔。
|
||||
|
||||
### Q: 何時應該結束對話?
|
||||
|
||||
**A**: 當主要任務完成,且沒有緊急的後續步驟時。
|
||||
|
||||
---
|
||||
|
||||
## MCP 設定
|
||||
|
||||
### 設定檔案
|
||||
|
||||
OpenCode MCP 設定位於 `~/.config/opencode/opencode.json`
|
||||
|
||||
### 已啟用的 MCP Servers
|
||||
|
||||
| Server | 用途 | 命令 |
|
||||
|--------|------|------|
|
||||
| gitea | Gitea API 操作 | `/opt/homebrew/bin/gitea-mcp-server` |
|
||||
| n8n | n8n Workflow 操作 | `/opt/homebrew/bin/mcp-n8n` |
|
||||
| postgres | PostgreSQL 資料庫查詢 | `/opt/homebrew/bin/mcp-server-postgres` |
|
||||
| redis | Redis 快取操作 | `/opt/homebrew/bin/mcp-server-redis` |
|
||||
| qdrant | Qdrant 向量搜尋 | `/opt/homebrew/bin/mcp-server-qdrant` |
|
||||
| filesystem | 檔案系統操作 | `/opt/homebrew/bin/mcp-server-filesystem` |
|
||||
|
||||
### MCP 設定格式
|
||||
|
||||
**Schema 參考**: `https://opencode.ai/config.json`
|
||||
|
||||
**必要欄位**:
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `type` | string | `"local"` 或 `"remote"` |
|
||||
| `command` | array | 命令和參數(local 必要) |
|
||||
| `url` | string | 遠端 URL(remote 必要) |
|
||||
|
||||
**可選欄位**:
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `environment` | object | 環境變數(local only) |
|
||||
| `enabled` | boolean | 是否啟用 |
|
||||
| `timeout` | number | 請求超時(毫秒) |
|
||||
| `headers` | object | 請求頭(remote only) |
|
||||
|
||||
**Local MCP 範例**:
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
},
|
||||
"postgres": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-postgres"],
|
||||
"environment": {
|
||||
"DATABASE_URL": "postgresql://accusys:accusys@localhost:5432/momentry"
|
||||
}
|
||||
},
|
||||
"redis": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-redis"],
|
||||
"environment": {
|
||||
"REDIS_URL": "redis://:accusys@localhost:6379"
|
||||
}
|
||||
},
|
||||
"qdrant": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-qdrant"],
|
||||
"environment": {
|
||||
"QDRANT_URL": "http://localhost:6333",
|
||||
"QDRANT_API_KEY": ""
|
||||
}
|
||||
},
|
||||
"filesystem": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-filesystem"],
|
||||
"args": ["/Users/accusys/momentry"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Remote MCP 範例**:
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"jira": {
|
||||
"type": "remote",
|
||||
"url": "https://jira.example.com/mcp",
|
||||
"enabled": true,
|
||||
"headers": {
|
||||
"Authorization": "Bearer your-token"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### n8n MCP 工具 (43 個)
|
||||
|
||||
#### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_workflows` | 列出所有 workflows |
|
||||
| `n8n_get_workflow` | 取得 workflow 詳情 |
|
||||
| `n8n_create_workflow` | 建立新 workflow |
|
||||
| `n8n_update_workflow` | 更新 workflow |
|
||||
| `n8n_delete_workflow` | 刪除 workflow |
|
||||
| `n8n_activate_workflow` | 啟用 workflow |
|
||||
| `n8n_deactivate_workflow` | 停用 workflow |
|
||||
| `n8n_execute_workflow` | 執行 workflow |
|
||||
| `n8n_get_workflow_tags` | 取得 workflow 標籤 |
|
||||
| `n8n_update_workflow_tags` | 更新 workflow 標籤 |
|
||||
|
||||
#### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_executions` | 列出執行記錄 |
|
||||
| `n8n_get_execution` | 取得執行詳情 |
|
||||
| `n8n_delete_execution` | 刪除執行記錄 |
|
||||
|
||||
#### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_datatables` | 列出資料表 |
|
||||
| `n8n_create_datatable` | 建立資料表 |
|
||||
| `n8n_get_datatable` | 取得資料表結構 |
|
||||
| `n8n_get_datatable_rows` | 取得資料表列 |
|
||||
| `n8n_insert_datatable_rows` | 插入資料列 |
|
||||
| `n8n_update_datatable_rows` | 更新資料列 |
|
||||
| `n8n_upsert_datatable_row` | 插入或更新資料列 |
|
||||
| `n8n_delete_datatable_rows` | 刪除資料列 |
|
||||
|
||||
#### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_tags` | 列出所有標籤 |
|
||||
| `n8n_get_tag` | 取得標籤 |
|
||||
| `n8n_create_tag` | 建立標籤 |
|
||||
| `n8n_update_tag` | 更新標籤 |
|
||||
| `n8n_delete_tag` | 刪除標籤 |
|
||||
|
||||
#### Credentials (4)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_credentials` | 列出憑證 |
|
||||
| `n8n_create_credential` | 建立憑證 |
|
||||
| `n8n_delete_credential` | 刪除憑證 |
|
||||
| `n8n_get_credential_schema` | 取得憑證 schema |
|
||||
|
||||
#### Users (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_users` | 列出使用者 |
|
||||
| `n8n_get_user` | 取得使用者 |
|
||||
| `n8n_delete_user` | 刪除使用者 |
|
||||
|
||||
#### Variables (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_variables` | 列出變數 |
|
||||
| `n8n_create_variable` | 建立變數 |
|
||||
| `n8n_delete_variable` | 刪除變數 |
|
||||
|
||||
#### 其他 (7)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_projects` | 列出專案 |
|
||||
| `n8n_create_project` | 建立專案 |
|
||||
| `n8n_update_project` | 更新專案 |
|
||||
| `n8n_delete_project` | 刪除專案 |
|
||||
| `n8n_generate_audit` | 產生安全審計報告 |
|
||||
| `n8n_health_check` | 健康檢查 |
|
||||
| `n8n_trigger_webhook` | 觸發 webhook |
|
||||
|
||||
### 安裝 n8n MCP
|
||||
|
||||
```bash
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
```
|
||||
|
||||
### n8n API Key 設定
|
||||
|
||||
1. 開啟 n8n UI (http://localhost:5678)
|
||||
2. 前往 Settings → API
|
||||
3. 建立 API Key
|
||||
4. 將 API Key 加入 `opencode.json` 的 `N8N_API_KEY`
|
||||
|
||||
### 驗證 MCP 運作
|
||||
|
||||
```bash
|
||||
# 測試 MCP server
|
||||
N8N_BASE_URL=https://n8n.momentry.ddns.net \
|
||||
N8N_API_KEY="your-key" \
|
||||
mcp-n8n
|
||||
|
||||
# 測試工具列表
|
||||
echo '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0"}}}
|
||||
{"jsonrpc": "2.0", "id": 2, "method": "tools/list", "params": {}}' | \
|
||||
N8N_BASE_URL=https://n8n.momentry.ddns.net \
|
||||
N8N_API_KEY="your-key" \
|
||||
mcp-n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [AGENTS.md](../AGENTS.md) - 專案開發規範
|
||||
- [ARCHITECTURE_EVALUATION.md](./ARCHITECTURE_EVALUATION.md) - 架構優化評估
|
||||
- [PENDING_ISSUES.md](./PENDING_ISSUES.md) - 待解決問題追蹤
|
||||
- [INSTALL_N8N.md](./INSTALL_N8N.md) - n8n 安裝指南
|
||||
@@ -1,554 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "OpenCode MCP Servers 安裝指南"
|
||||
date: "2026-03-24"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "安裝指南"
|
||||
- "servers"
|
||||
- "opencode"
|
||||
ai_query_hints:
|
||||
- "查詢 OpenCode MCP Servers 安裝指南 的內容"
|
||||
- "OpenCode MCP Servers 安裝指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 OpenCode MCP Servers 安裝指南?"
|
||||
---
|
||||
|
||||
# OpenCode MCP Servers 安裝指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-24 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-24 | 創建文件 | OpenCode | OpenCode / big-pickle |
|
||||
| V1.1 | 2026-03-24 | 新增 sentry, context7, playwright MCP | OpenCode | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上為 OpenCode 安裝和配置 MCP (Model Context Protocol) Servers,透過標準化的協定讓 AI 助手能夠存取各種外部服務和工具。
|
||||
|
||||
MCP Servers 提供:
|
||||
- 標準化的工具調用介面
|
||||
- 安全的資源存取控制
|
||||
- 統一的配置和管理方式
|
||||
|
||||
---
|
||||
|
||||
## 已安裝的 MCP Servers
|
||||
|
||||
| Server | 安裝方式 | 用途 | 狀態 |
|
||||
|--------|----------|------|------|
|
||||
| gitea | Homebrew | Gitea API 操作 | ✅ |
|
||||
| n8n | NPM (@nextoolsolutions/mcp-n8n) | n8n Workflow 管理 | ✅ |
|
||||
| postgres | NPM (@modelcontextprotocol/server-postgres) | PostgreSQL 資料庫查詢 | ✅ |
|
||||
| redis | NPM (@modelcontextprotocol/server-redis) | Redis 快取操作 | ✅ |
|
||||
| mongodb | NPM (mongodb-mcp-server) | MongoDB 文件資料庫 | ✅ |
|
||||
| qdrant | Python (qdrant/mcp-server-qdrant) | Qdrant 向量搜尋 | ✅ |
|
||||
| filesystem | NPM (@modelcontextprotocol/server-filesystem) | 檔案系統操作 | ✅ |
|
||||
| sentry | NPM (@sentry/mcp-server) | 錯誤追蹤和監控 | ⏳ |
|
||||
| context7 | NPM (@upstash/context7-mcp) | 技術文檔搜尋 | ✅ |
|
||||
| playwright | NPM (@playwright/mcp) | 瀏覽器自動化 | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 前置條件
|
||||
|
||||
- OpenCode 已安裝
|
||||
- Node.js (用於 NPM 套件)
|
||||
- Python 3.11+ (用於 qdrant-mcp)
|
||||
- 相關服務已運行 (PostgreSQL, Redis, Qdrant, Gitea, n8n, MongoDB)
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 NPM MCP Servers
|
||||
|
||||
```bash
|
||||
npm install -g @modelcontextprotocol/server-postgres
|
||||
npm install -g @modelcontextprotocol/server-redis
|
||||
npm install -g @modelcontextprotocol/server-filesystem
|
||||
npm install -g @modelcontextprotocol/server-everything
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
npm install -g mongodb-mcp-server
|
||||
npm install -g @sentry/mcp-server
|
||||
npm install -g @upstash/context7-mcp
|
||||
npm install -g @playwright/mcp
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which mcp-server-postgres
|
||||
which mcp-server-redis
|
||||
which mcp-server-filesystem
|
||||
which mcp-n8n
|
||||
which mongodb-mcp-server
|
||||
which sentry-mcp
|
||||
which context7-mcp
|
||||
which playwright-mcp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 安裝 gitea-mcp-server
|
||||
|
||||
```bash
|
||||
brew install gitea-mcp-server
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 安裝 MongoDB MCP Server (已包含在 Step 1)
|
||||
|
||||
MongoDB MCP 已透過 NPM 安裝:
|
||||
|
||||
```bash
|
||||
npm install -g mongodb-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 安裝 Qdrant MCP Server (Python)
|
||||
|
||||
```bash
|
||||
cd /tmp
|
||||
git clone https://github.com/qdrant/mcp-server-qdrant.git
|
||||
cd mcp-server-qdrant
|
||||
/opt/homebrew/bin/python3.11 -m pip install -e .
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which mcp-server-qdrant
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 配置 OpenCode MCP 設定
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token",
|
||||
"<GITEA_TOKEN>",
|
||||
"-host",
|
||||
"http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
},
|
||||
"postgres": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-postgres",
|
||||
"postgresql://accusys:accusys@localhost:5432/momentry"
|
||||
]
|
||||
},
|
||||
"redis": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-redis",
|
||||
"redis://:accusys@localhost:6379"
|
||||
]
|
||||
},
|
||||
"mongodb": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mongodb-mcp-server"],
|
||||
"environment": {
|
||||
"MONGODB_URI": "mongodb://localhost:27017"
|
||||
}
|
||||
},
|
||||
"qdrant": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-qdrant"],
|
||||
"environment": {
|
||||
"QDRANT_URL": "http://localhost:6333",
|
||||
"QDRANT_API_KEY": ""
|
||||
}
|
||||
},
|
||||
"filesystem": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-filesystem",
|
||||
"/Users/accusys/momentry"
|
||||
]
|
||||
},
|
||||
"sentry": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/sentry-mcp",
|
||||
"--access-token",
|
||||
"<SENTRY_ACCESS_TOKEN>"
|
||||
]
|
||||
},
|
||||
"context7": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/context7-mcp"]
|
||||
},
|
||||
"playwright": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/playwright-mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: 驗證 MCP Servers
|
||||
|
||||
```bash
|
||||
# 列出所有 MCP servers
|
||||
opencode mcp ls
|
||||
|
||||
# 或在 OpenCode 中執行
|
||||
/mcps
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## MCP Server 工具說明
|
||||
|
||||
### gitea
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| list_repos | 列出倉庫 |
|
||||
| get_repo | 取得倉庫詳情 |
|
||||
| list_issues | 列出 Issues |
|
||||
| create_issue | 建立 Issue |
|
||||
| list_pulls | 列出 Pull Requests |
|
||||
|
||||
---
|
||||
|
||||
### n8n (43 個工具)
|
||||
|
||||
#### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_workflows | 列出所有 workflows |
|
||||
| n8n_get_workflow | 取得 workflow 詳情 |
|
||||
| n8n_create_workflow | 建立新 workflow |
|
||||
| n8n_update_workflow | 更新 workflow |
|
||||
| n8n_delete_workflow | 刪除 workflow |
|
||||
| n8n_activate_workflow | 啟用 workflow |
|
||||
| n8n_deactivate_workflow | 停用 workflow |
|
||||
| n8n_execute_workflow | 執行 workflow |
|
||||
| n8n_get_workflow_tags | 取得 workflow 標籤 |
|
||||
| n8n_update_workflow_tags | 更新 workflow 標籤 |
|
||||
|
||||
#### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_executions | 列出執行記錄 |
|
||||
| n8n_get_execution | 取得執行詳情 |
|
||||
| n8n_delete_execution | 刪除執行記錄 |
|
||||
|
||||
#### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_datatables | 列出資料表 |
|
||||
| n8n_create_datatable | 建立資料表 |
|
||||
| n8n_get_datatable | 取得資料表結構 |
|
||||
| n8n_get_datatable_rows | 取得資料表列 |
|
||||
| n8n_insert_datatable_rows | 插入資料列 |
|
||||
| n8n_update_datatable_rows | 更新資料列 |
|
||||
| n8n_upsert_datatable_row | 插入或更新資料列 |
|
||||
| n8n_delete_datatable_rows | 刪除資料列 |
|
||||
|
||||
#### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_tags | 列出所有標籤 |
|
||||
| n8n_get_tag | 取得標籤 |
|
||||
| n8n_create_tag | 建立標籤 |
|
||||
| n8n_update_tag | 更新標籤 |
|
||||
| n8n_delete_tag | 刪除標籤 |
|
||||
|
||||
#### 其他 (17)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_credentials | 列出憑證 |
|
||||
| n8n_create_credential | 建立憑證 |
|
||||
| n8n_delete_credential | 刪除憑證 |
|
||||
| n8n_get_credential_schema | 取得憑證 schema |
|
||||
| n8n_list_users | 列出使用者 |
|
||||
| n8n_get_user | 取得使用者 |
|
||||
| n8n_delete_user | 刪除使用者 |
|
||||
| n8n_list_variables | 列出變數 |
|
||||
| n8n_create_variable | 建立變數 |
|
||||
| n8n_delete_variable | 刪除變數 |
|
||||
| n8n_list_projects | 列出專案 |
|
||||
| n8n_create_project | 建立專案 |
|
||||
| n8n_update_project | 更新專案 |
|
||||
| n8n_delete_project | 刪除專案 |
|
||||
| n8n_generate_audit | 產生安全審計報告 |
|
||||
| n8n_health_check | 健康檢查 |
|
||||
| n8n_trigger_webhook | 觸發 webhook |
|
||||
|
||||
---
|
||||
|
||||
### postgres
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| query | 執行唯讀 SQL 查詢 |
|
||||
|
||||
**範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"sql": "SELECT * FROM users LIMIT 10;"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### redis
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| set | 設定 key-value 配對 |
|
||||
| get | 取得 key 的值 |
|
||||
| delete | 刪除 key(s) |
|
||||
| list | 列出符合模式的 keys |
|
||||
|
||||
---
|
||||
|
||||
### mongodb
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| mongodb_list_databases | 列出所有資料庫 |
|
||||
| mongodb_list_collections | 列出資料庫中的集合 |
|
||||
| mongodb_find | 查詢文件 |
|
||||
| mongodb_insert_one | 插入單個文件 |
|
||||
| mongodb_insert_many | 插入多個文件 |
|
||||
| mongodb_update_one | 更新單個文件 |
|
||||
| mongodb_update_many | 更新多個文件 |
|
||||
| mongodb_delete_one | 刪除單個文件 |
|
||||
| mongodb_delete_many | 刪除多個文件 |
|
||||
| mongodb_aggregate | 聚合查詢 |
|
||||
|
||||
**範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"database": "momentry",
|
||||
"collection": "videos",
|
||||
"filter": {"uuid": "abc123"}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### qdrant
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| 查詢工具 | 向量搜尋和集合管理 |
|
||||
|
||||
---
|
||||
|
||||
### filesystem
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| read_file | 讀取檔案 |
|
||||
| write_file | 寫入檔案 |
|
||||
| list_directory | 列出目錄 |
|
||||
| create_directory | 建立目錄 |
|
||||
|
||||
---
|
||||
|
||||
### sentry
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| sentry_list_issues | 列出 issues |
|
||||
| sentry_get_issue | 取得 issue 詳情 |
|
||||
| sentry_create_issue | 建立 issue |
|
||||
| sentry_update_issue | 更新 issue |
|
||||
| sentry_list_projects | 列出專案 |
|
||||
| sentry_search_docs | 搜尋 Sentry 文件 |
|
||||
|
||||
**注意**: 需要設定 `SENTRY_ACCESS_TOKEN`
|
||||
|
||||
**取得 Token**:
|
||||
1. 登入 https://sentry.io
|
||||
2. Settings → Developer Tools → API Keys
|
||||
3. 建立新 Token (需要 `event:read`, `project:read` 權限)
|
||||
|
||||
---
|
||||
|
||||
### context7
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| context7_resolve-library-id | 解析函式庫 ID |
|
||||
| context7_query-docs | 查詢函式庫文件 |
|
||||
|
||||
**用途**: 即時技術文件和函式庫查詢,獲取最新的 API 語法和範例。
|
||||
|
||||
---
|
||||
|
||||
### playwright
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| playwright_navigate | 導航到 URL |
|
||||
| playwright_screenshot | 截圖 |
|
||||
| playwright_click | 點擊元素 |
|
||||
| playwright_type | 輸入文字 |
|
||||
| playwright_evaluate | 執行 JavaScript |
|
||||
|
||||
**用途**: 瀏覽器自動化測試、網頁截圖、網頁內容抓取。
|
||||
|
||||
---
|
||||
|
||||
## 管理指令
|
||||
|
||||
### 新增 MCP Server
|
||||
|
||||
```bash
|
||||
opencode mcp add
|
||||
```
|
||||
|
||||
### 列出 MCP Servers
|
||||
|
||||
```bash
|
||||
opencode mcp ls
|
||||
```
|
||||
|
||||
### 認證 OAuth Server
|
||||
|
||||
```bash
|
||||
opencode mcp auth <server-name>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MCP Server 連線失敗
|
||||
|
||||
1. 檢查服務是否運行:
|
||||
```bash
|
||||
# PostgreSQL
|
||||
pg_isready -h localhost -p 5432
|
||||
|
||||
# Redis
|
||||
redis-cli -a accusys ping
|
||||
|
||||
# Qdrant
|
||||
curl -s http://localhost:6333/
|
||||
```
|
||||
|
||||
2. 檢查 MCP Server 是否安裝:
|
||||
```bash
|
||||
which mcp-server-postgres
|
||||
which mcp-server-redis
|
||||
```
|
||||
|
||||
3. 驗證配置格式正確
|
||||
|
||||
---
|
||||
|
||||
### Token 或 API Key 無效
|
||||
|
||||
1. PostgreSQL: 確認使用者名稱和密碼
|
||||
2. Redis: 確認密碼
|
||||
3. n8n: 確認 API Key 未過期
|
||||
4. Gitea: 確認 Token 有效
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| OpenCode 配置 | ~/.config/opencode/opencode.json | MCP 設定檔 |
|
||||
| Gitea MCP | /opt/homebrew/bin/gitea-mcp-server | 安裝路徑 |
|
||||
| n8n MCP | /opt/homebrew/bin/mcp-n8n | 安裝路徑 |
|
||||
| Postgres MCP | /opt/homebrew/bin/mcp-server-postgres | 安裝路徑 |
|
||||
| Redis MCP | /opt/homebrew/bin/mcp-server-redis | 安裝路徑 |
|
||||
| Qdrant MCP | /opt/homebrew/bin/mcp-server-qdrant | 安裝路徑 |
|
||||
| Filesystem MCP | /opt/homebrew/bin/mcp-server-filesystem | 安裝路徑 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 列出所有 MCP servers
|
||||
opencode mcp ls
|
||||
|
||||
# 測試 PostgreSQL MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"query","arguments":{"sql":"SELECT 1;"}}}' | \
|
||||
/opt/homebrew/bin/mcp-server-postgres postgresql://accusys:accusys@localhost:5432/momentry
|
||||
|
||||
# 測試 Redis MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"ping","arguments":{}}}' | \
|
||||
/opt/homebrew/bin/mcp-server-redis redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.0
|
||||
- 安裝日期: 2026-03-24
|
||||
- 文件更新: 2026-03-24
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OpenCode Guide](./OPENCODE_GUIDE.md) - OpenCode 使用指南
|
||||
- [Gitea MCP 安裝](./INSTALL_GITEA_MCP.md) - Gitea MCP 詳細設定
|
||||
- [n8n MCP 設定](./N8N_MCP_SETUP.md) - n8n MCP 詳細設定
|
||||
- [服務總覽](./SERVICES.md) - 所有服務狀態總覽
|
||||
@@ -1,286 +0,0 @@
|
||||
# 人物資料修正機制指南
|
||||
|
||||
> **版本**: 1.0 | **適用**: 前端開發團隊
|
||||
> **目的**: 當發現 Person 綁定資料錯誤時,如何修正
|
||||
|
||||
---
|
||||
|
||||
## 修正場景總覽
|
||||
|
||||
| 錯誤類型 | 修正 API | 可否復原 |
|
||||
|---------|:---:|:---:|
|
||||
| 錯誤綁定 Speaker | `POST /person/:id/unbind-speaker` | ✅ 可重新綁定 |
|
||||
| 綁錯 Speaker | `POST /person/:id/reassign-speaker` | ✅ 可再次修改 |
|
||||
| 錯誤 Appearance | `POST /person/:id/remove-appearance` | ⚠️ 需手動重建 |
|
||||
| Appearance 分錯人 | `POST /person/:id/reassign-appearance` | ✅ 可再轉移 |
|
||||
| 兩人被合併為一人 | `POST /person/:id/split` | ⚠️ 需手動重建原資料 |
|
||||
| 錯誤合併 | `POST /person/merge/undo` | ✅ 可撤銷(需 merge_id) |
|
||||
| 錯誤命名 | `PATCH /person/:id` | ✅ 可隨時修改 |
|
||||
|
||||
---
|
||||
|
||||
## 1. Speaker 綁定修正
|
||||
|
||||
### 1.1 解除 Speaker 綁定
|
||||
|
||||
當發現某人物不應該綁定到某個 Speaker 時:
|
||||
|
||||
```bash
|
||||
curl -X POST "$BASE/api/v1/person/Person_0/unbind-speaker" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"reason": "ASRX 識別錯誤,此人物不是 SPEAKER_0"}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Speaker unbound from person 'Person_0'",
|
||||
"person_id": "Person_0",
|
||||
"reason": "ASRX 識別錯誤,此人物不是 SPEAKER_0"
|
||||
}
|
||||
```
|
||||
|
||||
**效果**:
|
||||
- `speaker_id` 設為 `NULL`
|
||||
- `metadata.speaker_unbound` 設為 `true`
|
||||
- 不影響 `appearance_count` 和 `person_appearances`
|
||||
|
||||
### 1.2 重新綁定 Speaker
|
||||
|
||||
當發現人物應該綁定到不同的 Speaker 時:
|
||||
|
||||
```bash
|
||||
curl -X POST "$BASE/api/v1/person/Person_0/reassign-speaker" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"speaker_id": "SPEAKER_1", "reason": "修正:此人物實際上是 SPEAKER_1"}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Speaker 'SPEAKER_1' assigned to person 'Person_0'",
|
||||
"person_id": "Person_0",
|
||||
"new_speaker_id": "SPEAKER_1",
|
||||
"reason": "修正:此人物實際上是 SPEAKER_1"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Appearance(出場紀錄)修正
|
||||
|
||||
### 2.1 刪除錯誤的 Appearance
|
||||
|
||||
當發現某筆出場紀錄不應該屬於該人物:
|
||||
|
||||
```bash
|
||||
curl -X POST "$BASE/api/v1/person/Person_0/remove-appearance" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"appearance_id": 12345, "reason": "此時間段實際上是空鏡頭"}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Appearance 12345 removed from person 'Person_0'",
|
||||
"appearance_id": 12345,
|
||||
"person_id": "Person_0",
|
||||
"removed_duration": 3.5,
|
||||
"reason": "此時間段實際上是空鏡頭"
|
||||
}
|
||||
```
|
||||
|
||||
**效果**:
|
||||
- 刪除指定的 `person_appearances` 紀錄
|
||||
- 自動更新 `appearance_count` 和 `total_appearance_duration`
|
||||
- 不刪除人物本身
|
||||
|
||||
### 2.2 轉移 Appearance 到另一人物
|
||||
|
||||
當發現某筆出場紀錄應該屬於另一個人物:
|
||||
|
||||
```bash
|
||||
curl -X POST "$BASE/api/v1/person/Person_0/reassign-appearance" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"appearance_id": 12345,
|
||||
"target_person_id": "Person_17",
|
||||
"reason": "此時間段臉孔比對顯示是 Person_17"
|
||||
}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Appearance 12345 reassigned from 'Person_0' to 'Person_17'",
|
||||
"appearance_id": 12345,
|
||||
"from_person_id": "Person_0",
|
||||
"to_person_id": "Person_17",
|
||||
"reason": "此時間段臉孔比對顯示是 Person_17"
|
||||
}
|
||||
```
|
||||
|
||||
**效果**:
|
||||
- 更新 `person_appearances.person_id`
|
||||
- 自動調整兩個人物的 `appearance_count` 和 `total_appearance_duration`
|
||||
|
||||
---
|
||||
|
||||
## 3. 人物分割(Split)
|
||||
|
||||
當發現兩個人物被錯誤地識別為同一人時:
|
||||
|
||||
```bash
|
||||
curl -X POST "$BASE/api/v1/person/Person_0/split" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"new_person_id": "Person_0_split",
|
||||
"appearance_ids_to_move": [12345, 12346, 12347],
|
||||
"new_person_name": "Unknown Person",
|
||||
"reason": "Person_0 實際上是兩個不同的人"
|
||||
}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Person 'Person_0' split into 'Person_0_split' with 3 appearances moved",
|
||||
"original_person_id": "Person_0",
|
||||
"new_person_id": "Person_0_split",
|
||||
"appearances_moved": 3,
|
||||
"new_person_duration": 12.5,
|
||||
"new_person_first": 5730.0,
|
||||
"new_person_last": 5745.0,
|
||||
"reason": "Person_0 實際上是兩個不同的人"
|
||||
}
|
||||
```
|
||||
|
||||
**效果**:
|
||||
- 建立新人物 `Person_0_split`
|
||||
- 將指定的 `person_appearances` 移至新人物
|
||||
- 自動更新兩個人物的統計數據
|
||||
- 新人物的 `metadata.split_from` 記錄原始人物 ID
|
||||
|
||||
---
|
||||
|
||||
## 4. 合併撤銷
|
||||
|
||||
當發現合併錯誤時:
|
||||
|
||||
```bash
|
||||
# 查看合併歷史
|
||||
curl "$BASE/api/v1/person/merge/history" -H "X-API-Key: $KEY"
|
||||
|
||||
# 撤銷合併
|
||||
curl -X POST "$BASE/api/v1/person/merge/undo" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"merge_id": "5b12e3ac-12fa-45c0-88e1-5cff67604a7d"}'
|
||||
```
|
||||
|
||||
**⚠️ 限制**: 只有透過 API 執行的合併才有歷史記錄,可撤銷。
|
||||
|
||||
---
|
||||
|
||||
## 5. 名稱修正
|
||||
|
||||
最簡單的修正,隨時可改:
|
||||
|
||||
```bash
|
||||
curl -X PATCH "$BASE/api/v1/person/Person_0" \
|
||||
-H "X-API-Key: $KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "Cary Grant",
|
||||
"is_confirmed": true,
|
||||
"metadata": {
|
||||
"corrected_by": "user123",
|
||||
"correction_date": "2026-04-14"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 完整修正流程範例
|
||||
|
||||
### 情境:Person_0 被錯誤識別
|
||||
|
||||
```
|
||||
1. 發現問題:Person_0 綁定到 SPEAKER_0,但實際上 30% 的出場是另一人
|
||||
|
||||
2. 解除錯誤綁定(可選)
|
||||
POST /api/v1/person/Person_0/unbind-speaker
|
||||
→ speaker_id = NULL
|
||||
|
||||
3. 找出錯誤的 appearances
|
||||
GET /api/v1/person/Person_0/appearances
|
||||
→ 檢視每筆出場紀錄的時間戳
|
||||
|
||||
4. 將錯誤 appearances 轉移到新人物
|
||||
# 建立新人物(由 split API 自動建立)
|
||||
POST /api/v1/person/Person_0/split
|
||||
{
|
||||
"new_person_id": "Person_100",
|
||||
"appearance_ids_to_move": [12340, 12341, ...],
|
||||
"new_person_name": "Unknown Actor"
|
||||
}
|
||||
|
||||
5. 重新綁定正確的 speaker
|
||||
POST /api/v1/person/Person_0/reassign-speaker
|
||||
{"speaker_id": "SPEAKER_0"}
|
||||
|
||||
6. 為新人物命名
|
||||
PATCH /api/v1/person/Person_100
|
||||
{"name": "Supporting Actor"}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 速查表
|
||||
|
||||
| 修正類型 | 方法 | 端點 |
|
||||
|---------|:---:|------|
|
||||
| 解除 Speaker | POST | `/api/v1/person/:id/unbind-speaker` |
|
||||
| 重新綁定 Speaker | POST | `/api/v1/person/:id/reassign-speaker` |
|
||||
| 刪除 Appearance | POST | `/api/v1/person/:id/remove-appearance` |
|
||||
| 轉移 Appearance | POST | `/api/v1/person/:id/reassign-appearance` |
|
||||
| 分割人物 | POST | `/api/v1/person/:id/split` |
|
||||
| 撤銷合併 | POST | `/api/v1/person/merge/undo` |
|
||||
| 查看合併歷史 | GET | `/api/v1/person/merge/history` |
|
||||
| 修改名稱 | PATCH | `/api/v1/person/:id` |
|
||||
|
||||
---
|
||||
|
||||
## 注意事項
|
||||
|
||||
### 哪些修正可以完全復原?
|
||||
|
||||
| 修正類型 | 復原方式 |
|
||||
|---------|---------|
|
||||
| 解除 Speaker | 使用 `reassign-speaker` 重新綁定 |
|
||||
| 重新綁定 Speaker | 再次使用 `reassign-speaker` |
|
||||
| 刪除 Appearance | ⚠️ 無法自動復原,需手動重建 |
|
||||
| 轉移 Appearance | 使用 `reassign-appearance` 轉移回去 |
|
||||
| 分割人物 | ⚠️ 無法自動復原,需使用合併 API |
|
||||
| 撤銷合併 | 無法再次撤銷(已撤銷過) |
|
||||
| 修改名稱 | 再次使用 `PATCH` |
|
||||
|
||||
### 建議操作順序
|
||||
|
||||
1. **先檢視**: 使用 `GET /person/:id/appearances` 確認哪些資料錯誤
|
||||
2. **小幅度修正**: 先嘗試 `unbind-speaker` 或 `reassign-appearance`
|
||||
3. **大幅度修正**: 如需要分割人物,使用 `split`
|
||||
4. **記錄原因**: 每個修正 API 都支援 `reason` 欄位,建議填寫
|
||||
|
||||
### 資料完整性
|
||||
|
||||
所有修正操作都會:
|
||||
- 自動更新 `appearance_count` 和 `total_appearance_duration`
|
||||
- 在 `metadata` 中記錄修正痕跡
|
||||
- 使用資料庫交易確保一致性
|
||||
@@ -1,267 +0,0 @@
|
||||
# Portal 适配 Birth UUID 完成报告
|
||||
|
||||
## 修改日期
|
||||
2026-04-28
|
||||
|
||||
---
|
||||
|
||||
## 背景
|
||||
|
||||
Birth UUID Phase 1 MVP 实施后,需要确认 Portal 是否需要修改以适配新的 UUID 格式。
|
||||
|
||||
---
|
||||
|
||||
## Birth UUID 规格
|
||||
|
||||
| 项目 | 内容 |
|
||||
|------|------|
|
||||
| **格式** | SHA256[mac|timestamp|username|filename](0:32) |
|
||||
| **长度** | 32字符(比旧UUID的16字符更长) |
|
||||
| **唯一性** | MAC + Timestamp确保全球唯一 |
|
||||
| **隐私保护** | MAC不直接暴露(哈希在UUID内) |
|
||||
| **不可变** | 文件迁移不影响UUID |
|
||||
|
||||
---
|
||||
|
||||
## Portal 分析结果
|
||||
|
||||
### ✅ 前端无需强制修改
|
||||
|
||||
**原因**:
|
||||
1. UUID显示使用CSS `truncate`,可自动截断长文本
|
||||
2. API调用使用`uuid`参数,无长度限制
|
||||
3. 路由`/videos/:uuid`可接受任意长度字符串
|
||||
4. 向后兼容:16字符旧UUID和32字符新UUID都能正常工作
|
||||
|
||||
### 🔧 后端需要修改
|
||||
|
||||
**原因**:
|
||||
- API返回的`VideoRecord`缺少`birth_registration`字段
|
||||
- 需要在API响应中包含注册来源信息
|
||||
|
||||
---
|
||||
|
||||
## 实施修改
|
||||
|
||||
### 后端修改(Rust)
|
||||
|
||||
#### 1. VideoRecord 添加字段
|
||||
```rust
|
||||
// src/core/db/postgres_db.rs Line 158-177
|
||||
pub struct VideoRecord {
|
||||
pub birth_registration: Option<serde_json::Value>,
|
||||
// ... 其他字段
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. VideoRow 添加字段
|
||||
```rust
|
||||
// src/core/db/postgres_db.rs Line 99-124
|
||||
pub struct VideoRow {
|
||||
pub birth_registration: Option<serde_json::Value>,
|
||||
// ... 其他字段
|
||||
}
|
||||
```
|
||||
|
||||
#### 3. VideoInfoResponse 添加字段
|
||||
```rust
|
||||
// src/api/server.rs Line 361-375
|
||||
struct VideoInfoResponse {
|
||||
birth_registration: Option<serde_json::Value>,
|
||||
// ... 其他字段
|
||||
}
|
||||
```
|
||||
|
||||
#### 4. SELECT 查询修改
|
||||
```sql
|
||||
-- Line 770, 838, 920
|
||||
SELECT id, uuid, ..., birth_registration, ..., total_frames FROM videos
|
||||
```
|
||||
|
||||
#### 5. 构造函数修改
|
||||
- `From<VideoRow> for VideoRecord`(Line 125-155)
|
||||
- `ingestion.rs` VideoRecord构造(Line 146-164)
|
||||
- `server.rs` VideoRecord构造(Line 802-820)
|
||||
- 测试代码(Line 4489-4514)
|
||||
|
||||
---
|
||||
|
||||
### 前端修改(Vue)
|
||||
|
||||
#### 1. UUID显示优化
|
||||
```vue
|
||||
<!-- VideoDetailView.vue Line 17-20 -->
|
||||
<div>
|
||||
<span class="text-xs text-gray-500 uppercase">UUID</span>
|
||||
<p class="text-sm font-mono text-gray-300 truncate">{{ video.uuid }}</p>
|
||||
<p class="text-xs text-gray-600 mt-1">長度: {{ video.uuid.length }} 字符</p>
|
||||
</div>
|
||||
```
|
||||
|
||||
#### 2. Birth Registration 显示区域
|
||||
```vue
|
||||
<!-- VideoDetailView.vue Line 33-48 -->
|
||||
<div v-if="video.birth_registration" class="mt-4 bg-gray-850 p-3 rounded border border-gray-600">
|
||||
<h4 class="text-xs font-semibold text-gray-400 mb-2 uppercase">註冊來源資訊</h4>
|
||||
<div class="grid grid-cols-2 md:grid-cols-4 gap-3">
|
||||
<div>
|
||||
<span class="text-xs text-gray-600">用戶名:</span>
|
||||
<p class="text-sm text-gray-300">{{ video.birth_registration.registration_source?.username }}</p>
|
||||
</div>
|
||||
<div>
|
||||
<span class="text-xs text-gray-600">註冊時間:</span>
|
||||
<p class="text-sm text-gray-300">{{ formatTimestamp(video.birth_registration.registration_source?.timestamp) }}</p>
|
||||
</div>
|
||||
<div>
|
||||
<span class="text-xs text-gray-600">原始檔名:</span>
|
||||
<p class="text-sm text-gray-300 truncate">{{ video.birth_registration.registration_source?.original_filename }}</p>
|
||||
</div>
|
||||
<div>
|
||||
<span class="text-xs text-gray-600">UUID類型:</span>
|
||||
<p class="text-sm text-gray-300">{{ video.uuid.length === 32 ? 'Birth UUID' : 'Legacy UUID' }}</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
#### 3. 时间格式化函数
|
||||
```typescript
|
||||
function formatTimestamp(timestamp: string | undefined): string {
|
||||
if (!timestamp) return '-'
|
||||
try {
|
||||
const date = new Date(timestamp)
|
||||
return date.toLocaleString('zh-TW', {
|
||||
year: 'numeric',
|
||||
month: '2-digit',
|
||||
day: '2-digit',
|
||||
hour: '2-digit',
|
||||
minute: '2-digit'
|
||||
})
|
||||
} catch {
|
||||
return timestamp
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## birth_registration JSONB 结构
|
||||
|
||||
```json
|
||||
{
|
||||
"registration_source": {
|
||||
"mac_address": "ba:f5:ee:bc:45:78",
|
||||
"username": "demo",
|
||||
"timestamp": "2026-04-27T22:00:00+08:00",
|
||||
"original_path": "/Users/.../demo",
|
||||
"original_filename": "video.mp4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 响应示例
|
||||
|
||||
### 旧UUID视频(16字符)
|
||||
```json
|
||||
{
|
||||
"uuid": "ac625815183a21e1",
|
||||
"birth_registration": null,
|
||||
"file_name": "video.mp4",
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
### 新UUID视频(32字符)
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
|
||||
"birth_registration": {
|
||||
"registration_source": {
|
||||
"mac_address": "ba:f5:ee:bc:45:78",
|
||||
"username": "demo",
|
||||
"timestamp": "2026-04-27T22:00:00+08:00",
|
||||
"original_filename": "video.mp4"
|
||||
}
|
||||
},
|
||||
"file_name": "video.mp4",
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 向后兼容性
|
||||
|
||||
| UUID类型 | 长度 | birth_registration | Portal显示 |
|
||||
|---------|------|-------------------|-----------|
|
||||
| **旧UUID** | 16字符 | null | 显示UUID,隐藏birth_registration区域 |
|
||||
| **新UUID** | 32字符 | 有数据 | 显示UUID,显示birth_registration区域 |
|
||||
|
||||
---
|
||||
|
||||
## 测试验证计划
|
||||
|
||||
### 步骤 1: 编译测试
|
||||
```bash
|
||||
# 检查编译(birth_registration相关错误已修复)
|
||||
cargo check --lib
|
||||
```
|
||||
|
||||
### 步骤 2: 注册新视频
|
||||
```bash
|
||||
# 使用Birth UUID注册
|
||||
cargo run -- register /path/to/new_video.mp4
|
||||
```
|
||||
|
||||
### 步骤 3: 检查数据库
|
||||
```sql
|
||||
SELECT uuid, LENGTH(uuid), birth_registration
|
||||
FROM dev.videos
|
||||
WHERE birth_registration IS NOT NULL;
|
||||
```
|
||||
|
||||
### 步骤 4: API测试
|
||||
```bash
|
||||
# 查询新UUID视频
|
||||
curl http://localhost:3003/api/v1/videos?uuid=<32字符UUID>
|
||||
```
|
||||
|
||||
### 步骤 5: Portal显示测试
|
||||
- 打开Portal `/videos/<32字符UUID>`
|
||||
- 确认UUID显示为32字符
|
||||
- 确认birth_registration区域显示注册信息
|
||||
|
||||
---
|
||||
|
||||
## 修改文件清单
|
||||
|
||||
| 文件 | 修改内容 |
|
||||
|------|---------|
|
||||
| `/src/core/db/postgres_db.rs` | VideoRecord/VideoRow添加字段,SELECT查询修改 |
|
||||
| `/src/api/server.rs` | VideoInfoResponse添加字段,构造函数修改 |
|
||||
| `/src/core/ingestion.rs` | VideoRecord构造添加birth_registration: None |
|
||||
| `/portal/src/views/VideoDetailView.vue` | UUID显示优化,birth_registration显示区域 |
|
||||
|
||||
---
|
||||
|
||||
## 总结
|
||||
|
||||
✅ **Portal已完全适配Birth UUID**
|
||||
|
||||
### 关键成果
|
||||
1. ✅ 后端API返回`birth_registration`字段
|
||||
2. ✅ 前端显示Birth UUID长度和注册来源信息
|
||||
3. ✅ 向后兼容16字符旧UUID
|
||||
4. ✅ 新视频注册时自动记录`birth_registration`
|
||||
|
||||
### 下一步
|
||||
1. 修复遗留编译错误(redis、SCRIPTS_DIR、PYTHON_PATH)
|
||||
2. 实际注册新视频验证Birth UUID流程
|
||||
3. Portal端到端测试
|
||||
|
||||
---
|
||||
|
||||
**完成日期**: 2026-04-28
|
||||
**状态**: 后端+前端修改完成,待测试验证
|
||||
@@ -1,586 +0,0 @@
|
||||
# Momentry API 使用說明 (curl 範例)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V1.4 |
|
||||
| 日期 | 2026-03-26 |
|
||||
| Base URL | `http://localhost:3002` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.4 | 2026-03-26 | 新增: 任務管理端點 (`/api/v1/jobs`, `/api/v1/jobs/:uuid`),更新註冊端點回應格式 | OpenCode | deepseek-reasoner |
|
||||
| V1.3 | 2026-03-25 | 更新: n8n 搜尋回傳 `file_path` 取代 `media_url`,新增 API Key 驗證說明 | OpenCode | deepseek-reasoner |
|
||||
| V1.2 | 2026-03-23 | 建立 curl 範例文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-18 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
> **狀態說明**:
|
||||
> - ✅ **已實作**: 健康檢查、搜尋、影片管理端點
|
||||
> - ⚠️ **規劃中**: API Key 管理功能
|
||||
> - 🔧 **CLI**: 部分功能需使用命令列工具
|
||||
|
||||
---
|
||||
|
||||
## 目錄
|
||||
|
||||
1. [已實作端點](#1-已實作端點)
|
||||
2. [API Key 管理](#2-api-key-管理-規劃中)
|
||||
3. [影片管理](#3-影片管理)
|
||||
4. [查詢與搜索](#4-查詢與搜索)
|
||||
5. [系統狀態](#5-系統狀態)
|
||||
|
||||
---
|
||||
|
||||
## URL 選擇指南
|
||||
|
||||
### 兩種 URL 的使用情境
|
||||
|
||||
| 環境 | URL | 說明 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 直接訪問 API,繞過反向代理 |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | 通過 Caddy 反向代理訪問,需網路可達 |
|
||||
|
||||
### 何時使用 localhost:3002
|
||||
|
||||
- ✅ 開發/測試環境
|
||||
- ✅ 直接在伺服器上操作
|
||||
- ✅ 當 Caddy/反向代理有問題時
|
||||
- ✅ 需要快速除錯時
|
||||
|
||||
### 何時使用 api.momentry.ddns.net
|
||||
|
||||
- ✅ n8n workflow 中呼叫 API
|
||||
- ✅ 外部系統整合
|
||||
- ✅ 生產環境
|
||||
- ✅ 從其他機器訪問
|
||||
|
||||
### 快速切換範例
|
||||
|
||||
```bash
|
||||
# 本地測試
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 外部測試(功能相同)
|
||||
curl https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
### 常見問題
|
||||
|
||||
**Q: 為什麼有兩個 URL?**
|
||||
A: `localhost:3002` 是直接訪問,`api.momentry.ddns.net` 通過 Caddy 反向代理。
|
||||
|
||||
**Q: 兩者功能相同嗎?**
|
||||
A: 是的,所有端點和功能完全相同。
|
||||
|
||||
**Q: 502 錯誤時怎麼辦?**
|
||||
A: 如果 `api.momentry.ddns.net` 返回 502,檢查 Momentry API 服務是否運行:
|
||||
```bash
|
||||
launchctl list | grep momentry.api
|
||||
# 如果未運行
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 認證
|
||||
|
||||
所有 `/api/v1/*` 端點(除了健康檢查)都需要 API Key 認證。請在請求標頭中加入:
|
||||
|
||||
```
|
||||
-H "X-API-Key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
**目前示範使用的 API Key**: `demo_api_key_12345`
|
||||
|
||||
> **注意**: 正式環境請使用安全的 API Key 管理機制。
|
||||
|
||||
---
|
||||
|
||||
## 1. 已實作端點
|
||||
|
||||
### 健康檢查
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 詳細健康檢查
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. API Key 管理 *(規劃中)*
|
||||
|
||||
> ⚠️ **此功能尚未實作**。以下為規劃中的 API 說明,僅供參考。
|
||||
|
||||
### 2.1 建立 API Key
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/api-keys \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: your-admin-key" \
|
||||
-d '{
|
||||
"name": "my-service-key",
|
||||
"key_type": "service",
|
||||
"permissions": ["read", "write"],
|
||||
"ttl_days": 90
|
||||
}'
|
||||
```
|
||||
|
||||
### 2.2 列出所有 API Keys
|
||||
|
||||
```bash
|
||||
curl -X GET http://localhost:3002/api/v1/api-keys \
|
||||
-H "X-API-Key: your-admin-key"
|
||||
```
|
||||
|
||||
### 2.3 驗證 API Key
|
||||
|
||||
```bash
|
||||
curl -X GET http://localhost:3002/api/v1/api-keys/validate \
|
||||
-H "X-API-Key: key-to-validate"
|
||||
```
|
||||
|
||||
### 2.4 撤銷 API Key
|
||||
|
||||
```bash
|
||||
curl -X DELETE http://localhost:3002/api/v1/api-keys/msvc_a1b2c3d4_... \
|
||||
-H "X-API-Key: your-admin-key"
|
||||
```
|
||||
|
||||
### 2.5 請求 Key 輪換
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/api-keys/msvc_a1b2c3d4_.../rotate \
|
||||
-H "X-API-Key: your-admin-key" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"reason": "scheduled_rotation"}'
|
||||
```
|
||||
|
||||
### 2.6 取得統計資訊
|
||||
|
||||
```bash
|
||||
curl -X GET http://localhost:3002/api/v1/api-keys/stats \
|
||||
-H "X-API-Key: your-admin-key"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 影片管理
|
||||
|
||||
### 3.1 註冊影片 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"video_id": 1,
|
||||
"job_id": 123,
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"already_exists": false
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 列出所有影片 ✅
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 3.3 查詢影片 ✅
|
||||
|
||||
```bash
|
||||
# 依 UUID 查詢
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?uuid=a1b2c3d4e5f6g7h8"
|
||||
|
||||
# 依路徑查詢
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?path=/path/to/video.mp4"
|
||||
```
|
||||
|
||||
### 3.4 處理影片 🔧 *(CLI - 非 API)*
|
||||
|
||||
影片處理需要使用 CLI 命令:
|
||||
|
||||
```bash
|
||||
# 處理影片(生成 ASR, CUT, YOLO, OCR, Face, Pose 資料)
|
||||
cargo run --bin momentry -- process <uuid>
|
||||
|
||||
# 或處理多個影片
|
||||
cargo run --bin momentry -- process <uuid1> <uuid2> <uuid3>
|
||||
```
|
||||
|
||||
### 3.5 取得處理進度 ✅
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/progress/<uuid>
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"overall_progress": 75,
|
||||
"processors": [
|
||||
{
|
||||
"name": "asr",
|
||||
"status": "complete",
|
||||
"current": 100,
|
||||
"total": 100,
|
||||
"progress": 100,
|
||||
"message": "7 segments"
|
||||
},
|
||||
{
|
||||
"name": "cut",
|
||||
"status": "complete",
|
||||
"current": 134,
|
||||
"total": 134,
|
||||
"progress": 100,
|
||||
"message": "134 scenes"
|
||||
},
|
||||
{
|
||||
"name": "yolo",
|
||||
"status": "progress",
|
||||
"current": 5000,
|
||||
"total": 14315,
|
||||
"progress": 35,
|
||||
"message": "frame 5000"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 3.6 任務管理 ✅
|
||||
|
||||
```bash
|
||||
# 列出所有任務
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/jobs
|
||||
|
||||
# 取得特定任務詳情
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/jobs/<uuid>
|
||||
```
|
||||
|
||||
**任務列表回應範例**:
|
||||
```json
|
||||
{
|
||||
"jobs": [
|
||||
{
|
||||
"id": 123,
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"status": "pending",
|
||||
"current_processor": null,
|
||||
"progress_current": 0,
|
||||
"progress_total": 100,
|
||||
"created_at": "2026-03-26 10:30:00",
|
||||
"started_at": null
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**任務詳情回應範例**:
|
||||
```json
|
||||
{
|
||||
"id": 123,
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"status": "processing",
|
||||
"current_processor": "asr",
|
||||
"progress_current": 50,
|
||||
"progress_total": 100,
|
||||
"processors": [
|
||||
{
|
||||
"processor_type": "asr",
|
||||
"status": "complete",
|
||||
"started_at": "2026-03-26 10:30:00",
|
||||
"completed_at": "2026-03-26 10:35:00",
|
||||
"duration_secs": 300.5,
|
||||
"error_message": null
|
||||
},
|
||||
{
|
||||
"processor_type": "cut",
|
||||
"status": "pending",
|
||||
"started_at": null,
|
||||
"completed_at": null,
|
||||
"duration_secs": null,
|
||||
"error_message": null
|
||||
}
|
||||
],
|
||||
"created_at": "2026-03-26 10:30:00",
|
||||
"started_at": "2026-03-26 10:30:00",
|
||||
"updated_at": "2026-03-26 10:35:00"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 查詢與搜索
|
||||
|
||||
### 4.1 語意搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b2c3d4e5f6g7h8",
|
||||
"chunk_id": "sentence_0006",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.526
|
||||
}
|
||||
],
|
||||
"query": "測試關鍵字"
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 n8n 格式搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "測試關鍵字",
|
||||
"count": 2,
|
||||
"hits": [
|
||||
{
|
||||
"id": "c_001",
|
||||
"vid": "a1b2c3d4e5f6g7h8",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0006",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.3 混合搜尋 ✅
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/hybrid \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{
|
||||
"query": "測試關鍵字",
|
||||
"limit": 5
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 系統狀態
|
||||
|
||||
### 5.1 健康檢查 ✅
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 5.2 詳細健康檢查 ✅
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"status":"ok",
|
||||
"version":"0.1.0",
|
||||
"uptime_ms":123456,
|
||||
"services":{
|
||||
"postgres":{"status":"ok","latency_ms":42,"error":null},
|
||||
"redis":{"status":"ok","latency_ms":0,"error":null},
|
||||
"qdrant":{"status":"ok","latency_ms":15,"error":null}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. n8n Webhook 測試
|
||||
|
||||
### 測試 n8n Workflow
|
||||
|
||||
**重要**: 測試前請先在 n8n UI 中點擊 "Execute workflow" 按鈕
|
||||
|
||||
```bash
|
||||
# 測試 Video RAG Workflow (Test Mode)
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
|
||||
# 帶有 UUID 過濾的搜尋
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"woody","limit":5,"uuid":"a1b10138a6bbb0cd"}'
|
||||
```
|
||||
|
||||
### 生產環境 Webhook
|
||||
|
||||
**注意**: 工作流程必須處於 Active 狀態
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:5678/webhook/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
### n8n Webhook 常見問題
|
||||
|
||||
**Q: webhook-test 返回 404**
|
||||
A: 需要在 n8n UI 中點擊 "Execute workflow" 按鈕後才能使用 test webhook
|
||||
|
||||
**Q: webhook (生產環境) 返回 404**
|
||||
A: 需要將工作流程切換為 Active 狀態 (右上角開關)
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. 服務 URL 列表
|
||||
|
||||
| 服務 | URL |
|
||||
|------|-----|
|
||||
| Momentry API (本地) | `http://localhost:3002` |
|
||||
| Momentry API (外部) | `https://api.momentry.ddns.net` |
|
||||
| n8n Web UI | `https://n8n.momentry.ddns.net` |
|
||||
| n8n Webhook Test | `http://localhost:5678/webhook-test/{workflow-name}` |
|
||||
| n8n Webhook Prod | `http://localhost:5678/webhook/{workflow-name}` |
|
||||
|
||||
### B. 所有可用端點
|
||||
|
||||
| 端點 | 方法 | 狀態 | 說明 |
|
||||
|------|------|------|------|
|
||||
| `/health` | GET | ✅ | 健康檢查 |
|
||||
| `/health/detailed` | GET | ✅ | 詳細健康檢查 |
|
||||
| `/api/v1/register` | POST | ✅ | 註冊影片 |
|
||||
| `/api/v1/search` | POST | ✅ | 語意搜尋 |
|
||||
| `/api/v1/n8n/search` | POST | ✅ | n8n 格式搜尋 |
|
||||
| `/api/v1/search/hybrid` | POST | ✅ | 混合搜尋 |
|
||||
| `/api/v1/lookup` | GET | ✅ | 查詢影片 |
|
||||
| `/api/v1/videos` | GET | ✅ | 列出所有影片 |
|
||||
| `/api/v1/progress/:uuid` | GET | ✅ | 處理進度 |
|
||||
| `/api/v1/jobs` | GET | ✅ | 任務列表 |
|
||||
| `/api/v1/jobs/:uuid` | GET | ✅ | 任務詳情 |
|
||||
| `/api/v1/api-keys` | * | ⚠️ | API Key 管理 (規劃中) |
|
||||
|
||||
### C. 常見錯誤
|
||||
|
||||
| HTTP 狀態 | 說明 | 解決方式 |
|
||||
|-----------|------|----------|
|
||||
| 200 | 成功 | - |
|
||||
| 400 | 請求格式錯誤 | 檢查 JSON 格式 |
|
||||
| 404 | 端點不存在或資源未找到 | 確認端點 URL 正確 |
|
||||
| 500 | 伺服器內部錯誤 | 檢查 API 服務日誌 |
|
||||
| **502** | **Bad Gateway** | **API 服務未啟動,見下方說明** |
|
||||
|
||||
#### 502 Bad Gateway 錯誤
|
||||
|
||||
**問題**: 外部 URL `https://api.momentry.ddns.net` 返回 502
|
||||
|
||||
**原因**: Momentry Core API 服務未啟動
|
||||
|
||||
**解決方式**:
|
||||
|
||||
```bash
|
||||
# 1. 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 2. 如果未啟動,手動啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 3. 或使用本地測試(繞過反向代理)
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 4. 檢查日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
### D. 範例腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# api_test.sh - API 測試腳本
|
||||
|
||||
API_URL="http://localhost:3002"
|
||||
|
||||
# 健康檢查
|
||||
echo "=== Health Check ==="
|
||||
curl -s "$API_URL/health" | jq .
|
||||
|
||||
# 搜尋
|
||||
echo -e "\n=== Search ==="
|
||||
curl -s -X POST "$API_URL/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "test", "limit": 3}' | jq .
|
||||
|
||||
# 列出影片
|
||||
echo -e "\n=== Videos ==="
|
||||
curl -s -H "X-API-Key: YOUR_API_KEY" "$API_URL/api/v1/videos" | jq '.videos | length'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽(起點)
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 使用範例
|
||||
- [API_WORDPRESS_GUIDE.md](./API_WORDPRESS_GUIDE.md) - WordPress 使用範例
|
||||
@@ -1,771 +0,0 @@
|
||||
# Momentry Core API 使用範例總覽
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V2.1 |
|
||||
| 日期 | 2026-03-26 |
|
||||
| Base URL (本地) | `http://localhost:3002` |
|
||||
| Base URL (外部) | `https://api.momentry.ddns.net` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V2.0 | 2026-03-25 | 創建完整範例總覽 | OpenCode |
|
||||
| V2.1 | 2026-03-26 | 更新API回應格式 (media_url→file_path) 與認證標頭 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 快速參考
|
||||
|
||||
### 環境 URL 選擇
|
||||
|
||||
| 環境 | URL | 用途 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 開發/測試,直接訪問 API |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | n8n、WordPress、curl 生產環境 |
|
||||
|
||||
### 所有可用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| GET | `/health/detailed` | 詳細健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋(標準格式) |
|
||||
| POST | `/api/v1/n8n/search` | 語意搜尋(n8n 格式) |
|
||||
| POST | `/api/v1/search/hybrid` | 混合搜尋 |
|
||||
| POST | `/api/v1/register` | 註冊影片 |
|
||||
| POST | `/api/v1/probe` | 探測影片資訊 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 |
|
||||
|
||||
---
|
||||
|
||||
## 認證
|
||||
|
||||
### API Key
|
||||
|
||||
所有 `/api/v1/*` 端點需要 API Key 認證。
|
||||
|
||||
```bash
|
||||
# 添加 API Key Header
|
||||
curl -H "X-API-Key: your-api-key" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 範例
|
||||
curl -H "X-API-Key: muser_f08e13ba967e4d8ea8fc542ad9f99ac8_1774416728_90472a35" \
|
||||
http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 響應狀態
|
||||
|
||||
| 狀態碼 | 說明 |
|
||||
|--------|------|
|
||||
| 200 | 成功 |
|
||||
| 401 | 未授權(缺少或無效 API Key) |
|
||||
| 500 | 伺服器錯誤 |
|
||||
|
||||
### 建立 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key create "My Key" --key-type user
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 1. curl 範例
|
||||
|
||||
### 基本語法
|
||||
|
||||
```bash
|
||||
# 格式
|
||||
curl [OPTIONS] URL
|
||||
|
||||
# 常用選項
|
||||
-X METHOD # HTTP 方法 (GET, POST, etc.)
|
||||
-H HEADER # 添加 HTTP 標頭
|
||||
-d DATA # POST 請求體
|
||||
-s # 靜默模式
|
||||
-w FORMAT # 輸出額外信息
|
||||
```
|
||||
|
||||
### 1.1 健康檢查
|
||||
|
||||
```bash
|
||||
# 基本健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
**回應**:
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":123456}
|
||||
```
|
||||
|
||||
### 1.2 語意搜尋
|
||||
|
||||
```bash
|
||||
# 標準格式搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
|
||||
# n8n 格式搜尋(推薦)
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
|
||||
# 混合搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search/hybrid \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
```
|
||||
|
||||
**標準格式回應**:
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "sentence_0001",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92
|
||||
}
|
||||
],
|
||||
"query": "charade"
|
||||
}
|
||||
```
|
||||
|
||||
**n8n 格式回應**:
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 1,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0001",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0001",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 1.3 影片管理
|
||||
|
||||
```bash
|
||||
# 列出所有影片
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 查詢特定影片(依 UUID)
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?uuid=a1b10138a6bbb0cd"
|
||||
|
||||
# 查詢特定影片(依路徑)
|
||||
curl -H "X-API-Key: YOUR_API_KEY" "http://localhost:3002/api/v1/lookup?path=/path/to/video.mp4"
|
||||
|
||||
# 取得處理進度
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/progress/a1b10138a6bbb0cd
|
||||
|
||||
# 探測影片(不註冊)
|
||||
curl -X POST http://localhost:3002/api/v1/probe \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
|
||||
# 註冊影片
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "/path/to/video.mp4"}'
|
||||
```
|
||||
|
||||
### 1.4 批次測試腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# api_test.sh - API 測試腳本
|
||||
|
||||
API_URL="http://localhost:3002"
|
||||
|
||||
echo "=== 健康檢查 ==="
|
||||
curl -s "$API_URL/health" | jq .
|
||||
|
||||
echo -e "\n=== 語意搜尋 ==="
|
||||
curl -s -X POST "$API_URL/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}' | jq .
|
||||
|
||||
echo -e "\n=== 影片列表 ==="
|
||||
curl -s -H "X-API-Key: YOUR_API_KEY" "$API_URL/api/v1/videos" | jq '.videos | length'
|
||||
```
|
||||
|
||||
### 1.5 外部 URL 範例
|
||||
|
||||
```bash
|
||||
# 使用外部 URL(需網路可達)
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 外部搜尋
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 5}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. n8n 範例
|
||||
|
||||
### 2.1 HTTP Request Node 設定
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit || 10 }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 2.2 基本搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Video Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Search Video API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.3 Webhook 動態搜尋
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Dynamic Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {
|
||||
"httpMethod": "POST",
|
||||
"path": "search",
|
||||
"responseMode": "lastNode"
|
||||
},
|
||||
"name": "Webhook",
|
||||
"type": "n8n-nodes-base.webhook",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "={{ JSON.stringify($json.body.query) }}",
|
||||
"limit": "={{ $json.body.limit || 5 }}"
|
||||
}
|
||||
},
|
||||
"name": "Search API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Webhook": {
|
||||
"main": [[{"node": "Search API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 測試 Webhook
|
||||
|
||||
```bash
|
||||
# 測試模式(需先在 n8n UI 點擊 Execute)
|
||||
curl -X POST http://localhost:5678/webhook-test/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
|
||||
# 生產環境(需 workflow 為 Active 狀態)
|
||||
curl -X POST http://localhost:5678/webhook/video-rag-mcp \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
### 2.5 健康檢查 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Health Check",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/health",
|
||||
"method": "GET"
|
||||
},
|
||||
"name": "Health Check",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Health Check"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.6 錯誤處理
|
||||
|
||||
| 錯誤 | 原因 | 解決 |
|
||||
|------|------|------|
|
||||
| 502 Bad Gateway | API 服務未啟動 | `sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist` |
|
||||
| "Your request is invalid" | Body 格式設定錯誤 | 確認 Content Type: JSON,Body 為有效 JSON |
|
||||
| 404 on webhook-test | 未執行 workflow | 在 n8n UI 點擊 "Execute workflow" |
|
||||
|
||||
---
|
||||
|
||||
## 3. WordPress 範例
|
||||
|
||||
### 3.1 PHP 基本用法
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 搜尋影片
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/n8n/search';
|
||||
|
||||
$data = [
|
||||
'query' => 'charade',
|
||||
'limit' => 10
|
||||
];
|
||||
|
||||
$response = wp_remote_post($api_url, [
|
||||
'headers' => ['Content-Type' => 'application/json'],
|
||||
'body' => json_encode($data),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
echo '錯誤: ' . $response->get_error_message();
|
||||
} else {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
print_r($body['hits']);
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.2 列出影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/videos';
|
||||
|
||||
$response = wp_remote_get($api_url, ['timeout' => 30]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
foreach ($body['videos'] as $video) {
|
||||
echo $video['file_name'] . "\n";
|
||||
}
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.3 查詢特定影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$uuid = 'a1b10138a6bbb0cd';
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/lookup?uuid=' . $uuid;
|
||||
|
||||
$response = wp_remote_get($api_url, ['timeout' => 30]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$video = json_decode(wp_remote_retrieve_body($response), true);
|
||||
echo '檔案: ' . $video['file_name'] . "\n";
|
||||
echo '時長: ' . $video['duration'] . ' 秒';
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 3.4 JavaScript fetch
|
||||
|
||||
```javascript
|
||||
// 搜尋影片
|
||||
async function searchVideos(query, limit = 10) {
|
||||
const response = await fetch('https://api.momentry.ddns.net/api/v1/n8n/search', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ query, limit })
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error('API 請求失敗');
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
// 使用範例
|
||||
searchVideos('charade', 5)
|
||||
.then(data => {
|
||||
data.hits.forEach(hit => {
|
||||
console.log(`${hit.text} (score: ${hit.score})`);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### 3.5 WordPress Shortcode
|
||||
|
||||
在 `functions.php` 中註冊短碼:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 將文件路徑轉換為可訪問的 URL
|
||||
function convert_file_path_to_url($file_path) {
|
||||
// 範例: 將 SFTPGo 文件路徑轉換為 web URL
|
||||
// /Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
// → https://sftpgo.example.com/demo/video.mp4
|
||||
|
||||
// 移除基本路徑
|
||||
$base_path = '/Users/accusys/momentry/var/sftpgo/data/';
|
||||
if (strpos($file_path, $base_path) === 0) {
|
||||
$relative_path = substr($file_path, strlen($base_path));
|
||||
// 替換為實際的 SFTPGo web URL
|
||||
return 'https://sftpgo.example.com/' . $relative_path;
|
||||
}
|
||||
|
||||
// 如果無法轉換,返回原始路徑
|
||||
return $file_path;
|
||||
}
|
||||
|
||||
// 註冊短碼
|
||||
add_shortcode('momentry_search', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'query' => '',
|
||||
'limit' => '10'
|
||||
], $atts);
|
||||
|
||||
if (empty($atts['query'])) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$response = wp_remote_post('https://api.momentry.ddns.net/api/v1/n8n/search', [
|
||||
'headers' => [
|
||||
'Content-Type' => 'application/json',
|
||||
'X-API-Key' => 'YOUR_API_KEY' // 替換為實際的 API Key
|
||||
],
|
||||
'body' => json_encode([
|
||||
'query' => $atts['query'],
|
||||
'limit' => (int)$atts['limit']
|
||||
]),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return '<p>搜尋服務暫時無法使用</p>';
|
||||
}
|
||||
|
||||
$data = json_decode(wp_remote_retrieve_body($response), true);
|
||||
|
||||
if (empty($data['hits'])) {
|
||||
return '<p>找不到相關結果</p>';
|
||||
}
|
||||
|
||||
$output = '<ul class="momentry-results">';
|
||||
foreach ($data['hits'] as $hit) {
|
||||
// 注意: API 現在返回 file_path 而非 media_url
|
||||
// 需要將文件路徑轉換為可訪問的 URL
|
||||
$file_path = $hit['file_path'];
|
||||
$video_url = convert_file_path_to_url($file_path); // 需要實作此函數
|
||||
|
||||
$output .= sprintf(
|
||||
'<li>%s <a href="%s?start=%s">播放</a></li>',
|
||||
esc_html($hit['text']),
|
||||
$video_url,
|
||||
$hit['start']
|
||||
);
|
||||
}
|
||||
$output .= '</ul>';
|
||||
|
||||
return $output;
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```
|
||||
[momentry_search query="charade" limit="5"]
|
||||
```
|
||||
|
||||
### 3.6 WordPress REST API Endpoint
|
||||
|
||||
在 WordPress REST API 中註冊自定義端點:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 註冊 REST API 端點
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'POST',
|
||||
'callback' => function($request) {
|
||||
$response = wp_remote_post(
|
||||
'https://api.momentry.ddns.net/api/v1/n8n/search',
|
||||
[
|
||||
'headers' => ['Content-Type' => 'application/json'],
|
||||
'body' => json_encode([
|
||||
'query' => $request->get_param('query'),
|
||||
'limit' => $request->get_param('limit', 10)
|
||||
])
|
||||
]
|
||||
);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return new WP_Error('api_error', 'API 請求失敗');
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response));
|
||||
}
|
||||
]);
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**呼叫方式**:
|
||||
```
|
||||
POST /wp-json/momentry/v1/search
|
||||
Body: {"query": "charade", "limit": 5}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 回應格式說明
|
||||
|
||||
### 4.1 n8n 格式 (`/api/v1/n8n/search`)
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 10,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0001",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0001",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 標準格式 (`/api/v1/search`)
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"chunk_id": "sentence_0001",
|
||||
"chunk_type": "sentence",
|
||||
"start_time": 48.8,
|
||||
"end_time": 55.44,
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.92
|
||||
}
|
||||
],
|
||||
"query": "charade"
|
||||
}
|
||||
```
|
||||
|
||||
### 4.3 健康檢查
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "0.1.0",
|
||||
"uptime_ms": 123456
|
||||
}
|
||||
```
|
||||
|
||||
### 4.4 詳細健康檢查
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"version": "0.1.0",
|
||||
"uptime_ms": 123456,
|
||||
"services": {
|
||||
"postgres": {"status": "ok", "latency_ms": 42, "error": null},
|
||||
"redis": {"status": "ok", "latency_ms": 0, "error": null},
|
||||
"qdrant": {"status": "ok", "latency_ms": 15, "error": null},
|
||||
"mongodb": {"status": "ok", "latency_ms": 0, "error": null}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4.5 處理進度
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"overall_progress": 75,
|
||||
"processors": [
|
||||
{"name": "asr", "status": "complete", "progress": 100},
|
||||
{"name": "cut", "status": "complete", "progress": 100},
|
||||
{"name": "yolo", "status": "progress", "progress": 35}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 4.6 Probe 回應
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"fps": 30.0,
|
||||
"cached": false,
|
||||
"format": {
|
||||
"filename": "/path/to/video.mp4",
|
||||
"format_name": "mov,mp4,m4a,3gp,3g2,mj2",
|
||||
"duration": "120.5",
|
||||
"size": "12345678",
|
||||
"bit_rate": "819200"
|
||||
},
|
||||
"streams": [
|
||||
{
|
||||
"index": 0,
|
||||
"codec_name": "h264",
|
||||
"codec_type": "video",
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"r_frame_rate": "30/1",
|
||||
"duration": "120.5"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. HTTP 狀態碼
|
||||
|
||||
| 狀態 | 說明 | 解決 |
|
||||
|------|------|------|
|
||||
| 200 | 成功 | - |
|
||||
| 400 | 請求格式錯誤 | 檢查 JSON 格式 |
|
||||
| 404 | 端點或資源不存在 | 確認 URL 正確 |
|
||||
| 500 | 伺服器內部錯誤 | 檢查 API 服務日誌 |
|
||||
| 502 | API 服務未啟動 | 見下方說明 |
|
||||
|
||||
### 502 Bad Gateway 解決
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 啟動服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 或使用本地測試
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 常見問題
|
||||
|
||||
### Q: 為什麼有兩個 URL?
|
||||
|
||||
| URL | 用途 |
|
||||
|-----|------|
|
||||
| `localhost:3002` | 直接訪問,繞過反向代理 |
|
||||
| `api.momentry.ddns.net` | 通過 Caddy 反向代理 |
|
||||
|
||||
### Q: 兩者功能相同嗎?
|
||||
|
||||
是的,所有端點和功能完全相同。
|
||||
|
||||
### Q: n8n webhook-test 返回 404?
|
||||
|
||||
需在 n8n UI 中點擊 "Execute workflow" 按鈕後才能使用測試 Webhook。
|
||||
|
||||
### Q: 生產環境 webhook 返回 404?
|
||||
|
||||
需將 workflow 切換為 Active 狀態(右上角開關)。
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 詳細指南
|
||||
- [API_WORDPRESS_GUIDE.md](./API_WORDPRESS_GUIDE.md) - WordPress 詳細指南
|
||||
@@ -1,236 +0,0 @@
|
||||
# API Key Management Integration Tests
|
||||
|
||||
## Test Environment Setup
|
||||
|
||||
### Prerequisites
|
||||
|
||||
```bash
|
||||
# Start services
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
|
||||
# Set environment variables
|
||||
export DATABASE_URL="postgres://accusys@localhost:5432/momentry"
|
||||
export REDIS_URL="redis://:accusys@localhost:6379"
|
||||
export GITEA_URL="http://localhost:3000"
|
||||
export N8N_URL="https://n8n.momentry.ddns.net"
|
||||
```
|
||||
|
||||
### Run Tests
|
||||
|
||||
```bash
|
||||
# Run all unit tests
|
||||
cargo test --lib
|
||||
|
||||
# Run API key specific tests
|
||||
cargo test --lib api_key
|
||||
|
||||
# Run with output
|
||||
cargo test --lib -- --nocapture
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Test Cases
|
||||
|
||||
### 1. API Key Creation
|
||||
|
||||
```bash
|
||||
# Test: Create a service key
|
||||
momentry api-key create test-key --key-type service --ttl 90
|
||||
|
||||
# Expected Output:
|
||||
# ✅ API Key created successfully!
|
||||
# Key ID: msvc_...
|
||||
# API Key: msvc_...
|
||||
# Expires: 2026-06-19
|
||||
```
|
||||
|
||||
### 2. API Key Validation
|
||||
|
||||
```bash
|
||||
# Test: Validate the created key
|
||||
momentry api-key validate --key "msvc_..."
|
||||
|
||||
# Expected Output:
|
||||
# ✅ API Key is valid
|
||||
# Key ID: msvc_...
|
||||
# Name: test-key
|
||||
# Type: service
|
||||
```
|
||||
|
||||
### 3. API Key Listing
|
||||
|
||||
```bash
|
||||
# Test: List all keys
|
||||
momentry api-key list
|
||||
|
||||
# Expected Output:
|
||||
# 📋 API Key List
|
||||
# ┌────────────────────────────────────────────────────────────────────────────┐
|
||||
# │ Status │ Name │ Type │ Usage │ Last Used │
|
||||
# ├────────────────────────────────────────────────────────────────────────────┤
|
||||
# │ ✓ active │ test-key │ "service" │ 0 │ never │
|
||||
# └────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 4. API Key Statistics
|
||||
|
||||
```bash
|
||||
# Test: Show statistics
|
||||
momentry api-key stats
|
||||
|
||||
# Expected Output:
|
||||
# 📊 API Key Statistics
|
||||
# ┌─────────────────────────────────────────┐
|
||||
# │ Total Keys: 1 │
|
||||
# │ Active Keys: 1 │
|
||||
# │ Expired Keys: 0 │
|
||||
# └─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 5. Gitea Token Creation
|
||||
|
||||
```bash
|
||||
# Test: Create Gitea token
|
||||
momentry gitea create \
|
||||
--username admin \
|
||||
--password "Test3200Test3200Test3200" \
|
||||
--token-name "test-token" \
|
||||
--scopes "read:repository,write:repository"
|
||||
|
||||
# Expected Output:
|
||||
# ✅ Gitea Token created successfully!
|
||||
# Token ID: ...
|
||||
# SHA1: ...
|
||||
```
|
||||
|
||||
### 6. n8n API Key Creation
|
||||
|
||||
```bash
|
||||
# Test: Create n8n API key
|
||||
momentry n8n create \
|
||||
--api-key "existing-n8n-key" \
|
||||
--label "test-key" \
|
||||
--expires-in-days 90
|
||||
|
||||
# Expected Output:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# Key ID: ...
|
||||
# API Key: ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Automated Test Script
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# integration_test.sh
|
||||
|
||||
set -e
|
||||
|
||||
echo "=== API Key Integration Tests ==="
|
||||
|
||||
# 1. Create API key
|
||||
echo "1. Testing API key creation..."
|
||||
momentry api-key create integration-test --key-type service --ttl 30
|
||||
echo "✅ API key created"
|
||||
|
||||
# 2. List keys
|
||||
echo "2. Testing API key listing..."
|
||||
momentry api-key list
|
||||
echo "✅ API key list OK"
|
||||
|
||||
# 3. Show stats
|
||||
echo "3. Testing statistics..."
|
||||
momentry api-key stats
|
||||
echo "✅ Statistics OK"
|
||||
|
||||
# 4. Test Gitea integration
|
||||
echo "4. Testing Gitea integration..."
|
||||
GITEA_URL="http://localhost:3000" \
|
||||
momentry gitea list --username admin --password "Test3200Test3200Test3200"
|
||||
echo "✅ Gitea integration OK"
|
||||
|
||||
echo ""
|
||||
echo "=== All Tests Passed ==="
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Unit Test Coverage
|
||||
|
||||
| Module | Tests | Status |
|
||||
|--------|-------|--------|
|
||||
| `models.rs` | 0 | ✅ |
|
||||
| `service.rs` | 5 | ✅ |
|
||||
| `validator.rs` | 2 | ✅ |
|
||||
| `gitea.rs` | 3 | ✅ |
|
||||
| `n8n.rs` | 2 | ✅ |
|
||||
| `rotation.rs` | 4 | ✅ |
|
||||
| `anomaly.rs` | 0 | ✅ |
|
||||
| `blacklist.rs` | 5 | ✅ |
|
||||
| `encryption.rs` | 2 | ✅ |
|
||||
| `webhook.rs` | 2 | ✅ |
|
||||
| `error.rs` | 3 | ✅ |
|
||||
| `report.rs` | 1 | ✅ |
|
||||
| `cleanup.rs` | 1 | ✅ |
|
||||
| **Total** | **30** | **✅** |
|
||||
|
||||
---
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions / Gitea Actions
|
||||
|
||||
```yaml
|
||||
name: API Key Tests
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:15
|
||||
env:
|
||||
POSTGRES_USER: accusys
|
||||
POSTGRES_DB: momentry_test
|
||||
ports:
|
||||
- 5432:5432
|
||||
redis:
|
||||
image: redis:7
|
||||
ports:
|
||||
- 6379:6379
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo test --lib api_key
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Database connection failed**
|
||||
```bash
|
||||
# Check PostgreSQL status
|
||||
pg_isready -h localhost -p 5432
|
||||
```
|
||||
|
||||
2. **Redis connection failed**
|
||||
```bash
|
||||
# Check Redis status
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
3. **Gitea authentication failed**
|
||||
```bash
|
||||
# Verify credentials
|
||||
curl -u admin:password http://localhost:3000/api/v1/user
|
||||
```
|
||||
@@ -1,222 +0,0 @@
|
||||
# n8n 呼叫 Momentry API 指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-26 | 新增 API Key 驗證說明,更新 HTTP Request Node 設定 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
**用途**: 在 n8n workflow 中呼叫 Momentry API
|
||||
|
||||
---
|
||||
|
||||
## API URL
|
||||
|
||||
在 n8n HTTP Request Node 中,**請使用外部 URL**:
|
||||
|
||||
```
|
||||
https://api.momentry.ddns.net
|
||||
```
|
||||
|
||||
> ⚠️ **不要使用** `localhost:3002`,因為 n8n 需要從外部訪問 API。
|
||||
|
||||
---
|
||||
|
||||
## 常用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/n8n/search` | 語意搜尋(推薦) |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 |
|
||||
|
||||
---
|
||||
|
||||
## HTTP Request Node 設定
|
||||
|
||||
### 語意搜尋(推薦)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit || 10 }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 測試用(固定關鍵字)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Send Body: ✓
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "charade",
|
||||
│ "limit": 3
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 完整 Workflow 範例
|
||||
|
||||
### 基本搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Video Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Search Video API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 動態查詢 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Momentry Dynamic Search",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {
|
||||
"httpMethod": "POST",
|
||||
"path": "search",
|
||||
"responseMode": "lastNode"
|
||||
},
|
||||
"name": "Webhook",
|
||||
"type": "n8n-nodes-base.webhook",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "={{ JSON.stringify($json.body.query) }}",
|
||||
"limit": "={{ $json.body.limit || 5 }}"
|
||||
}
|
||||
},
|
||||
"name": "Search API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Webhook": {
|
||||
"main": [[{"node": "Search API"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤
|
||||
|
||||
### 錯誤: 502 Bad Gateway
|
||||
|
||||
**原因**: API 服務未啟動
|
||||
|
||||
**解決**:
|
||||
```bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
### 錯誤: "Your request is invalid"
|
||||
|
||||
**原因**: Body 格式設定錯誤
|
||||
|
||||
**正確設定**:
|
||||
- `Content Type`: JSON
|
||||
- `Body`: 必須是有效的 JSON 物件
|
||||
|
||||
---
|
||||
|
||||
## curl 測試
|
||||
|
||||
在終端機中測試 API:
|
||||
|
||||
> **注意**: 所有 `/api/v1/*` 端點都需要 API Key 驗證。請設定環境變數或直接替換 API Key。
|
||||
|
||||
```bash
|
||||
# 設定環境變數(使用您的 API Key)
|
||||
export MOMENTRY_API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
```
|
||||
|
||||
```bash
|
||||
# 健康檢查
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 搜尋測試 (需要 API Key)
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: $MOMENTRY_API_KEY" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [N8N_HTTP_REQUEST_GUIDE.md](./N8N_HTTP_REQUEST_GUIDE.md) - HTTP Request 詳細設定
|
||||
@@ -1,325 +0,0 @@
|
||||
# WordPress 呼叫 Momentry API 指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 版本 | V1.1 |
|
||||
| 日期 | 2026-03-25 |
|
||||
| 用途 | 在 WordPress 中呼叫 Momentry API |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.1 | 2026-03-25 | 更新: n8n 搜尋回傳 `file_path` 取代 `media_url`,新增 API Key 驗證說明 | OpenCode | deepseek-reasoner |
|
||||
| V1.0 | 2026-03-23 | 創建 WordPress API 指南 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## API URL
|
||||
|
||||
在 WordPress 中呼叫 API,**請使用外部 URL**:
|
||||
|
||||
```
|
||||
https://api.momentry.ddns.net
|
||||
```
|
||||
|
||||
> ⚠️ WordPress 運行於瀏覽器端,無法直接訪問 `localhost`。
|
||||
|
||||
---
|
||||
|
||||
## API 認證
|
||||
|
||||
所有 `/api/v1/*` 端點(除了健康檢查)都需要 API Key 認證。請在請求標頭中加入:
|
||||
|
||||
```
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY']
|
||||
```
|
||||
|
||||
**目前示範使用的 API Key**: `demo_api_key_12345`
|
||||
|
||||
> **注意**: 正式環境請使用安全的 API Key 管理機制,避免在客戶端 JavaScript 中暴露 API Key。
|
||||
|
||||
---
|
||||
|
||||
## 常用端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋(標準格式) |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
|
||||
---
|
||||
|
||||
## PHP 範例
|
||||
|
||||
### 基本搜尋
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/n8n/search';
|
||||
|
||||
$data = [
|
||||
'query' => 'charade',
|
||||
'limit' => 10
|
||||
];
|
||||
|
||||
$response = wp_remote_post($api_url, [
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY'],
|
||||
'body' => json_encode($data),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
echo '錯誤: ' . $response->get_error_message();
|
||||
} else {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
print_r($body['hits']);
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 列出所有影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/videos';
|
||||
|
||||
$response = wp_remote_get($api_url, [
|
||||
'headers' => ['X-API-Key' => 'YOUR_API_KEY'],
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$body = json_decode(wp_remote_retrieve_body($response), true);
|
||||
foreach ($body['videos'] as $video) {
|
||||
echo $video['file_name'] . "\n";
|
||||
}
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
### 查詢特定影片
|
||||
|
||||
```php
|
||||
<?php
|
||||
$uuid = '5dea6618a606e7c7';
|
||||
$api_url = 'https://api.momentry.ddns.net/api/v1/lookup?uuid=' . $uuid;
|
||||
|
||||
$response = wp_remote_get($api_url, [
|
||||
'headers' => ['X-API-Key' => 'YOUR_API_KEY'],
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (!is_wp_error($response)) {
|
||||
$video = json_decode(wp_remote_retrieve_body($response), true);
|
||||
echo '檔案: ' . $video['file_name'] . "\n";
|
||||
echo '時長: ' . $video['duration'] . ' 秒';
|
||||
}
|
||||
?>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## JavaScript 範例
|
||||
|
||||
### 使用 fetch
|
||||
|
||||
```javascript
|
||||
// 搜尋影片
|
||||
async function searchVideos(query, limit = 10) {
|
||||
const response = await fetch('https://api.momentry.ddns.net/api/v1/n8n/search', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json', 'X-API-Key': 'YOUR_API_KEY' },
|
||||
body: JSON.stringify({ query, limit })
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error('API 請求失敗');
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
// 使用範例
|
||||
searchVideos('charade', 5)
|
||||
.then(data => {
|
||||
data.hits.forEach(hit => {
|
||||
console.log(`${hit.text} (score: ${hit.score})`);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## WordPress Shortcode 範例
|
||||
|
||||
在 `functions.php` 中註冊短碼:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 將文件路徑轉換為可訪問的 URL
|
||||
function convert_file_path_to_url($file_path) {
|
||||
// 範例: 將 SFTPGo 文件路徑轉換為 web URL
|
||||
// /Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
// → https://sftpgo.example.com/demo/video.mp4
|
||||
|
||||
// 移除基本路徑
|
||||
$base_path = '/Users/accusys/momentry/var/sftpgo/data/';
|
||||
if (strpos($file_path, $base_path) === 0) {
|
||||
$relative_path = substr($file_path, strlen($base_path));
|
||||
// 替換為實際的 SFTPGo web URL
|
||||
return 'https://sftpgo.example.com/' . $relative_path;
|
||||
}
|
||||
|
||||
// 如果無法轉換,返回原始路徑
|
||||
return $file_path;
|
||||
}
|
||||
|
||||
// 註冊短碼
|
||||
add_shortcode('momentry_search', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'query' => '',
|
||||
'limit' => '10'
|
||||
], $atts);
|
||||
|
||||
if (empty($atts['query'])) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$response = wp_remote_post('https://api.momentry.ddns.net/api/v1/n8n/search', [
|
||||
'headers' => [
|
||||
'Content-Type' => 'application/json',
|
||||
'X-API-Key' => 'YOUR_API_KEY' // 替換為實際的 API Key
|
||||
],
|
||||
'body' => json_encode([
|
||||
'query' => $atts['query'],
|
||||
'limit' => (int)$atts['limit']
|
||||
]),
|
||||
'timeout' => 30
|
||||
]);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return '<p>搜尋服務暫時無法使用</p>';
|
||||
}
|
||||
|
||||
$data = json_decode(wp_remote_retrieve_body($response), true);
|
||||
|
||||
if (empty($data['hits'])) {
|
||||
return '<p>找不到相關結果</p>';
|
||||
}
|
||||
|
||||
$output = '<ul class="momentry-results">';
|
||||
foreach ($data['hits'] as $hit) {
|
||||
// 注意: API 現在返回 file_path 而非 media_url
|
||||
// 需要將文件路徑轉換為可訪問的 URL
|
||||
$file_path = $hit['file_path'];
|
||||
$video_url = convert_file_path_to_url($file_path); // 需要實作此函數
|
||||
|
||||
$output .= sprintf(
|
||||
'<li>%s <a href="%s?start=%s">播放</a></li>',
|
||||
esc_html($hit['text']),
|
||||
$video_url,
|
||||
$hit['start']
|
||||
);
|
||||
}
|
||||
$output .= '</ul>';
|
||||
|
||||
return $output;
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```
|
||||
[momentry_search query="charade" limit="5"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## REST API Endpoint (WP >= 5.0)
|
||||
|
||||
在 WordPress REST API 中註冊自定義端點:
|
||||
|
||||
```php
|
||||
<?php
|
||||
// 註冊 REST API 端點
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'POST',
|
||||
'callback' => function($request) {
|
||||
$response = wp_remote_post(
|
||||
'https://api.momentry.ddns.net/api/v1/n8n/search',
|
||||
[
|
||||
'headers' => ['Content-Type' => 'application/json', 'X-API-Key' => 'YOUR_API_KEY'],
|
||||
'body' => json_encode([
|
||||
'query' => $request->get_param('query'),
|
||||
'limit' => $request->get_param('limit', 10)
|
||||
])
|
||||
]
|
||||
);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
return new WP_Error('api_error', 'API 請求失敗');
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response));
|
||||
}
|
||||
]);
|
||||
});
|
||||
?>
|
||||
```
|
||||
|
||||
**呼叫方式**:
|
||||
```
|
||||
POST /wp-json/momentry/v1/search
|
||||
Body: {"query": "charade", "limit": 5}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤
|
||||
|
||||
### 錯誤: cURL error 7
|
||||
|
||||
**原因**: 無法連接到 API
|
||||
|
||||
**檢查**:
|
||||
1. API 服務是否啟動
|
||||
2. 網路是否可達
|
||||
|
||||
### 錯誤: 502 Bad Gateway
|
||||
|
||||
**原因**: API 服務未啟動
|
||||
|
||||
**解決**:
|
||||
```bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## curl 測試
|
||||
|
||||
在終端機中測試:
|
||||
|
||||
```bash
|
||||
# 健康檢查
|
||||
curl https://api.momentry.ddns.net/health
|
||||
|
||||
# 搜尋測試
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":5}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 使用範例
|
||||
@@ -1,667 +0,0 @@
|
||||
# Momentry Core 版本紀錄
|
||||
|
||||
## 版本命名規則
|
||||
|
||||
### Main Version (主版本)
|
||||
```
|
||||
v{major}.{minor}
|
||||
例: v0.1, v0.2, v1.0
|
||||
```
|
||||
|
||||
### Build Version (建置版本)
|
||||
```
|
||||
v{major}.{minor}.{YYYYMMDD_HHMMSS}
|
||||
例: v0.1.20260325_143000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本紀錄存放位置
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/versions/
|
||||
├── current/ # 目前使用版本
|
||||
│ ├── binary # 當前 binary
|
||||
│ └── version.json # 版本資訊
|
||||
│
|
||||
├── releases/ # Release 版本存放
|
||||
│ ├── v0.1/
|
||||
│ │ ├── v0.1.20260325_143000/
|
||||
│ │ │ ├── binary
|
||||
│ │ │ └── version.json
|
||||
│ │ ├── v0.1.20260324_100000/
|
||||
│ │ │ └── ...
|
||||
│ │ └── release.json # v0.1 版本總覽
|
||||
│ │
|
||||
│ └── v0.2/
|
||||
│ └── ...
|
||||
│
|
||||
└── changelog.json # 全域版本變更記錄
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## version.json 格式
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "v0.1.20260325_143000",
|
||||
"main_version": "v0.1",
|
||||
"build_timestamp": "2026-03-25T14:30:00+08:00",
|
||||
"git_commit": "83ae050",
|
||||
"git_branch": "main",
|
||||
"git_message": "fix: save probe.json to OUTPUT_DIR instead of current directory",
|
||||
"features": [
|
||||
"API Key Authentication",
|
||||
"Job Worker System"
|
||||
],
|
||||
"fixes": [
|
||||
"get_processor_results_by_job column mapping"
|
||||
],
|
||||
"deployed_at": "2026-03-25T15:00:00+08:00",
|
||||
"deployed_by": "opencode",
|
||||
"status": "production"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## release.json 格式 (主版本總覽)
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "v0.1",
|
||||
"status": "production",
|
||||
"created_at": "2026-03-14T10:00:00+08:00",
|
||||
"current_build": "v0.1.20260325_143000",
|
||||
"builds": [
|
||||
{
|
||||
"build": "v0.1.20260325_143000",
|
||||
"date": "2026-03-25",
|
||||
"commits": ["83ae050", "171c36a"],
|
||||
"summary": "fix: save probe.json, add v2 backup versioning"
|
||||
},
|
||||
{
|
||||
"build": "v0.1.20260324_100000",
|
||||
"date": "2026-03-24",
|
||||
"commits": ["89fbfd6", "3edaf01"],
|
||||
"summary": "feat: add POST /api/v1/probe endpoint"
|
||||
}
|
||||
],
|
||||
"changelog": [
|
||||
"## v0.1.20260325_143000",
|
||||
"- 修復 processor_results 欄位映射錯誤",
|
||||
"- 添加 API Key 認證",
|
||||
"",
|
||||
"## v0.1.20260324_100000",
|
||||
"- 新增 Probe API"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## changelog.json 格式 (全域變更記錄)
|
||||
|
||||
```json
|
||||
{
|
||||
"updated_at": "2026-03-25T14:30:00+08:00",
|
||||
"versions": {
|
||||
"v0.1": {
|
||||
"status": "production",
|
||||
"current_build": "v0.1.20260325_143000",
|
||||
"build_count": 12
|
||||
},
|
||||
"v0.0": {
|
||||
"status": "deprecated",
|
||||
"final_build": "v0.0.20260310_090000"
|
||||
}
|
||||
},
|
||||
"recent_changes": [
|
||||
{
|
||||
"version": "v0.1.20260325_143000",
|
||||
"date": "2026-03-25",
|
||||
"changes": [
|
||||
{"type": "fix", "description": "get_processor_results_by_job column mapping"},
|
||||
{"type": "feat", "description": "API Key Authentication"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Script
|
||||
|
||||
### /Users/accusys/momentry/scripts/release.sh
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
PROJECT_DIR="/Users/accusys/momentry_core_0.1"
|
||||
VERSIONS_DIR="/Users/accusys/momentry/versions"
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/bin"
|
||||
CURRENT_BIN="/Users/accusys/momentry/bin/momentry"
|
||||
|
||||
# 顏色輸出
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m'
|
||||
|
||||
log_info() { echo -e "${GREEN}[INFO]${NC} $1"; }
|
||||
log_warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
|
||||
log_error() { echo -e "${RED}[ERROR]${NC} $1"; }
|
||||
|
||||
# 解析命令列參數
|
||||
MAIN_VERSION=""
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
-v|--version)
|
||||
MAIN_VERSION="$2"
|
||||
shift 2
|
||||
;;
|
||||
*)
|
||||
log_error "Unknown option: $1"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ -z "$MAIN_VERSION" ]; then
|
||||
log_error "請指定主版本: ./release.sh -v v0.1"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log_info "開始 Release ${MAIN_VERSION}..."
|
||||
|
||||
# 1. 取得 Git 資訊
|
||||
GIT_COMMIT=$(git -C "$PROJECT_DIR" rev-parse --short HEAD)
|
||||
GIT_BRANCH=$(git -C "$PROJECT_DIR" rev-parse --abbrev-ref HEAD)
|
||||
GIT_MESSAGE=$(git -C "$PROJECT_DIR" log -1 --pretty=%s)
|
||||
BUILD_TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BUILD_VERSION="${MAIN_VERSION}.${BUILD_TIMESTAMP}"
|
||||
|
||||
log_info "Build Version: ${BUILD_VERSION}"
|
||||
log_info "Git Commit: ${GIT_COMMIT}"
|
||||
|
||||
# 2. 創建版本目錄
|
||||
BUILD_DIR="${VERSIONS_DIR}/releases/${MAIN_VERSION}/${BUILD_VERSION}"
|
||||
mkdir -p "$BUILD_DIR"
|
||||
mkdir -p "${VERSIONS_DIR}/current"
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 3. 停止 Production Service
|
||||
log_info "停止 Production Service..."
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist 2>/dev/null || true
|
||||
|
||||
# 4. 備份當前 Binary
|
||||
if [ -f "$CURRENT_BIN" ]; then
|
||||
OLD_VERSION=$(cat "${VERSIONS_DIR}/current/version.json" 2>/dev/null | jq -r '.version // "unknown"')
|
||||
log_info "備份當前版本: $OLD_VERSION"
|
||||
cp "$CURRENT_BIN" "${BACKUP_DIR}/momentry_${OLD_VERSION}_$(date +%Y%m%d_%H%M%S)"
|
||||
fi
|
||||
|
||||
# 5. 編譯 Release 版本
|
||||
log_info "編譯 Release 版本..."
|
||||
cd "$PROJECT_DIR"
|
||||
cargo build --release --bin momentry
|
||||
|
||||
# 6. 複製到版本目錄
|
||||
log_info "複製到版本目錄..."
|
||||
cp target/release/momentry "${BUILD_DIR}/binary"
|
||||
cp target/release/momentry "$CURRENT_BIN"
|
||||
|
||||
# 7. 生成 version.json
|
||||
cat > "${BUILD_DIR}/version.json" << EOF
|
||||
{
|
||||
"version": "${BUILD_VERSION}",
|
||||
"main_version": "${MAIN_VERSION}",
|
||||
"build_timestamp": "$(date -Iseconds)",
|
||||
"git_commit": "${GIT_COMMIT}",
|
||||
"git_branch": "${GIT_BRANCH}",
|
||||
"git_message": "${GIT_MESSAGE}",
|
||||
"features": [],
|
||||
"fixes": [],
|
||||
"deployed_at": null,
|
||||
"deployed_by": null,
|
||||
"status": "built"
|
||||
}
|
||||
EOF
|
||||
|
||||
# 8. 更新 current
|
||||
cp "${BUILD_DIR}/version.json" "${VERSIONS_DIR}/current/version.json"
|
||||
|
||||
# 9. 更新 changelog.json
|
||||
UPDATE_CHANGELOG="
|
||||
import json
|
||||
from datetime import datetime
|
||||
|
||||
changelog_path = '${VERSIONS_DIR}/changelog.json'
|
||||
build_info = {
|
||||
'version': '${BUILD_VERSION}',
|
||||
'date': datetime.now().strftime('%Y-%m-%d'),
|
||||
'commit': '${GIT_COMMIT}',
|
||||
'message': '${GIT_MESSAGE}'
|
||||
}
|
||||
|
||||
try:
|
||||
with open(changelog_path, 'r') as f:
|
||||
changelog = json.load(f)
|
||||
except FileNotFoundError:
|
||||
changelog = {'updated_at': '', 'versions': {}, 'recent_changes': []}
|
||||
|
||||
changelog['updated_at'] = datetime.now().isoformat()
|
||||
if '${MAIN_VERSION}' not in changelog['versions']:
|
||||
changelog['versions']['${MAIN_VERSION}'] = {'status': 'building', 'build_count': 0}
|
||||
|
||||
changelog['versions']['${MAIN_VERSION}']['build_count'] += 1
|
||||
changelog['versions']['${MAIN_VERSION}']['current_build'] = '${BUILD_VERSION}'
|
||||
changelog['recent_changes'].insert(0, build_info)
|
||||
|
||||
with open(changelog_path, 'w') as f:
|
||||
json.dump(changelog, f, indent=2, ensure_ascii=False)
|
||||
"
|
||||
python3 -c "$UPDATE_CHANGELOG"
|
||||
|
||||
# 10. 啟動 Production Service
|
||||
log_info "啟動 Production Service..."
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 11. 驗證
|
||||
sleep 3
|
||||
if curl -s http://localhost:3002/health > /dev/null; then
|
||||
log_info "✓ Release 成功!"
|
||||
log_info "版本: ${BUILD_VERSION}"
|
||||
log_info "目錄: ${BUILD_DIR}"
|
||||
else
|
||||
log_error "✗ Release 失敗!請檢查服務狀態。"
|
||||
exit 1
|
||||
fi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 查詢版本指令
|
||||
|
||||
### 查詢目前版本
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/current/version.json
|
||||
```
|
||||
|
||||
### 查詢所有 Release
|
||||
```bash
|
||||
ls -la /Users/accusys/momentry/versions/releases/
|
||||
```
|
||||
|
||||
### 查詢版本歷史
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/changelog.json | python3 -m json.tool
|
||||
```
|
||||
|
||||
### 查詢特定主版本
|
||||
```bash
|
||||
ls /Users/accusys/momentry/versions/releases/v0.1/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本狀態
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `building` | 建置中 |
|
||||
| `built` | 已建置,未部署 |
|
||||
| `testing` | 測試中 |
|
||||
| `production` | 正式環境使用中 |
|
||||
| `deprecated` | 已棄用 |
|
||||
| `archived` | 已封存 |
|
||||
|
||||
---
|
||||
|
||||
## 版本流程圖
|
||||
|
||||
```
|
||||
develop (git branch)
|
||||
│
|
||||
▼
|
||||
feature/bugfix commit
|
||||
│
|
||||
▼
|
||||
develop ──────────────────┐
|
||||
│ │
|
||||
│ (merge to main) │
|
||||
▼ │
|
||||
main (git) │
|
||||
│ │
|
||||
▼ │
|
||||
Build v0.1.20260325_143000
|
||||
│ │
|
||||
├──► testing (3003) │
|
||||
│ │
|
||||
│ (approve) │
|
||||
▼ ▼
|
||||
v0.1 ───────────────────┘
|
||||
│
|
||||
├──► releases/v0.1/v0.1.20260325_143000/
|
||||
│
|
||||
├──► current/ (production)
|
||||
│
|
||||
▼
|
||||
changelog.json (update)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note (版本發布說明)
|
||||
|
||||
### Release Note 存放位置
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/versions/releases/{主版本}/{建置版本}/
|
||||
├── binary
|
||||
├── version.json
|
||||
└── RELEASE_NOTE.md # 發布說明 (Markdown)
|
||||
```
|
||||
|
||||
### Release Note 範本
|
||||
|
||||
```markdown
|
||||
# Momentry Core v0.1.20260325_143000 Release Note
|
||||
|
||||
## 版本資訊
|
||||
- **Build Version**: v0.1.20260325_143000
|
||||
- **Main Version**: v0.1
|
||||
- **Build Date**: 2026-03-25 14:30:00
|
||||
- **Git Commit**: 83ae050
|
||||
|
||||
## 新功能 (Features)
|
||||
|
||||
### API Key 認證系統
|
||||
- 添加 API Key 認證中介層
|
||||
- 所有 `/api/v1/*` 端點需要 `X-API-Key` header
|
||||
- 支援 API Key 使用追蹤和審計日誌
|
||||
|
||||
### Job Worker 系統
|
||||
- 新增 Job Worker 二進位檔
|
||||
- 支援最多 2 個並發處理器
|
||||
- 新增 `/api/v1/jobs/:uuid` 端點查詢任務詳情
|
||||
|
||||
## 錯誤修復 (Bug Fixes)
|
||||
|
||||
| Issue | 描述 |
|
||||
|-------|------|
|
||||
| #001 | 修復 `get_processor_results_by_job` 欄位映射錯誤 |
|
||||
| #002 | 修復 API Key 驗證時區處理問題 |
|
||||
|
||||
## API 變更 (API Changes)
|
||||
|
||||
### 新增端點
|
||||
| Method | Endpoint | 說明 |
|
||||
|--------|----------|------|
|
||||
| GET | `/api/v1/jobs` | 取得所有任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 取得特定任務詳情 |
|
||||
|
||||
### 認證變更
|
||||
| 端點 | 舊版 | 新版 |
|
||||
|------|------|------|
|
||||
| `/api/v1/*` | 公開 | 需要 API Key |
|
||||
|
||||
## 升級指南
|
||||
|
||||
### 從舊版升級
|
||||
1. 備份當前版本
|
||||
2. 停止服務
|
||||
3. 替換 binary
|
||||
4. 重啟服務
|
||||
5. 更新 API Key 配置
|
||||
|
||||
### API Key 配置
|
||||
```bash
|
||||
# 請求範例
|
||||
curl -H "X-API-Key: your_api_key" \
|
||||
"http://localhost:3002/api/v1/videos"
|
||||
```
|
||||
|
||||
## 已知問題 (Known Issues)
|
||||
|
||||
- 暫無
|
||||
|
||||
## 相關文檔
|
||||
|
||||
- [API 文檔](../docs/API_INDEX.md)
|
||||
- [版本管理規範](../docs/VERSION_MANAGEMENT.md)
|
||||
|
||||
---
|
||||
|
||||
## Release Note 自動生成 Script
|
||||
|
||||
### /Users/accusys/momentry/scripts/generate_release_note.sh
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
BUILD_VERSION=$1
|
||||
MAIN_VERSION=$2
|
||||
BUILD_DIR="/Users/accusys/momentry/versions/releases/${MAIN_VERSION}/${BUILD_VERSION}"
|
||||
|
||||
# 取得 Git 資訊
|
||||
GIT_COMMITS=$(git log --oneline -10)
|
||||
GIT_CHANGES=$(git diff --stat HEAD~5..HEAD)
|
||||
|
||||
cat > "${BUILD_DIR}/RELEASE_NOTE.md" << EOF
|
||||
# Momentry Core ${BUILD_VERSION} Release Note
|
||||
|
||||
## 版本資訊
|
||||
- **Build Version**: ${BUILD_VERSION}
|
||||
- **Main Version**: ${MAIN_VERSION}
|
||||
- **Build Date**: $(date '+%Y-%m-%d %H:%M:%S')
|
||||
- **Git Commit**: $(git rev-parse --short HEAD)
|
||||
|
||||
## 變更內容
|
||||
|
||||
### Commit 記錄
|
||||
\`\`\`
|
||||
${GIT_COMMITS}
|
||||
\`\`\`
|
||||
|
||||
### 變更統計
|
||||
\`\`\`
|
||||
${GIT_CHANGES}
|
||||
\`\`\`
|
||||
|
||||
## 新功能
|
||||
|
||||
## 錯誤修復
|
||||
|
||||
## API 變更
|
||||
|
||||
## 升級指南
|
||||
|
||||
## 已知問題
|
||||
|
||||
EOF
|
||||
|
||||
echo "Release Note 生成完成: ${BUILD_DIR}/RELEASE_NOTE.md"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note 查詢
|
||||
|
||||
### 查詢所有 Release Note
|
||||
```bash
|
||||
find /Users/accusys/momentry/versions/releases -name "RELEASE_NOTE.md"
|
||||
```
|
||||
|
||||
### 查看特定版本 Release Note
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/releases/v0.1/v0.1.20260325_143000/RELEASE_NOTE.md
|
||||
```
|
||||
|
||||
### 查詢最新版本 Release Note
|
||||
```bash
|
||||
cat /Users/accusys/momentry/versions/current/RELEASE_NOTE.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Release Note 範例
|
||||
|
||||
### 完整 Release Note 範例
|
||||
|
||||
\`\`\`markdown
|
||||
# Momentry Core v0.1.20260325_143000 Release Note
|
||||
|
||||
## 版本資訊
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| Build Version | v0.1.20260325_143000 |
|
||||
| Main Version | v0.1 |
|
||||
| Build Date | 2026-03-25 14:30:00 |
|
||||
| Git Commit | 83ae050 |
|
||||
| Status | ✅ Production |
|
||||
|
||||
## 新功能 (Features)
|
||||
|
||||
### 1. API Key 認證系統
|
||||
添加完整的 API Key 認證系統,保護所有 API 端點。
|
||||
|
||||
**功能:**
|
||||
- SHA256 key hash 驗證
|
||||
- 使用統計追蹤
|
||||
- 審計日誌記錄
|
||||
- 異常檢測
|
||||
|
||||
**API 使用方式:**
|
||||
\`\`\`bash
|
||||
curl -H "X-API-Key: your_key" \\
|
||||
"http://localhost:3002/api/v1/videos"
|
||||
\`\`\`
|
||||
|
||||
### 2. Job Worker 系統
|
||||
新增獨立的 Job Worker 處理影片處理任務。
|
||||
|
||||
**特性:**
|
||||
- 最多 2 個並發處理器
|
||||
- Polling-based 任務獲取
|
||||
- 自動進度追蹤
|
||||
|
||||
## 錯誤修復 (Bug Fixes)
|
||||
|
||||
| Issue | 描述 | 嚴重性 |
|
||||
|-------|------|--------|
|
||||
| #001 | 修復 `get_processor_results_by_job` TIMESTAMP 欄位映射 | 🔴 高 |
|
||||
| #002 | 修復 3002 port 衝突問題 | 🟡 中 |
|
||||
|
||||
## API 變更
|
||||
|
||||
### 新增端點
|
||||
| Method | Endpoint | 說明 |
|
||||
|--------|----------|------|
|
||||
| GET | `/api/v1/jobs` | 取得任務列表 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 取得任務詳情 |
|
||||
|
||||
### 端點認證狀態
|
||||
| 端點 | 認證需求 |
|
||||
|------|----------|
|
||||
| `/health` | ❌ 不需要 |
|
||||
| `/api/v1/*` | ✅ 需要 `X-API-Key` |
|
||||
|
||||
## 升級指南
|
||||
|
||||
### 前置需求
|
||||
- PostgreSQL 資料庫
|
||||
- Redis 伺服器
|
||||
- MongoDB 快取
|
||||
|
||||
### 升級步驟
|
||||
1. **備份當前版本**
|
||||
\`\`\`bash
|
||||
cp /Users/accusys/momentry/bin/momentry \\
|
||||
/Users/accusys/momentry/backup/bin/momentry_$(date +%Y%m%d)
|
||||
\`\`\`
|
||||
|
||||
2. **停止服務**
|
||||
\`\`\`bash
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
3. **替換 Binary**
|
||||
\`\`\`bash
|
||||
cp v0.1.20260325_143000/binary /Users/accusys/momentry/bin/momentry
|
||||
\`\`\`
|
||||
|
||||
4. **重啟服務**
|
||||
\`\`\`bash
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
5. **驗證**
|
||||
\`\`\`bash
|
||||
curl http://localhost:3002/health
|
||||
\`\`\`
|
||||
|
||||
## 已知問題 (Known Issues)
|
||||
|
||||
- 暫無
|
||||
|
||||
## 技術細節
|
||||
|
||||
### 認證流程
|
||||
\`\`\`
|
||||
Client Request
|
||||
│
|
||||
▼
|
||||
[X-API-Key Header] ──► Middleware
|
||||
│ │
|
||||
│ ▼
|
||||
│ Hash Key (SHA256)
|
||||
│ │
|
||||
│ ▼
|
||||
│ DB Lookup
|
||||
│ │
|
||||
│ ▼
|
||||
│ Validate Status
|
||||
│ │
|
||||
▼ ▼
|
||||
Handler ◄────────────────────┘
|
||||
\`\`\`
|
||||
|
||||
### 資料庫變更
|
||||
\`\`\`sql
|
||||
-- 新增 duration_secs 欄位
|
||||
ALTER TABLE processor_results
|
||||
ADD COLUMN IF NOT EXISTS duration_secs DOUBLE PRECISION;
|
||||
\`\`\`
|
||||
|
||||
## 回滾指南
|
||||
|
||||
如需回滾到上一版本:
|
||||
\`\`\`bash
|
||||
# 1. 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 2. 恢復舊版
|
||||
cp /Users/accusys/momentry/backup/bin/momentry_v0.1.20260324_100000 \\
|
||||
/Users/accusys/momentry/bin/momentry
|
||||
|
||||
# 3. 重啟服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
\`\`\`
|
||||
|
||||
## 聯繫與支援
|
||||
|
||||
- **Issue Tracker**: https://gitea.momentry.ddns.net/momentry/momentry_core/issues
|
||||
- **文檔**: https://docs.momentry.ddns.net
|
||||
|
||||
---
|
||||
|
||||
*Generated: $(date '+%Y-%m-%d %H:%M:%S')*
|
||||
\`\`\`
|
||||
|
||||
```
|
||||
@@ -1,686 +0,0 @@
|
||||
# Momentry Core API 示範手冊
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-25 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-25 | 創建示範手冊,包含 Demo API Key 與完整範例 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
**狀態**: 完成
|
||||
|
||||
---
|
||||
|
||||
## 快速開始
|
||||
|
||||
### Demo API Key
|
||||
|
||||
```
|
||||
API Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69
|
||||
Key ID: muser_68600856036340bcafc01930eb4bd839
|
||||
過期日: 2027-03-25
|
||||
```
|
||||
|
||||
### 測試連線
|
||||
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
```json
|
||||
{"status":"ok","version":"0.1.0","uptime_ms":456464}
|
||||
```
|
||||
|
||||
### 測試認證
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/videos | jq '.videos | length'
|
||||
```
|
||||
|
||||
```json
|
||||
13
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境 URL
|
||||
|
||||
| 環境 | URL | 用途 |
|
||||
|------|-----|------|
|
||||
| **本地開發** | `http://localhost:3002` | 本機開發測試 |
|
||||
| **外部訪問** | `https://api.momentry.ddns.net` | n8n/WordPress/curl 生產環境 |
|
||||
|
||||
---
|
||||
|
||||
## 端點總覽
|
||||
|
||||
| 方法 | 端點 | 說明 | 認證 |
|
||||
|------|------|------|------|
|
||||
| GET | `/health` | 健康檢查 | 公開 |
|
||||
| GET | `/health/detailed` | 詳細健康檢查 | 公開 |
|
||||
| POST | `/api/v1/register` | 註冊影片 | 需要 |
|
||||
| POST | `/api/v1/probe` | 探測影片資訊 | 需要 |
|
||||
| POST | `/api/v1/search` | 語意搜尋 | 需要 |
|
||||
| POST | `/api/v1/n8n/search` | n8n 格式搜尋 | 需要 |
|
||||
| POST | `/api/v1/search/hybrid` | 混合搜尋 | 需要 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 | 需要 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 UUID | 需要 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 | 需要 |
|
||||
| GET | `/api/v1/jobs` | 任務列表 | 需要 |
|
||||
| GET | `/api/v1/jobs/:uuid` | 任務詳情 | 需要 |
|
||||
|
||||
---
|
||||
|
||||
## 1. curl 範例
|
||||
|
||||
### 基本格式
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
URL
|
||||
```
|
||||
|
||||
### 1.1 健康檢查(公開)
|
||||
|
||||
```bash
|
||||
# 基本健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查(含服務狀態)
|
||||
curl http://localhost:3002/health/detailed
|
||||
```
|
||||
|
||||
### 1.2 列出影片
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/videos | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"videos": [
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"file_name": "ExaSAN PCIe series - Director Ou Yu-Zhi Shares His Experience.mp4",
|
||||
"duration": 159.637188,
|
||||
"width": 640,
|
||||
"height": 360
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 1.3 搜尋影片
|
||||
|
||||
```bash
|
||||
curl -X POST \
|
||||
-H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "ExaSAN", "limit": 5}' \
|
||||
http://localhost:3002/api/v1/search | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"chunk_id": "...",
|
||||
"text": "...",
|
||||
"score": 0.85,
|
||||
"start_time": 0.0,
|
||||
"end_time": 5.0
|
||||
}
|
||||
],
|
||||
"total": 1,
|
||||
"query": "ExaSAN",
|
||||
"took_ms": 123
|
||||
}
|
||||
```
|
||||
|
||||
### 1.4 查詢進度
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \
|
||||
http://localhost:3002/api/v1/progress/952f5854b9febad1 | jq '.'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"uuid": "952f5854b9febad1",
|
||||
"overall_progress": 67,
|
||||
"current_processor": "yolo",
|
||||
"processors": [
|
||||
{"name": "asr", "status": "completed"},
|
||||
{"name": "cut", "status": "completed"},
|
||||
{"name": "yolo", "status": "running"}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. n8n 範例
|
||||
|
||||
### 2.1 HTTP Request 節點設定
|
||||
|
||||
```
|
||||
Method: POST
|
||||
URL: https://api.momentry.ddns.net/api/v1/search
|
||||
Authentication: None (使用 Header)
|
||||
|
||||
Headers:
|
||||
┌─────────────────────┬──────────────────────────────────────────────────┐
|
||||
│ Name │ Value │
|
||||
├─────────────────────┼──────────────────────────────────────────────────┤
|
||||
│ X-API-Key │ muser_68600856036340bcafc01930eb4bd839_... │
|
||||
│ Content-Type │ application/json │
|
||||
└─────────────────────┴──────────────────────────────────────────────────┘
|
||||
|
||||
Body Content (JSON):
|
||||
{
|
||||
"query": "{{ $json.search_term }}",
|
||||
"limit": 5
|
||||
}
|
||||
```
|
||||
|
||||
### 2.2 n8n 搜尋 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Manual Trigger",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"name": "Set Search Term",
|
||||
"type": "n8n-nodes-base.set",
|
||||
"parameters": {
|
||||
"values": {
|
||||
"json": {
|
||||
"search_term": "ExaSAN"
|
||||
}
|
||||
}
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Search Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "POST",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/search",
|
||||
"authentication": "genericCredentialType",
|
||||
"genericAuthType": "httpHeaderAuth",
|
||||
"sendHeaders": true,
|
||||
"headerParameters": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "X-API-Key",
|
||||
"value": "muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
}
|
||||
]
|
||||
},
|
||||
"sendBody": true,
|
||||
"bodyContentType": "json",
|
||||
"specifyBody": "json",
|
||||
"jsonBody": "={{ { \"query\": $json.search_term, \"limit\": 5 } }}"
|
||||
},
|
||||
"position": [650, 300]
|
||||
},
|
||||
{
|
||||
"name": "Process Results",
|
||||
"type": "n8n-nodes-base.code",
|
||||
"parameters": {
|
||||
"jsCode": "// Extract video results\nconst results = $input.first().json.results;\nreturn results.map(r => ({\n uuid: r.uuid,\n text: r.text,\n score: r.score,\n time: `${r.start_time}s - ${r.end_time}s`\n}));"
|
||||
},
|
||||
"position": [850, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"Manual Trigger": {
|
||||
"main": [[{"node": "Set Search Term"}]]
|
||||
},
|
||||
"Set Search Term": {
|
||||
"main": [[{"node": "Search Videos"}]]
|
||||
},
|
||||
"Search Videos": {
|
||||
"main": [[{"node": "Process Results"}]]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2.3 n8n 列出影片 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Get Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "GET",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/videos",
|
||||
"sendHeaders": true,
|
||||
"headerParameters": {
|
||||
"parameters": [
|
||||
{
|
||||
"name": "X-API-Key",
|
||||
"value": "muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Extract Video List",
|
||||
"type": "n8n-nodes-base.code",
|
||||
"parameters": {
|
||||
"jsCode": "const videos = $input.first().json.videos;\nreturn videos.map(v => ({\n json: {\n uuid: v.uuid,\n name: v.file_name,\n duration: Math.round(v.duration) + 's',\n resolution: `${v.width}x${v.height}`\n }\n}));"
|
||||
},
|
||||
"position": [650, 300]
|
||||
},
|
||||
{
|
||||
"name": "Slack Notification",
|
||||
"type": "n8n-nodes-base.slack",
|
||||
"parameters": {
|
||||
"channel": "#momentry",
|
||||
"text": "=Found {{ $json.length }} videos:\n{{ $json.map(v => `• ${v.name} (${v.duration})`).join(`\n`) }}"
|
||||
},
|
||||
"position": [850, 300]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 n8n 定時同步 Workflow
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{
|
||||
"name": "Schedule Trigger",
|
||||
"type": "n8n-nodes-base.scheduleTrigger",
|
||||
"parameters": {
|
||||
"rule": {
|
||||
"interval": [{"field": "hours", "hours": 1}]
|
||||
}
|
||||
},
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"name": "Get Pending Videos",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"parameters": {
|
||||
"method": "GET",
|
||||
"url": "https://api.momentry.ddns.net/api/v1/videos"
|
||||
},
|
||||
"position": [450, 300]
|
||||
},
|
||||
{
|
||||
"name": "Filter Processing",
|
||||
"type": "n8n-nodes-base.filter",
|
||||
"parameters": {
|
||||
"conditions": {
|
||||
"options": {"caseSensitive": true},
|
||||
"conditions": [
|
||||
{"id": "status", "leftValue": "{{ $json.status }}", "rightValue": "processing"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"position": [650, 300]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. WordPress 範例
|
||||
|
||||
### 3.1 PHP 函數庫
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* Momentry API Client
|
||||
*/
|
||||
|
||||
class Momentry_API {
|
||||
private const API_URL = 'https://api.momentry.ddns.net';
|
||||
private const API_KEY = 'muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69';
|
||||
|
||||
/**
|
||||
* 發送 API 請求
|
||||
*/
|
||||
private function request(string $endpoint, array $data = [], string $method = 'GET'): array {
|
||||
$url = self::API_URL . $endpoint;
|
||||
|
||||
$args = [
|
||||
'headers' => [
|
||||
'X-API-Key' => self::API_KEY,
|
||||
'Content-Type' => 'application/json',
|
||||
],
|
||||
'timeout' => 30,
|
||||
];
|
||||
|
||||
if ($method === 'POST') {
|
||||
$args['method'] = 'POST';
|
||||
$args['body'] = json_encode($data);
|
||||
}
|
||||
|
||||
$response = wp_remote_request($url, $args);
|
||||
|
||||
if (is_wp_error($response)) {
|
||||
throw new Exception($response->get_error_message());
|
||||
}
|
||||
|
||||
return json_decode(wp_remote_retrieve_body($response), true);
|
||||
}
|
||||
|
||||
/**
|
||||
* 列出所有影片
|
||||
*/
|
||||
public function list_videos(): array {
|
||||
return $this->request('/api/v1/videos');
|
||||
}
|
||||
|
||||
/**
|
||||
* 搜尋影片內容
|
||||
*/
|
||||
public function search(string $query, int $limit = 10): array {
|
||||
return $this->request('/api/v1/search', [
|
||||
'query' => $query,
|
||||
'limit' => $limit,
|
||||
], 'POST');
|
||||
}
|
||||
|
||||
/**
|
||||
* 取得影片進度
|
||||
*/
|
||||
public function get_progress(string $uuid): array {
|
||||
return $this->request("/api/v1/progress/{$uuid}");
|
||||
}
|
||||
|
||||
/**
|
||||
* 檢查健康狀態
|
||||
*/
|
||||
public function health_check(): array {
|
||||
return $this->request('/health');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3.2 短代碼 (Shortcode)
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* WordPress 短代碼範例
|
||||
*/
|
||||
|
||||
// 註冊短代碼
|
||||
add_shortcode('momentry_videos', function($atts) {
|
||||
$atts = shortcode_atts([
|
||||
'limit' => 10,
|
||||
], $atts);
|
||||
|
||||
$api = new Momentry_API();
|
||||
|
||||
try {
|
||||
$result = $api->list_videos();
|
||||
$videos = array_slice($result['videos'], 0, $atts['limit']);
|
||||
|
||||
ob_start();
|
||||
?>
|
||||
<div class="momentry-videos">
|
||||
<h3>影片列表</h3>
|
||||
<ul>
|
||||
<?php foreach ($videos as $video): ?>
|
||||
<li>
|
||||
<strong><?= esc_html($video['file_name']) ?></strong>
|
||||
<br>
|
||||
<small>
|
||||
UUID: <?= esc_html($video['uuid']) ?>
|
||||
| 時長: <?= gmdate("H:i:s", $video['duration']) ?>
|
||||
</small>
|
||||
</li>
|
||||
<?php endforeach; ?>
|
||||
</ul>
|
||||
</div>
|
||||
<?php
|
||||
return ob_get_clean();
|
||||
|
||||
} catch (Exception $e) {
|
||||
return '<p class="error">載入失敗: ' . esc_html($e->getMessage()) . '</p>';
|
||||
}
|
||||
});
|
||||
|
||||
// 搜尋短代碼
|
||||
add_shortcode('momentry_search', function($atts, $content = '') {
|
||||
$query = sanitize_text_field($content);
|
||||
|
||||
if (empty($query)) {
|
||||
return '<p>請提供搜尋關鍵字</p>';
|
||||
}
|
||||
|
||||
$api = new Momentry_API();
|
||||
|
||||
try {
|
||||
$result = $api->search($query);
|
||||
|
||||
ob_start();
|
||||
?>
|
||||
<div class="momentry-search-results">
|
||||
<h3>「<?= esc_html($query) ?>」搜尋結果</h3>
|
||||
<?php if (empty($result['results'])): ?>
|
||||
<p>沒有找到相關結果</p>
|
||||
<?php else: ?>
|
||||
<ul>
|
||||
<?php foreach ($result['results'] as $item): ?>
|
||||
<li>
|
||||
<a href="/video/<?= esc_attr($item['uuid']) ?>?t=<?= (int)$item['start_time'] ?>">
|
||||
<?= esc_html($item['text']) ?>
|
||||
</a>
|
||||
<br>
|
||||
<small>相似度: <?= round($item['score'] * 100) ?>%</small>
|
||||
</li>
|
||||
<?php endforeach; ?>
|
||||
</ul>
|
||||
<?php endif; ?>
|
||||
</div>
|
||||
<?php
|
||||
return ob_get_clean();
|
||||
|
||||
} catch (Exception $e) {
|
||||
return '<p class="error">搜尋失敗: ' . esc_html($e->getMessage()) . '</p>';
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### 3.3 使用方式
|
||||
|
||||
在 WordPress 頁面或文章中:
|
||||
|
||||
```
|
||||
[momentry_videos limit="5"]
|
||||
|
||||
[momentry_search]ExaSAN[/momentry_search]
|
||||
```
|
||||
|
||||
### 3.4 REST API 整合
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* 註冊 WordPress REST API 端點
|
||||
*/
|
||||
|
||||
add_action('rest_api_init', function() {
|
||||
register_rest_route('momentry/v1', '/search', [
|
||||
'methods' => 'GET',
|
||||
'callback' => function(WP_REST_Request $request) {
|
||||
$query = sanitize_text_field($request->get_param('q'));
|
||||
|
||||
if (empty($query)) {
|
||||
return new WP_Error('missing_query', '需要搜尋關鍵字', ['status' => 400]);
|
||||
}
|
||||
|
||||
$api = new Momentry_API();
|
||||
$result = $api->search($query);
|
||||
|
||||
return new WP_REST_Response($result, 200);
|
||||
},
|
||||
'permission_callback' => '__return_true',
|
||||
]);
|
||||
});
|
||||
|
||||
// 使用方式: GET /wp-json/momentry/v1/search?q=ExaSAN
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 疑難排解
|
||||
|
||||
### 4.1 常見錯誤
|
||||
|
||||
| 錯誤 | 原因 | 解決方案 |
|
||||
|------|------|----------|
|
||||
| `401 Unauthorized` | API Key 無效或過期 | 檢查 API Key 是否正確 |
|
||||
| `500 Internal Server Error` | 伺服器錯誤 | 檢查 `/health/detailed` 服務狀態 |
|
||||
| `Connection Timeout` | 網路問題 | 確認 `api.momentry.ddns.net` 可達 |
|
||||
|
||||
### 4.2 測試腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# test_api.sh - Momentry API 測試腳本
|
||||
|
||||
API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
BASE_URL="http://localhost:3002"
|
||||
|
||||
echo "=== 1. 健康檢查 ==="
|
||||
curl -s "$BASE_URL/health" | jq .
|
||||
echo ""
|
||||
|
||||
echo "=== 2. 列出影片 ==="
|
||||
curl -s -H "X-API-Key: $API_KEY" "$BASE_URL/api/v1/videos" | jq '.videos | length'
|
||||
echo ""
|
||||
|
||||
echo "=== 3. 搜尋測試 ==="
|
||||
curl -s -X POST -H "X-API-Key: $API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "test", "limit": 3}' \
|
||||
"$BASE_URL/api/v1/search" | jq '.results | length'
|
||||
echo ""
|
||||
|
||||
echo "=== 完成 ==="
|
||||
```
|
||||
|
||||
### 4.3 驗證腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# verify_auth.sh - 驗證 API Key
|
||||
|
||||
API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
BASE_URL="http://localhost:3002"
|
||||
|
||||
# 測試 1: 無 API Key
|
||||
echo "測試 1: 無 API Key"
|
||||
RESULT=$(curl -s -o /dev/null -w "%{http_code}" "$BASE_URL/api/v1/videos")
|
||||
[ "$RESULT" = "401" ] && echo "✅ 正確拒絕 (401)" || echo "❌ 預期 401,實際 $RESULT"
|
||||
|
||||
# 測試 2: 有 API Key
|
||||
echo "測試 2: 有 API Key"
|
||||
RESULT=$(curl -s -H "X-API-Key: $API_KEY" "$BASE_URL/api/v1/videos")
|
||||
echo "$RESULT" | jq -e '.videos' > /dev/null && echo "✅ 成功取得資料" || echo "❌ 取得資料失敗"
|
||||
|
||||
# 測試 3: 無效 API Key
|
||||
echo "測試 3: 無效 API Key"
|
||||
RESULT=$(curl -s -o /dev/null -w "%{http_code}" -H "X-API-Key: invalid_key" "$BASE_URL/api/v1/videos")
|
||||
[ "$RESULT" = "401" ] && echo "✅ 正確拒絕 (401)" || echo "❌ 預期 401,實際 $RESULT"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. API Key 管理
|
||||
|
||||
### 5.1 建立新 API Key
|
||||
|
||||
```bash
|
||||
# 本地建立
|
||||
./target/release/momentry api-key create "My App" --key-type user --ttl 90
|
||||
```
|
||||
|
||||
### 5.2 列出 API Keys
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key list
|
||||
```
|
||||
|
||||
### 5.3 驗證 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key validate --key "YOUR_API_KEY"
|
||||
```
|
||||
|
||||
### 5.4 撤銷 API Key
|
||||
|
||||
```bash
|
||||
./target/release/momentry api-key revoke --key "YOUR_API_KEY"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. 影片 UUID 說明
|
||||
|
||||
UUID 是基於檔案路徑的 SHA256 哈希前 16 位:
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4
|
||||
↓
|
||||
SHA256 Hash
|
||||
↓
|
||||
9760d0820f0cf9a7
|
||||
```
|
||||
|
||||
### B. 處理器狀態
|
||||
|
||||
| 狀態 | 說明 |
|
||||
|------|------|
|
||||
| `pending` | 等待處理 |
|
||||
| `running` | 處理中 |
|
||||
| `completed` | 已完成 |
|
||||
| `failed` | 失敗 |
|
||||
|
||||
### C. 支援的處理器
|
||||
|
||||
- **ASR**: 語音識別
|
||||
- **CUT**: 場景剪切
|
||||
- **YOLO**: 物件偵測
|
||||
|
||||
### D. 聯絡支援
|
||||
|
||||
- Email: support@momentry.ddns.net
|
||||
- 文件: https://docs.momentry.ddns.net
|
||||
- GitHub: https://github.com/anomalyco/momentry
|
||||
@@ -1,707 +0,0 @@
|
||||
# Momentry 系統全新 Mac 安裝指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
| 適用對象 | 全新 Mac (Intel 或 Apple Silicon) |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 快速概覽
|
||||
|
||||
### 安裝時間估算
|
||||
|
||||
| 項目 | 時間 |
|
||||
|------|------|
|
||||
| 系統準備 | 30 分鐘 |
|
||||
| Homebrew 安裝 | 15 分鐘 |
|
||||
| 資料庫服務 | 30 分鐘 |
|
||||
| 應用服務 | 60 分鐘 |
|
||||
| Momentry Core | 20 分鐘 |
|
||||
| **總計** | **~2.5 小時** |
|
||||
|
||||
### 系統需求
|
||||
|
||||
| 項目 | 最低需求 | 推薦需求 |
|
||||
|------|----------|----------|
|
||||
| macOS | 13.0 Ventura | 14.0+ Sonoma |
|
||||
| 記憶體 | 8GB | 16GB+ |
|
||||
| 儲存空間 | 100GB | 500GB+ |
|
||||
| CPU | Apple Silicon M1 或 Intel i5 | M2/M3 或 Intel i7+ |
|
||||
|
||||
---
|
||||
|
||||
## 第一部分:系統準備
|
||||
|
||||
### 1.1 macOS 初始設定
|
||||
|
||||
首次開機後,執行以下設定:
|
||||
|
||||
```bash
|
||||
# 1. 設定電腦名稱
|
||||
sudo scutil --set ComputerName "Momentry"
|
||||
sudo scutil --set LocalHostName "momentry"
|
||||
|
||||
# 2. 啟用 SSH 遠端登入
|
||||
sudo systemsetup -setremotelogin on
|
||||
|
||||
# 3. 關閉休眠 (防止遠端斷線)
|
||||
sudo pmset -a sleep 0
|
||||
sudo pmset -a hibernatemode 0
|
||||
|
||||
# 4. 允許任何來源 App (安裝開發工具用)
|
||||
sudo spctl --master-disable
|
||||
|
||||
# 5. 設定時區
|
||||
sudo systemsetup -settimezone "Asia/Taipei"
|
||||
```
|
||||
|
||||
### 1.2 建立管理員帳戶
|
||||
|
||||
```bash
|
||||
# 建立 Momentry 管理員帳戶 (可選)
|
||||
sudo dscl . -create /Users/momentry
|
||||
sudo dscl . -create /Users/momentry UserShell /bin/zsh
|
||||
sudo dscl . -create /Users/momentry RealName "Momentry Admin"
|
||||
sudo dscl . -create /Users/momentry PrimaryGroupID 80
|
||||
sudo dscl . -create /Users/momentry UniqueID 1001
|
||||
sudo dscl . -passwd /Users/momentry "momentry_password"
|
||||
sudo dscl . -append /Groups/admin GroupMembership momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第二部分:Homebrew 安裝
|
||||
|
||||
### 2.1 安裝 Homebrew
|
||||
|
||||
```bash
|
||||
# 安裝 Homebrew
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
|
||||
# Apple Silicon 設定
|
||||
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
|
||||
eval "$(/opt/homebrew/bin/brew shellenv)"
|
||||
|
||||
# Intel Mac 設定
|
||||
# echo 'eval "$(/usr/local/bin/brew shellenv)"' >> ~/.zprofile
|
||||
# eval "$(/usr/local/bin/brew shellenv)"
|
||||
|
||||
# 驗證
|
||||
brew --version
|
||||
```
|
||||
|
||||
### 2.2 安裝基礎工具
|
||||
|
||||
```bash
|
||||
# 開發工具
|
||||
brew install \
|
||||
git \
|
||||
curl \
|
||||
wget \
|
||||
jq \
|
||||
yq \
|
||||
tree \
|
||||
htop \
|
||||
tmux \
|
||||
zsh \
|
||||
zsh-completions \
|
||||
ncdu \
|
||||
httpie \
|
||||
openssl \
|
||||
readline \
|
||||
sqlite \
|
||||
python@3.11 \
|
||||
rustup-init
|
||||
|
||||
# Rust 初始化
|
||||
rustup-init -y
|
||||
source "$HOME/.cargo/env"
|
||||
|
||||
# Python 虛擬環境
|
||||
python3.11 -m venv ~/.venv
|
||||
source ~/.venv/bin/activate
|
||||
pip install --upgrade pip
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第三部分:建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立目錄結構
|
||||
mkdir -p /Users/accusys/momentry/{var,etc,log,scripts,backup}
|
||||
mkdir -p /Users/accusys/momentry/var/{postgresql,mongodb,mariadb,redis,qdrant,n8n,ollama,sftpgo}
|
||||
mkdir -p /Users/accusys/momentry/etc/{sftpgo,caddy,gitea,php}
|
||||
mkdir -p /Users/accusys/momentry/scripts
|
||||
mkdir -p /Users/accusys/momentry/backup/{daily,weekly,monthly}
|
||||
mkdir -p /Users/accusys/workspace/sftpgo
|
||||
mkdir -p /Users/accusys/sftpgo_test/{demo,uploads}
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry
|
||||
chown -R accusys:staff /Users/accusys/workspace
|
||||
chown -R accusys:staff /Users/accusys/sftpgo_test
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第四部分:資料庫服務安裝
|
||||
|
||||
### 4.1 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install postgresql@18
|
||||
|
||||
# 啟動服務
|
||||
brew services start postgresql@18
|
||||
|
||||
# 建立資料庫
|
||||
createdb momentry
|
||||
createdb video_register
|
||||
createdb n8n
|
||||
createdb sftpgo
|
||||
|
||||
# 建立用戶
|
||||
psql -U accusys -d postgres << 'EOF'
|
||||
CREATE USER sftpgo WITH PASSWORD 'sftpgo_pass_2026';
|
||||
GRANT ALL PRIVILEGES ON DATABASE sftpgo TO sftpgo;
|
||||
GRANT ALL PRIVILEGES ON DATABASE momentry TO accusys;
|
||||
GRANT ALL PRIVILEGES ON DATABASE video_register TO accusys;
|
||||
GRANT ALL PRIVILEGES ON DATABASE n8n TO accusys;
|
||||
EOF
|
||||
|
||||
# 驗證
|
||||
pg_isready -h 127.0.0.1 -p 5432
|
||||
```
|
||||
|
||||
### 4.2 MongoDB
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew tap mongodb/brew
|
||||
brew install mongodb-community
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/mongodb
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/mongodb
|
||||
|
||||
# 啟動服務
|
||||
brew services start mongodb-community
|
||||
|
||||
# 建立用戶
|
||||
mongosh admin --eval "
|
||||
db.createUser({
|
||||
user: 'accusys',
|
||||
pwd: 'Test3200Test3200',
|
||||
roles: [
|
||||
{ role: 'readWriteAnyDatabase', db: 'admin' },
|
||||
{ role: 'dbAdminAnyDatabase', db: 'admin' }
|
||||
]
|
||||
});
|
||||
"
|
||||
|
||||
# 驗證
|
||||
mongosh --quiet --eval "db.adminCommand('ping')"
|
||||
```
|
||||
|
||||
### 4.3 Redis
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install redis
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 建立配置文件
|
||||
cat > /Users/accusys/momentry/etc/redis/redis.conf << 'EOF'
|
||||
requirepass accusys
|
||||
dir /Users/accusys/momentry/var/redis
|
||||
logfile /Users/accusys/momentry/log/redis.log
|
||||
daemonize no
|
||||
port 6379
|
||||
bind 127.0.0.1
|
||||
EOF
|
||||
|
||||
# 啟動服務
|
||||
redis-server /Users/accusys/momentry/etc/redis/redis.conf &
|
||||
sleep 2
|
||||
|
||||
# 驗證
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
### 4.4 MariaDB (WordPress)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install mariadb
|
||||
|
||||
# 啟動服務
|
||||
brew services start mariadb
|
||||
|
||||
# 安全設定
|
||||
mysql_secure_installation
|
||||
|
||||
# 建立資料庫
|
||||
mysql -u root << 'EOF'
|
||||
CREATE DATABASE wordpress CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
||||
CREATE USER 'wordpress'@'localhost' IDENTIFIED BY 'wordpress_password';
|
||||
GRANT ALL PRIVILEGES ON wordpress.* TO 'wordpress'@'localhost';
|
||||
FLUSH PRIVILEGES;
|
||||
EOF
|
||||
|
||||
# 驗證
|
||||
mysql -u root -e "SHOW DATABASES;"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第五部分:應用服務安裝
|
||||
|
||||
### 5.1 Ollama (LLM)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install ollama
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/ollama
|
||||
mkdir -p ~/.ollama/models
|
||||
|
||||
# 啟動服務
|
||||
brew services start ollama
|
||||
|
||||
# 下載模型
|
||||
ollama pull llama3.2
|
||||
ollama pull nomic-embed-text
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:11434/api/tags | jq '.models[].name'
|
||||
```
|
||||
|
||||
### 5.2 Caddy (反向代理)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install caddy
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/caddy
|
||||
|
||||
# 建立 Caddyfile
|
||||
cat > /Users/accusys/momentry/etc/caddy/Caddyfile << 'EOF'
|
||||
{
|
||||
admin off
|
||||
auto_https off
|
||||
}
|
||||
|
||||
# 範例:本地開發
|
||||
:8080 {
|
||||
respond "Momentry Server" 200
|
||||
}
|
||||
EOF
|
||||
|
||||
# 啟動服務
|
||||
brew services start caddy
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:8080
|
||||
```
|
||||
|
||||
### 5.3 Gitea (Git 服務)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install gitea
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/gitea
|
||||
mkdir -p /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 複製設定檔
|
||||
cp /opt/homebrew/etc/gitea/conf/app.ini /Users/accusys/momentry/etc/gitea/
|
||||
|
||||
# 啟動服務
|
||||
brew services start gitea
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:3000
|
||||
```
|
||||
|
||||
### 5.4 n8n (工作流程自動化)
|
||||
|
||||
```bash
|
||||
# 安裝 Node.js (如果尚未安裝)
|
||||
brew install node@22
|
||||
|
||||
# 全域安裝 n8n
|
||||
npm install -g n8n
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 設定環境變數
|
||||
export N8N_DATA_DIR=/Users/accusys/momentry/var/n8n
|
||||
export DB_TYPE=postgresdb
|
||||
export DB_POSTGRES_HOST=127.0.0.1
|
||||
export DB_POSTGRES_PORT=5432
|
||||
export DB_POSTGRES_DATABASE=n8n
|
||||
export DB_POSTGRES_USER=accusys
|
||||
export DB_POSTGRES_PASSWORD=accusys
|
||||
export N8N_ENCRYPTION_KEY=Test3200Test3200Test3200
|
||||
|
||||
# 啟動服務
|
||||
n8n start &
|
||||
|
||||
# 驗證
|
||||
curl -s http://localhost:5678
|
||||
```
|
||||
|
||||
### 5.5 SFTPGo (SFTP 服務)
|
||||
|
||||
```bash
|
||||
# 安裝
|
||||
brew install sftpgo
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/sftpgo
|
||||
|
||||
# 建立配置文件
|
||||
cat > /Users/accusys/momentry/etc/sftpgo/sftpgo.json << 'EOF'
|
||||
{
|
||||
"data_provider": {
|
||||
"driver": "postgresql",
|
||||
"host": "127.0.0.1",
|
||||
"port": 5432,
|
||||
"username": "sftpgo",
|
||||
"password": "sftpgo_pass_2026",
|
||||
"name": "sftpgo",
|
||||
"create_default_admin": true
|
||||
},
|
||||
"httpd": {
|
||||
"bind_port": 8080,
|
||||
"bind_address": "127.0.0.1"
|
||||
},
|
||||
"sftpd": {
|
||||
"bindings": [
|
||||
{"port": 2022}
|
||||
]
|
||||
},
|
||||
"ftpd": {
|
||||
"bindings": [
|
||||
{"port": 0}
|
||||
]
|
||||
}
|
||||
}
|
||||
EOF
|
||||
|
||||
# 建立 launchd plist
|
||||
cat > /Library/LaunchDaemons/com.momentry.sftpgo.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.sftpgo</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/workspace/sftpgo</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/opt/homebrew/bin/sftpgo</string>
|
||||
<string>serve</string>
|
||||
<string>--config-file</string>
|
||||
<string>/Users/accusys/momentry/etc/sftpgo/sftpgo.json</string>
|
||||
</array>
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>PATH</key>
|
||||
<string>/opt/homebrew/bin:/opt/homebrew/sbin:/usr/bin:/bin</string>
|
||||
<key>HOME</key>
|
||||
<string>/Users/accusys</string>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_USERNAME</key>
|
||||
<string>admin</string>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_PASSWORD</key>
|
||||
<string>Test3200Test3200</string>
|
||||
</dict>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/sftpgo.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/sftpgo.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.sftpgo.plist
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s -X POST http://localhost:8080/api/v2/token -u "admin:Test3200Test3200"
|
||||
```
|
||||
|
||||
### 5.6 Qdrant (向量資料庫)
|
||||
|
||||
```bash
|
||||
# 安裝 Rust (如果尚未安裝)
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
source "$HOME/.cargo/env"
|
||||
|
||||
# 安裝 Qdrant
|
||||
cargo install qdrant
|
||||
|
||||
# 建立資料目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant/storage
|
||||
|
||||
# 啟動服務
|
||||
qdrant --data-path /Users/accusys/momentry/var/qdrant/storage --api-key Test3200Test3200Test3200 &
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s http://localhost:6333/collections -H "api-key: Test3200Test3200Test3200"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第六部分:Momentry Core 安裝
|
||||
|
||||
### 6.1 安裝依賴
|
||||
|
||||
```bash
|
||||
# 安裝 Python 依賴
|
||||
pip install \
|
||||
openai-whisper \
|
||||
ultralytics \
|
||||
opencv-python \
|
||||
pillow \
|
||||
python-dotenv \
|
||||
requests \
|
||||
httpx
|
||||
|
||||
# 安裝 FFmpeg
|
||||
brew install ffmpeg
|
||||
```
|
||||
|
||||
### 6.2 安裝 Momentry Core
|
||||
|
||||
```bash
|
||||
# 克隆或進入專案目錄
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
|
||||
# 編譯專案
|
||||
cargo build --release
|
||||
|
||||
# 複製執行檔
|
||||
cp target/release/momentry /usr/local/bin/
|
||||
|
||||
# 建立 launchd plist
|
||||
cat > /Library/LaunchDaemons/com.momentry.api.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.api</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/usr/local/bin/momentry</string>
|
||||
<string>server</string>
|
||||
<string>--host</string>
|
||||
<string>0.0.0.0</string>
|
||||
<string>--port</string>
|
||||
<string>3002</string>
|
||||
</array>
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>DATABASE_URL</key>
|
||||
<string>postgres://accusys:accusys@127.0.0.1:5432/momentry</string>
|
||||
<key>RUST_LOG</key>
|
||||
<string>info</string>
|
||||
</dict>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 驗證
|
||||
sleep 3
|
||||
curl -s http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第七部分:服務驗證
|
||||
|
||||
### 7.1 健康檢查腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# health_check.sh
|
||||
|
||||
echo "=========================================="
|
||||
echo "Momentry System Health Check"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
|
||||
# PostgreSQL
|
||||
pg_isready -h 127.0.0.1 -p 5432 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ PostgreSQL" || echo "❌ PostgreSQL"
|
||||
|
||||
# MongoDB
|
||||
mongosh --quiet --eval "db.adminCommand('ping')" > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ MongoDB" || echo "❌ MongoDB"
|
||||
|
||||
# Redis
|
||||
redis-cli -a accusys ping > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Redis" || echo "❌ Redis"
|
||||
|
||||
# Ollama
|
||||
curl -s http://localhost:11434/api/tags > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Ollama" || echo "❌ Ollama"
|
||||
|
||||
# n8n
|
||||
curl -s http://localhost:5678 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ n8n" || echo "❌ n8n"
|
||||
|
||||
# SFTPGo
|
||||
curl -s http://localhost:8080 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ SFTPGo" || echo "❌ SFTPGo"
|
||||
|
||||
# Qdrant
|
||||
curl -s http://localhost:6333/ > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Qdrant" || echo "❌ Qdrant"
|
||||
|
||||
# Momentry API
|
||||
curl -s http://localhost:3002/health > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Momentry API" || echo "❌ Momentry API"
|
||||
|
||||
# Caddy
|
||||
curl -sI http://localhost:8080 > /dev/null 2>&1
|
||||
[ $? -eq 0 ] && echo "✅ Caddy" || echo "❌ Caddy"
|
||||
|
||||
echo ""
|
||||
echo "=========================================="
|
||||
```
|
||||
|
||||
### 7.2 執行驗證
|
||||
|
||||
```bash
|
||||
# 儲存並執行
|
||||
chmod +x health_check.sh
|
||||
./health_check.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 第八部分:重要憑證總覽
|
||||
|
||||
### 8.1 服務密碼
|
||||
|
||||
| 服務 | 用戶名 | 密碼 | 用途 |
|
||||
|------|--------|------|------|
|
||||
| **PostgreSQL** | accusys | `accusys` | 主要資料庫 |
|
||||
| **PostgreSQL** | sftpgo | `sftpgo_pass_2026` | SFTPGo 資料庫 |
|
||||
| **MongoDB** | accusys | `Test3200Test3200` | 文件資料庫 |
|
||||
| **Redis** | - | `accusys` | 快取服務 |
|
||||
| **n8n** | - | `Test3200Test3200Test3200` | n8n 加密金鑰 |
|
||||
| **SFTPGo** | admin | `Test3200Test3200` | SFTPGo 管理員 |
|
||||
| **Qdrant** | - | `Test3200Test3200Test3200` | Qdrant API Key |
|
||||
| **MariaDB** | root | (設定時指定) | WordPress 資料庫 |
|
||||
| **MariaDB** | wordpress | `wordpress_password` | WordPress 資料庫用戶 |
|
||||
|
||||
### 8.2 服務連接埠
|
||||
|
||||
| 服務 | 連接埠 | 協定 |
|
||||
|------|--------|------|
|
||||
| PostgreSQL | 5432 | TCP |
|
||||
| MongoDB | 27017 | TCP |
|
||||
| Redis | 6379 | TCP |
|
||||
| Ollama | 11434 | HTTP |
|
||||
| n8n | 5678 | HTTP |
|
||||
| SFTPGo | 8080 | HTTP |
|
||||
| SFTPGo | 2022 | SFTP |
|
||||
| Qdrant | 6333 | HTTP |
|
||||
| Momentry API | 3002 | HTTP |
|
||||
| Caddy | 80/443 | HTTP/HTTPS |
|
||||
| Gitea | 3000 | HTTP |
|
||||
| PHP-FPM | 9000 | TCP |
|
||||
|
||||
---
|
||||
|
||||
## 第九部分:相關文檔
|
||||
|
||||
| 文檔 | 說明 |
|
||||
|------|------|
|
||||
| `SERVICES.md` | 服務詳細說明 |
|
||||
| `INSTALL_POSTGRESQL.md` | PostgreSQL 安裝指南 |
|
||||
| `INSTALL_MONGODB.md` | MongoDB 安裝指南 |
|
||||
| `INSTALL_REDIS.md` | Redis 安裝指南 |
|
||||
| `INSTALL_QDRANT.md` | Qdrant 安裝指南 |
|
||||
| `INSTALL_N8N.md` | n8n 安裝指南 |
|
||||
| `INSTALL_SFTPGO.md` | SFTPGo 安裝指南 |
|
||||
| `SFTPGO_DEMO_USER.md` | SFTPGo Demo 用戶指南 |
|
||||
| `MOMENTRY_CORE_MONITORING.md` | 監控規範 |
|
||||
| `API_INDEX.md` | API 文件索引 |
|
||||
|
||||
---
|
||||
|
||||
## 附錄:常見問題
|
||||
|
||||
### Q1: n8n 無法連接 PostgreSQL
|
||||
|
||||
確保資料庫用戶有登入權限:
|
||||
```bash
|
||||
psql -U accusys -d postgres -c "ALTER USER accusys WITH LOGIN;"
|
||||
```
|
||||
|
||||
### Q2: SFTPGo 無法啟動
|
||||
|
||||
檢查 PostgreSQL 是否運行:
|
||||
```bash
|
||||
pg_isready -h 127.0.0.1 -p 5432
|
||||
```
|
||||
|
||||
### Q3: Qdrant API Key 無效
|
||||
|
||||
使用正確的 API Key:
|
||||
```bash
|
||||
curl -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
```
|
||||
|
||||
### Q4: Momentry API 無法啟動
|
||||
|
||||
檢查環境變數:
|
||||
```bash
|
||||
export DATABASE_URL="postgres://accusys:accusys@127.0.0.1:5432/momentry"
|
||||
export RUST_LOG=debug
|
||||
momentry server --host 0.0.0.0 --port 3002
|
||||
```
|
||||
@@ -1,467 +0,0 @@
|
||||
# Caddy 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Caddy Web Server,配置為本地部署,作為反向代理伺服器。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Caddy | ✅ 已安裝 v2.10.2 |
|
||||
| 設定檔 | /Users/accusys/momentry/etc/Caddyfile |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.caddy.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Caddy (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Caddy
|
||||
brew install caddy
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
caddy --version
|
||||
# v2.10.2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/caddy
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/caddy
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/caddy.log
|
||||
touch /Users/accusys/momentry/log/caddy.error.log
|
||||
|
||||
# 設定權限
|
||||
# 注意: Caddy 使用 ports 80/443,必須以 root 身份運行
|
||||
# 因此 var/caddy 目錄需要 root:admin 權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/caddy
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
sudo chown -R root:admin /Users/accusys/momentry/var/caddy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/Caddyfile`:
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
metrics
|
||||
}
|
||||
|
||||
# 定義日誌 Snippet
|
||||
(common_log) {
|
||||
log {
|
||||
output file /Users/accusys/momentry/log/{args[0]}.log {
|
||||
roll_size 100mb
|
||||
roll_keep 5
|
||||
roll_keep_for 720h
|
||||
}
|
||||
format json
|
||||
}
|
||||
}
|
||||
|
||||
# Example: 反向代理到本地服務
|
||||
example.momentry.ddns.net {
|
||||
reverse_proxy localhost:8080 {
|
||||
header_up Host {upstream_hostport}
|
||||
}
|
||||
import common_log example_access
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
**注意**: Caddy 需要使用 ports 80 和 443,必須以 root 身份運行。
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.caddy.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "caddy"
|
||||
type: "http"
|
||||
port: 80
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:2019/config/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/etc/caddy/` | 配置 | **不要刪除** - Caddy 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/Users/accusys/momentry/var/caddy/` | 數據 | **不要刪除** - Caddy 數據 |
|
||||
| `/opt/homebrew/opt/caddy/` | 安裝 | **刪除** - Caddy 安裝目錄 |
|
||||
| `/opt/homebrew/opt/caddy/` | 安裝 | **刪除** - Caddy 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Caddy
|
||||
|
||||
```bash
|
||||
# 找到 Caddy 進程
|
||||
ps aux | grep caddy | grep -v grep
|
||||
|
||||
# 停止 Caddy
|
||||
pkill caddy
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep caddy | grep -v grep || echo "Caddy 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Caddy
|
||||
|
||||
```bash
|
||||
# 卸載 Caddy
|
||||
brew uninstall caddy
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/caddy.log
|
||||
rm -f /Users/accusys/momentry/log/caddy.error.log
|
||||
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/caddy
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
# /Users/accusys/momentry/var
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Caddy 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Caddy 進程
|
||||
echo "1. Caddy 進程:"
|
||||
ps aux | grep caddy | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 80/443
|
||||
echo "2. Port 80/443:"
|
||||
(lsof -i :80 > /dev/null 2>&1 || lsof -i :443 > /dev/null 2>&1) && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. caddy 命令
|
||||
echo "3. caddy 命令:"
|
||||
which caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep caddy > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 配置目錄 (可選刪除)
|
||||
echo "6. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Caddy 卸載後檢查 ===
|
||||
1. Caddy 進程:
|
||||
✓ 已停止
|
||||
2. Port 80/443:
|
||||
✓ 已釋放
|
||||
3. caddy 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 配置目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep caddy | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :80
|
||||
lsof -i :443
|
||||
lsof -i :2019
|
||||
|
||||
# 3. 測試配置語法
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 4. 查看 Caddy 版本
|
||||
caddy version
|
||||
|
||||
# 5. 重新載入配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/caddy.log
|
||||
|
||||
# 7. 查看 Caddy 適配的網站
|
||||
curl -I http://localhost:2019/config/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Caddyfile 範例
|
||||
|
||||
### 基本反向代理
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 反向代理到本地服務
|
||||
example.local {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
```
|
||||
|
||||
### 帶 SSL 的反向代理
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 使用 Let's Encrypt 自動 SSL
|
||||
example.momentry.ddns.net {
|
||||
reverse_proxy localhost:8080 {
|
||||
header_up Host {upstream_hostport}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 多站點配置
|
||||
|
||||
```Caddyfile
|
||||
{
|
||||
email admin@accusys.com.tw
|
||||
}
|
||||
|
||||
# 站點 1
|
||||
site1.example.com {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
|
||||
# 站點 2
|
||||
site2.example.com {
|
||||
reverse_proxy localhost:8081
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
CADDY_CONFIG=/Users/accusys/momentry/etc/Caddyfile
|
||||
CADDY_HOME=/Users/accusys/.local/share/caddy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Caddy 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/caddy.log
|
||||
|
||||
# 檢查配置語法
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/etc/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/etc
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 80
|
||||
lsof -i :80
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入配置
|
||||
|
||||
```bash
|
||||
# 重新載入配置 (熱重載)
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 或者停止後重新啟動
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.caddy.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/caddy/` | Caddy 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/caddy/bin/caddy` | Caddy 執行檔 |
|
||||
| 配置 | `/Users/accusys/momentry/etc/Caddyfile` | 設定檔 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/caddy.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/caddy.error.log` | 錯誤日誌 |
|
||||
| 數據 | `/Users/accusys/momentry/var/caddy/` | Caddy 數據目錄 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.caddy.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/caddy_backup/Caddyfile` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 驗證配置
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 熱重載配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 停止 Caddy
|
||||
caddy stop
|
||||
|
||||
# 啟動 Caddy
|
||||
caddy start --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 適配所有網站
|
||||
caddy adapt --config /Users/accusys/momentry/etc/Caddyfile --adapter caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/daily/caddy"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 備份配置
|
||||
tar -czf "$BACKUP_DIR/caddy_cfg_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 驗證
|
||||
sha256sum "$BACKUP_DIR/caddy_cfg_${TIMESTAMP}.tar.gz" > "$BACKUP_DIR/caddy_${TIMESTAMP}.sha256"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 解壓配置
|
||||
tar -xzf /Users/accusys/momentry/backup/daily/caddy/caddy_cfg_20260316_102416.tar.gz -C /
|
||||
|
||||
# 驗證並重載
|
||||
caddy validate --config /Users/accusys/momentry/etc/Caddyfile
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 2.10.2
|
||||
- 配置: /Users/accusys/momentry/etc/Caddyfile
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,410 +0,0 @@
|
||||
# Gitea 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Gitea Git 服務,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Gitea | ✅ 已安裝 v1.25.3 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/gitea/ |
|
||||
| 配置目錄 | /Users/accusys/momentry/etc/gitea/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Gitea (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Gitea
|
||||
brew install gitea
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
gitea --version
|
||||
# gitea version 1.25.3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/gitea/data
|
||||
mkdir -p /Users/accusys/momentry/var/gitea/log
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/gitea.log
|
||||
touch /Users/accusys/momentry/log/gitea.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/gitea
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/gitea
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/gitea/app.ini`:
|
||||
|
||||
```ini
|
||||
APP_NAME = Gitea: Git with a cup of tea
|
||||
RUN_USER = accusys
|
||||
WORK_PATH = /Users/accusys/momentry/var/gitea
|
||||
RUN_MODE = prod
|
||||
|
||||
[database]
|
||||
DB_TYPE = postgres
|
||||
HOST = 127.0.0.1:5432
|
||||
NAME = gitea
|
||||
USER = gitea
|
||||
PASSWD = gitea_pass
|
||||
SSL_MODE = disable
|
||||
|
||||
[repository]
|
||||
ROOT = /Users/accusys/momentry/var/gitea/data/gitea-repositories
|
||||
|
||||
[server]
|
||||
SSH_DOMAIN = gitea.momentry.ddns.net
|
||||
DOMAIN = gitea.momentry.ddns.net
|
||||
HTTP_PORT = 3000
|
||||
ROOT_URL = http://gitea.momentry.ddns.net:3000/
|
||||
APP_DATA_PATH = /Users/accusys/momentry/var/gitea/data
|
||||
DISABLE_SSH = false
|
||||
SSH_PORT = 2222
|
||||
LFS_START_SERVER = true
|
||||
OFFLINE_MODE = true
|
||||
|
||||
[lfs]
|
||||
PATH = /Users/accusys/momentry/var/gitea/data/lfs
|
||||
|
||||
[log]
|
||||
MODE = console, file
|
||||
ROOT_PATH = /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.gitea.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "gitea"
|
||||
type: "http"
|
||||
port: 3000
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:3000/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/gitea/` | 數據 | **不要刪除** - Gitea 數據 |
|
||||
| `/Users/accusys/momentry/etc/gitea/` | 配置 | **不要刪除** - Gitea 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/gitea/` | 安裝 | **刪除** - Gitea 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Gitea
|
||||
|
||||
```bash
|
||||
# 找到 Gitea 進程
|
||||
ps aux | grep gitea | grep -v grep
|
||||
|
||||
# 停止 Gitea
|
||||
pkill gitea
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep gitea | grep -v grep || echo "Gitea 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Gitea
|
||||
|
||||
```bash
|
||||
# 卸載 Gitea
|
||||
brew uninstall gitea
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/gitea
|
||||
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/gitea
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/gitea.log
|
||||
rm -f /Users/accusys/momentry/log/gitea.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Gitea 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Gitea 進程
|
||||
echo "1. Gitea 進程:"
|
||||
ps aux | grep gitea | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 3000
|
||||
echo "2. Port 3000:"
|
||||
lsof -i :3000 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. gitea 命令
|
||||
echo "3. gitea 命令:"
|
||||
which gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep gitea > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/gitea" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 配置目錄 (可選刪除)
|
||||
echo "7. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc/gitea" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Gitea 卸載後檢查 ===
|
||||
1. Gitea 進程:
|
||||
✓ 已停止
|
||||
2. Port 3000:
|
||||
✓ 已釋放
|
||||
3. gitea 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 配置目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep gitea | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :3000
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:3000/
|
||||
|
||||
# 4. 查看版本
|
||||
gitea --version
|
||||
|
||||
# 5. 驗證配置
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/gitea.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| URL | http://localhost:3000 |
|
||||
| Domain | gitea.momentry.ddns.net |
|
||||
| SSH Port | 2222 |
|
||||
| Database | PostgreSQL (gitea) |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
GITEA_URL=http://localhost:3000
|
||||
GITEA_ROOT=/Users/accusys/momentry/var/gitea/data/gitea-repositories
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Gitea 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea.log
|
||||
|
||||
# 檢查配置語法
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/gitea/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/gitea
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 3000
|
||||
lsof -i :3000
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.gitea.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.gitea.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/gitea/` | Gitea 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/gitea/bin/gitea` | Gitea 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/gitea/data/` | 數據儲存 |
|
||||
| 配置 | `/Users/accusys/momentry/etc/gitea/app.ini` | 設定檔 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/gitea.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/gitea.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.gitea.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/gitea_backup/app.ini` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 資料庫資訊
|
||||
|
||||
Gitea 使用 PostgreSQL 作為資料庫:
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Database | gitea |
|
||||
| User | gitea |
|
||||
| Host | 127.0.0.1:5432 |
|
||||
| Password | gitea_pass |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 啟動 Gitea
|
||||
gitea web --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 驗證配置
|
||||
gitea doctor --config /Users/accusys/momentry/etc/gitea/app.ini
|
||||
|
||||
# 查看版本
|
||||
gitea --version
|
||||
|
||||
# 備份數據
|
||||
gitea dump --config /Users/accusys/momentry/etc/gitea/app.ini --zipfile /Users/accusys/momentry/var/gitea_backup.zip
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.25.3
|
||||
- HTTP Port: 3000
|
||||
- SSH Port: 2222
|
||||
- 數據目錄: /Users/accusys/momentry/var/gitea/
|
||||
- 配置: /Users/accusys/momentry/etc/gitea/app.ini
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,393 +0,0 @@
|
||||
# Gitea MCP Server 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-24 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-24 | 創建文件 | OpenCode | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Gitea MCP Server,配置為透過 OpenCode MCP 整合存取 Gitea API。
|
||||
|
||||
Gitea MCP Server 是一個 MCP (Model Context Protocol) 伺服器,提供對 Gitea API 的完整存取能力,包括 repos、issues、pull requests、workflows 等資源管理。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Gitea MCP Server | ✅ 已安裝 |
|
||||
| 安裝方式 | Homebrew (`gitea-mcp-server`) |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist |
|
||||
| 執行身份 | accusys |
|
||||
| 監聽端口 | 8787 |
|
||||
| Gitea 主機 | http://localhost:3000 |
|
||||
| Launchd 狀態 | ✅ 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
---
|
||||
|
||||
## 前置條件
|
||||
|
||||
- Gitea 服務已運行(端口 3000)
|
||||
- Homebrew 已安裝
|
||||
- 管理員權限
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Gitea MCP Server
|
||||
|
||||
```bash
|
||||
brew install gitea-mcp-server
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which gitea-mcp-server
|
||||
# /opt/homebrew/bin/gitea-mcp-server
|
||||
|
||||
/opt/homebrew/bin/gitea-mcp-server --help
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 創建日誌目錄
|
||||
|
||||
```bash
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
touch /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
touch /Users/accusys/momentry/log/gitea-mcp-server.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 獲取 Gitea API Token
|
||||
|
||||
#### 步驟 3.1: 登入 Gitea
|
||||
|
||||
1. 開啟瀏覽器,訪問 http://localhost:3000
|
||||
2. 使用管理員帳號登入
|
||||
|
||||
#### 步驟 3.2: 生成 Personal Access Token
|
||||
|
||||
1. 點擊右上角頭像 → **Settings**
|
||||
2. 左側選單選擇 **Applications**
|
||||
3. 在 **Access Tokens** 區塊:
|
||||
- **Token Name**: `opencode-mcp`
|
||||
- **Expiration**: 選擇過期時間(如 365 days)
|
||||
- **Scopes**: 勾選需要的權限
|
||||
- `repo` - 倉庫操作
|
||||
- `read:user` - 讀取用戶資訊
|
||||
- `read:org` - 讀取組織資訊
|
||||
4. 點擊 **Generate Token**
|
||||
5. **立即複製** 生成的 Token
|
||||
|
||||
#### 步驟 3.3: 驗證 Token
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: token <YOUR_TOKEN>" http://localhost:3000/api/v1/user
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 創建 Plist 檔案
|
||||
|
||||
```bash
|
||||
sudo tee /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.gitea-mcp-server</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/opt/homebrew/bin/gitea-mcp-server</string>
|
||||
<string>-transport</string>
|
||||
<string>http</string>
|
||||
<string>-port</string>
|
||||
<string>8787</string>
|
||||
<string>-host</string>
|
||||
<string>http://localhost:3000</string>
|
||||
<string>-token</string>
|
||||
<string><GITEA_TOKEN></string>
|
||||
</array>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/gitea-mcp-server.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/gitea-mcp-server.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
```
|
||||
|
||||
**注意**: 將 `<GITEA_TOKEN>` 替換為實際的 Token 值。
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 設定權限
|
||||
|
||||
```bash
|
||||
sudo chown root:wheel /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
sudo chmod 644 /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: 載入服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 7: 驗證服務
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
sudo launchctl list | grep gitea-mcp-server
|
||||
|
||||
# 檢查進程
|
||||
ps aux | grep gitea-mcp-server | grep -v grep
|
||||
|
||||
# 測試端點
|
||||
curl -s http://localhost:8787/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 8: 整合 OpenCode MCP
|
||||
|
||||
#### 步驟 8.1: 更新 OpenCode 配置
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 步驟 8.2: 重啟 OpenCode
|
||||
|
||||
```bash
|
||||
# 停止現有 OpenCode
|
||||
pkill -f opencode
|
||||
|
||||
# 重新啟動
|
||||
opencode
|
||||
```
|
||||
|
||||
#### 步驟 8.3: 驗證 MCP 連接
|
||||
|
||||
在 OpenCode 中執行:
|
||||
|
||||
```
|
||||
/mcps
|
||||
```
|
||||
|
||||
確認 gitea 顯示為 `connected`。
|
||||
|
||||
---
|
||||
|
||||
## Plist 參數說明
|
||||
|
||||
| 參數 | 說明 | 值 |
|
||||
|------|------|-----|
|
||||
| `-transport` | 傳輸類型 | `http` |
|
||||
| `-port` | HTTP 監聽端口 | `8787` |
|
||||
| `-host` | Gitea 主機 URL | `http://localhost:3000` |
|
||||
| `-token` | Gitea API Token | 見 Step 3 |
|
||||
|
||||
---
|
||||
|
||||
## 管理指令
|
||||
|
||||
### 啟動服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 停止服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 重啟服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 查看日誌
|
||||
|
||||
```bash
|
||||
# 即時查看日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
|
||||
# 錯誤日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### Step 1: 停止服務
|
||||
|
||||
```bash
|
||||
sudo launchctl bootout system/com.momentry.gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 移除 Plist
|
||||
|
||||
```bash
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 從 OpenCode 配置移除
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`,移除 `mcp.gitea` 區塊。
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 服務無法啟動
|
||||
|
||||
1. 檢查 Token 是否正確
|
||||
2. 檢查 Gitea 是否運行:`curl -s http://localhost:3000/`
|
||||
3. 檢查日誌:`/Users/accusys/momentry/log/gitea-mcp-server.error.log`
|
||||
|
||||
---
|
||||
|
||||
### Token 無效
|
||||
|
||||
1. 確認 Token 未過期
|
||||
2. 確認 Token 有足夠的權限
|
||||
3. 重新生成 Token
|
||||
|
||||
---
|
||||
|
||||
### 端口被佔用
|
||||
|
||||
```bash
|
||||
# 檢查端口占用
|
||||
lsof -i :8787
|
||||
|
||||
# 修改 plist 中的端口後重新載入
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### OpenCode MCP 未顯示
|
||||
|
||||
1. 確認 OpenCode 已重啟
|
||||
2. 檢查 `~/.config/opencode/opencode.json` 格式正確
|
||||
3. 確認 gitea-mcp-server 程序正在運行
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.gitea-mcp-server.plist | Launchd 服務配置 |
|
||||
| 日誌 | /Users/accusys/momentry/log/gitea-mcp-server.log | 標準輸出日誌 |
|
||||
| 錯誤日誌 | /Users/accusys/momentry/log/gitea-mcp-server.error.log | 錯誤日誌 |
|
||||
| OpenCode 配置 | ~/.config/opencode/opencode.json | MCP 設定檔 |
|
||||
| Gitea | http://localhost:3000 | Gitea Web UI |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 驗證服務狀態
|
||||
sudo launchctl list | grep gitea-mcp-server
|
||||
|
||||
# 查看服務 PID
|
||||
ps aux | grep gitea-mcp-server | grep -v grep
|
||||
|
||||
# 測試端點
|
||||
curl -s http://localhost:8787/
|
||||
|
||||
# 驗證 Gitea 連接
|
||||
curl -H "Authorization: token <TOKEN>" http://localhost:3000/api/v1/user
|
||||
|
||||
# 查看即時日誌
|
||||
tail -f /Users/accusys/momentry/log/gitea-mcp-server.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.0
|
||||
- 安裝日期: 2026-03-24
|
||||
- 文件更新: 2026-03-24
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OpenCode MCP 整合](./N8N_MCP_SETUP.md) - n8n MCP 設定說明
|
||||
- [服務總覽](./SERVICES.md) - 所有服務狀態總覽
|
||||
- [待解決問題](./PENDING_ISSUES.md) - MCP 安裝狀態追蹤
|
||||
@@ -1,396 +0,0 @@
|
||||
# MariaDB 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 MariaDB,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| MariaDB | ✅ 已安裝 v12.1.2 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/mariadb/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.mariadb.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 MariaDB (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 MariaDB
|
||||
brew install mariadb
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
mariadb --version
|
||||
# mariadb from 12.1.2-MariaDB
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/mariadb
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/mariadb.log
|
||||
touch /Users/accusys/momentry/log/mariadb.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/mariadb
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/mariadb
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
**注意**: 如果需要從舊數據遷移,需要先初始化新目錄:
|
||||
```bash
|
||||
# 初始化新數據目錄
|
||||
mysql_install_db --datadir=/Users/accusys/momentry/var/mariadb
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.mariadb.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
mariadb:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 3306
|
||||
user: "root"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/mariadb/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/mariadb/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/mariadb/` | 安裝 | **刪除** - MariaDB 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 MariaDB
|
||||
|
||||
```bash
|
||||
# 找到 MariaDB 進程
|
||||
ps aux | grep mariadb | grep -v grep
|
||||
|
||||
# 停止 MariaDB
|
||||
mysqladmin -u root -p shutdown
|
||||
# 或
|
||||
pkill mariadbd
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep mariadb | grep -v grep || echo "MariaDB 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 MariaDB
|
||||
|
||||
```bash
|
||||
# 卸載 MariaDB
|
||||
brew uninstall mariadb
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/mariadb.log
|
||||
rm -f /Users/accusys/momentry/log/mariadb.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== MariaDB 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 MariaDB 進程
|
||||
echo "1. MariaDB 進程:"
|
||||
ps aux | grep mariadb | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 3306
|
||||
echo "2. Port 3306:"
|
||||
lsof -i :3306 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. mariadb 命令
|
||||
echo "3. mariadb 命令:"
|
||||
which mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep mariadb > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/mariadb" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== MariaDB 卸載後檢查 ===
|
||||
1. MariaDB 進程:
|
||||
✓ 已停止
|
||||
2. Port 3306:
|
||||
✓ 已釋放
|
||||
3. mariadb 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep mariadb | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :3306
|
||||
|
||||
# 3. 測試連線
|
||||
mariadb -u root -e "SELECT 1;"
|
||||
|
||||
# 4. 查看所有數據庫
|
||||
mariadb -u root -e "SHOW DATABASES;"
|
||||
|
||||
# 5. 查看用戶
|
||||
mariadb -u root -e "SELECT User, Host FROM mysql.user;"
|
||||
|
||||
# 6. 查看表
|
||||
mariadb -u root -e "USE mysql; SHOW TABLES;"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/mariadb.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 3306 |
|
||||
| User | root |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
MARIADB_URL=mariadb://root@localhost:3306
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- MariaDB 綁定到所有網路介面 (0.0.0.0)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請設定用戶權限限制訪問
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MariaDB 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/mariadb.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/mariadb/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/mariadb
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 3306
|
||||
lsof -i :3306
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mariadb.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/mariadb/` | MariaDB 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/mariadb/bin/mariadbd` | MariaDB 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/mariadb/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/mariadb.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/mariadb.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.mariadb.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/mariadb_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份用戶配置
|
||||
|
||||
已創建專用備份用戶:
|
||||
- 用戶名:`momentry_backup`
|
||||
- 密碼:`momentry_backup_pwd_2026`
|
||||
- 權限:SELECT, LOCK TABLES, SHOW VIEW, EVENT, TRIGGER
|
||||
|
||||
### 備份 (mysqldump)
|
||||
|
||||
```bash
|
||||
# 備份所有數據庫
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
mysqldump -u momentry_backup -pmomentry_backup_pwd_2026 --all-databases | gzip > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_all_${TIMESTAMP}.sql.gz
|
||||
|
||||
# 備份指定數據庫 (WordPress)
|
||||
mysqldump -u momentry_backup -pmomentry_backup_pwd_2026 wordpress | gzip > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_wordpress_${TIMESTAMP}.sql.gz
|
||||
|
||||
# 驗證
|
||||
sha256sum /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_*.sql.gz > \
|
||||
/Users/accusys/momentry/backup/daily/mariadb/mariadb_db_${TIMESTAMP}.sha256
|
||||
```
|
||||
|
||||
### 恢復 (mysql)
|
||||
|
||||
```bash
|
||||
# 恢復所有數據庫
|
||||
gunzip < /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_all_20260316_101802.sql.gz | \
|
||||
mysql -u momentry_backup -pmomentry_backup_pwd_2026
|
||||
|
||||
# 恢復指定數據庫
|
||||
gunzip < /Users/accusys/momentry/backup/daily/mariadb/mariadb_db_wordpress_20260316_101802.sql.gz | \
|
||||
mysql -u momentry_backup -pmomentry_backup_pwd_2026 wordpress
|
||||
```
|
||||
|
||||
### 數據目錄複製 (完整遷移) - 離線
|
||||
|
||||
```bash
|
||||
# 1. 停止 MariaDB
|
||||
mysqladmin -u momentry_backup -pmomentry_backup_pwd_2026 shutdown
|
||||
|
||||
# 2. 複製數據目錄
|
||||
cp -r /opt/homebrew/var/mysql/* /Users/accusys/momentry/var/mariadb/
|
||||
|
||||
# 3. 設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/mariadb
|
||||
|
||||
# 4. 啟動 MariaDB
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mariadb.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 12.1.2
|
||||
- Port: 3306
|
||||
- User: root
|
||||
- 數據目錄: /Users/accusys/momentry/var/mariadb/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,464 +0,0 @@
|
||||
# Momentry Core API 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | OpenCode | - |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Momentry Core API 服務,配置為本地部署,並設定開機自動啟動。
|
||||
|
||||
Momentry Core API 是一個 Rust 編寫的數位資產管理 API 服務,提供:
|
||||
- 影片搜尋 API (`/api/v1/search`)
|
||||
- n8n 整合 API (`/api/v1/n8n/search`)
|
||||
- 健康檢查端點 (`/health`)
|
||||
- 影片註冊與處理功能
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Momentry Core API | ✅ 已安裝 v0.1.0 |
|
||||
| Binary | `/Users/accusys/momentry_core_0.1/target/release/momentry` |
|
||||
| Port | 3002 |
|
||||
| 反向代理 | Caddy (`api.momentry.ddns.net`) |
|
||||
| 數據庫 | PostgreSQL (momentry) |
|
||||
| 向量庫 | Qdrant |
|
||||
| Cache | Redis |
|
||||
| launchd plist | ✅ 已建立 (/Library/LaunchDaemons/com.momentry.api.plist) |
|
||||
|
||||
---
|
||||
|
||||
## 系統需求
|
||||
|
||||
### 必要服務
|
||||
|
||||
| 服務 | 版本 | 用途 |
|
||||
|------|------|------|
|
||||
| PostgreSQL | 16+ | 主數據庫 |
|
||||
| Redis | 1.0+ | 快取與佇列 |
|
||||
| Qdrant | 1.7+ | 向量搜尋 |
|
||||
| Ollama | 最新 | LLM 與 Embedding |
|
||||
|
||||
### Rust 環境
|
||||
|
||||
```bash
|
||||
# 檢查 Rust 版本
|
||||
rustc --version
|
||||
cargo --version
|
||||
|
||||
# 如需安裝 Rust
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 編譯 Momentry Core
|
||||
|
||||
```bash
|
||||
# 進入專案目錄
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
|
||||
# 編譯 release 版本
|
||||
cargo build --release
|
||||
|
||||
# 驗證編譯結果
|
||||
ls -la target/release/momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 設定環境變數
|
||||
|
||||
建立環境變數檔案:
|
||||
|
||||
```bash
|
||||
# 建立執行目錄
|
||||
mkdir -p /Users/accusys/momentry_core_0.1/momentry_runtime/env
|
||||
|
||||
# 建立環境變數檔案
|
||||
cat > /Users/accusys/momentry_core_0.1/momentry_runtime/env/momentry.env << 'EOF'
|
||||
# Database Configuration
|
||||
DATABASE_URL=postgres://accusys@localhost:5432/momentry
|
||||
|
||||
# Redis Configuration
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
REDIS_PASSWORD=accusys
|
||||
|
||||
# API Server
|
||||
API_HOST=127.0.0.1
|
||||
API_PORT=3002
|
||||
|
||||
# Ollama (LLM)
|
||||
OLLAMA_HOST=http://localhost:11434
|
||||
|
||||
# Qdrant (Vector Database)
|
||||
QDRANT_URL=http://localhost:6333
|
||||
QDRANT_COLLECTION=momentry_chunks
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 手動啟動服務
|
||||
|
||||
```bash
|
||||
# 啟動 API 服務
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
./target/release/momentry server --port 3002
|
||||
|
||||
# 驗證服務
|
||||
curl http://localhost:3002/health
|
||||
# {"status":"ok","version":"0.1.0","uptime_ms":1234}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 設定 Caddy 反向代理
|
||||
|
||||
在 `/Users/accusys/momentry/etc/Caddyfile` 中新增:
|
||||
|
||||
```caddy
|
||||
# Momentry Core API
|
||||
api.momentry.ddns.net {
|
||||
reverse_proxy localhost:3002
|
||||
import common_log momentry_api_access
|
||||
}
|
||||
```
|
||||
|
||||
重新載入 Caddy:
|
||||
|
||||
```bash
|
||||
# 重新載入配置
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
|
||||
# 驗證
|
||||
curl -sk https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 建立 launchd plist (開機自動啟動)
|
||||
|
||||
建立 plist 檔案:
|
||||
|
||||
```bash
|
||||
sudo tee /Library/LaunchDaemons/com.momentry.api.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.api</string>
|
||||
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
|
||||
<key>GroupName</key>
|
||||
<string>staff</string>
|
||||
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/momentry_core_0.1</string>
|
||||
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/Users/accusys/momentry_core_0.1/target/release/momentry</string>
|
||||
<string>server</string>
|
||||
<string>--port</string>
|
||||
<string>3002</string>
|
||||
</array>
|
||||
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>PATH</key>
|
||||
<string>/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>
|
||||
|
||||
<key>DATABASE_URL</key>
|
||||
<string>postgres://accusys@localhost:5432/momentry</string>
|
||||
|
||||
<key>REDIS_URL</key>
|
||||
<string>redis://:accusys@localhost:6379</string>
|
||||
|
||||
<key>REDIS_PASSWORD</key>
|
||||
<string>accusys</string>
|
||||
|
||||
<key>OLLAMA_HOST</key>
|
||||
<string>http://localhost:11434</string>
|
||||
|
||||
<key>QDRANT_URL</key>
|
||||
<string>http://localhost:6333</string>
|
||||
</dict>
|
||||
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry_api.log</string>
|
||||
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/momentry_api.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
```
|
||||
|
||||
建立日誌檔案:
|
||||
|
||||
```bash
|
||||
# 建立日誌目錄(如不存在)
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌檔案
|
||||
touch /Users/accusys/momentry/log/momentry_api.log
|
||||
touch /Users/accusys/momentry/log/momentry_api.error.log
|
||||
|
||||
# 設定權限
|
||||
chown accusys:staff /Users/accusys/momentry/log/momentry_api.log
|
||||
chown accusys:staff /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
載入服務:
|
||||
|
||||
```bash
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 驗證服務
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 檢查服務狀態
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### Step 1: 停止並移除服務
|
||||
|
||||
```bash
|
||||
# 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
### Step 2: 移除 Caddy 配置
|
||||
|
||||
從 `/Users/accusys/momentry/etc/Caddyfile` 中移除 `api.momentry.ddns.net` 區塊。
|
||||
|
||||
```bash
|
||||
# 重新載入 Caddy
|
||||
caddy reload --config /Users/accusys/momentry/etc/Caddyfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### API 返回 502 Bad Gateway
|
||||
|
||||
**問題**: `api.momentry.ddns.net` 返回 502 錯誤
|
||||
|
||||
**原因**: Momentry Core API 服務未啟動
|
||||
|
||||
**解決方案**:
|
||||
|
||||
```bash
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
|
||||
# 如服務未啟動,手動啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 或手動啟動測試
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
./target/release/momentry server --port 3002
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### API 返回 404 Not Found
|
||||
|
||||
**問題**: 端點返回 404
|
||||
|
||||
**原因**: Binary 過舊,缺少該端點
|
||||
|
||||
**解決方案**:
|
||||
|
||||
```bash
|
||||
# 重新編譯
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
cargo build --release
|
||||
|
||||
# 重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 服務無法啟動
|
||||
|
||||
**問題**: launchd 無法啟動服務
|
||||
|
||||
**檢查步驟**:
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
|
||||
# 檢查 plist 語法
|
||||
plutil -lint /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 檢查權限
|
||||
ls -la /Users/accusys/momentry_core_0.1/target/release/momentry
|
||||
|
||||
# 手動測試
|
||||
/Users/accusys/momentry_core_0.1/target/release/momentry server --port 3002
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| Binary | `/Users/accusys/momentry_core_0.1/target/release/momentry` | 執行檔 |
|
||||
| 環境變數 | `/Users/accusys/momentry_core_0.1/momentry_runtime/env/momentry.env` | 環境設定 |
|
||||
| launchd plist | `/Library/LaunchDaemons/com.momentry.api.plist` | 開機啟動配置 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/momentry_api.log` | 標準輸出 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/momentry_api.error.log` | 錯誤輸出 |
|
||||
| Caddy 配置 | `/Users/accusys/momentry/etc/Caddyfile` | 反向代理配置 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
### 服務管理
|
||||
|
||||
```bash
|
||||
# 啟動服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
|
||||
# 檢查服務狀態
|
||||
launchctl list | grep momentry.api
|
||||
```
|
||||
|
||||
### 健康檢查
|
||||
|
||||
```bash
|
||||
# 本地健康檢查
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 詳細健康檢查
|
||||
curl http://localhost:3002/health/detailed
|
||||
|
||||
# 外部健康檢查
|
||||
curl -sk https://api.momentry.ddns.net/health
|
||||
```
|
||||
|
||||
### API 測試
|
||||
|
||||
```bash
|
||||
# 搜尋 API
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"test"}'
|
||||
|
||||
# n8n 搜尋 API
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"test"}'
|
||||
|
||||
# 列出影片
|
||||
curl http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 日誌查看
|
||||
|
||||
```bash
|
||||
# 查看最近的日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.log
|
||||
|
||||
# 即時監控日誌
|
||||
tail -f /Users/accusys/momentry/log/momentry_api.log
|
||||
|
||||
# 查看錯誤日誌
|
||||
tail -50 /Users/accusys/momentry/log/momentry_api.error.log
|
||||
```
|
||||
|
||||
### 重新編譯
|
||||
|
||||
```bash
|
||||
# 編譯 release 版本
|
||||
cd /Users/accusys/momentry_core_0.1
|
||||
cargo build --release
|
||||
|
||||
# 編譯後重啟服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.api.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.api.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 端點
|
||||
|
||||
| 端點 | 方法 | 說明 |
|
||||
|------|------|------|
|
||||
| `/health` | GET | 健康檢查 |
|
||||
| `/health/detailed` | GET | 詳細健康檢查 |
|
||||
| `/api/v1/register` | POST | 註冊影片 |
|
||||
| `/api/v1/search` | POST | 搜尋影片 |
|
||||
| `/api/v1/n8n/search` | POST | n8n 格式搜尋 |
|
||||
| `/api/v1/search/hybrid` | POST | 混合搜尋 |
|
||||
| `/api/v1/lookup` | GET | 查詢 UUID |
|
||||
| `/api/v1/videos` | GET | 列出所有影片 |
|
||||
| `/api/v1/progress/:uuid` | GET | 查詢處理進度 |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 0.1.0
|
||||
- 安裝日期: 2026-03-23
|
||||
- Rust 版本: 1.xx
|
||||
- 文件更新: 2026-03-23
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- `docs/SERVICES.md` - 服務總覽
|
||||
- `docs/API_REFERENCE.md` - API 參考
|
||||
- `docs/INSTALL_POSTGRESQL.md` - PostgreSQL 安裝
|
||||
- `docs/INSTALL_REDIS.md` - Redis 安裝
|
||||
- `docs/INSTALL_QDRANT.md` - Qdrant 安裝
|
||||
- `docs/PENDING_ISSUES.md` - 待解決問題
|
||||
@@ -1,392 +0,0 @@
|
||||
# MongoDB 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 MongoDB Community Edition,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| MongoDB (mongodb-community) | ✅ 已安裝 v8.2.6 |
|
||||
| 數據目錄 | /opt/homebrew/var/mongodb |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 MongoDB Community
|
||||
|
||||
```bash
|
||||
# 安裝 MongoDB Community
|
||||
brew tap mongodb/brew
|
||||
brew install mongodb-community
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
mongod --version
|
||||
# db version v8.x.x
|
||||
mongosh --version
|
||||
# 2.7.x
|
||||
sudo launchctl list | grep mongo
|
||||
# 確認 MongoDB 服務已載入
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 數據目錄 (已存在 - 共用)
|
||||
|
||||
數據目錄使用 homebrew 預設位置:
|
||||
- 數據目錄: `/opt/homebrew/var/mongodb`
|
||||
- 配置目錄: `/opt/homebrew/etc/mongod.conf`
|
||||
- 日誌目錄: `/Users/accusys/momentry/log`
|
||||
|
||||
**建立配置目錄和日誌文件**:
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/mongodb
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/mongodb.log
|
||||
touch /Users/accusys/momentry/log/mongodb.error.log
|
||||
|
||||
# 確認權限:
|
||||
ls -la /Users/accusys/momentry/
|
||||
chown -R accusys:staff /Users/accusys/momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 LaunchAgent 啟動 (開機自動)
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄 (開機自動需要 root 權限)
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.mongodb.plist \
|
||||
/Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mongodb.plist
|
||||
|
||||
# 驗證
|
||||
launchctl list | grep mongodb
|
||||
pgrep -a mongod
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 建立資料庫用戶
|
||||
|
||||
```bash
|
||||
mongosh --eval '
|
||||
use admin
|
||||
db.createUser({
|
||||
user: "accusys",
|
||||
pwd: "Test3200Test3200",
|
||||
roles: [
|
||||
{ role: "readWrite", db: "momentry" },
|
||||
{ role: "dbAdmin", db: "momentry" }
|
||||
]
|
||||
})
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 驗證安裝
|
||||
|
||||
```bash
|
||||
# 檢查進程
|
||||
pgrep -a mongod
|
||||
|
||||
# 檢查端口
|
||||
lsof -i :27017
|
||||
|
||||
# 測試連線
|
||||
mongosh --eval "db.adminCommand('ping')"
|
||||
|
||||
# 檢查 LaunchAgent
|
||||
launchctl list | grep mongodb
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
mongodb:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 27017
|
||||
user: "accusys"
|
||||
database: "momentry"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/` | 共用 | **不要刪除** - 多個系統共用 |
|
||||
| `/Users/accusys/momentry/var` | 共用 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/mongodb/` | 配置 | **不要刪除** - MongoDB 配置 |
|
||||
| `/Users/accusys/momentry/log` | 共用 | **不要刪除** - 日誌目錄 |
|
||||
| `~/.mongosh_history` | 專屬 | 可選刪除 - Mongo Shell 歷史 |
|
||||
|
||||
### Step 1: 停止 MongoDB
|
||||
|
||||
```bash
|
||||
# 找到 MongoDB 進程
|
||||
ps aux | grep mongod | grep -v grep
|
||||
|
||||
# 停止 MongoDB
|
||||
pkill mongod
|
||||
# 或
|
||||
kill <PID>
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep mongod | grep -v grep || echo "MongoDB 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 MongoDB
|
||||
|
||||
```bash
|
||||
# 完全卸載 (保留數據)
|
||||
brew uninstall mongodb-community
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除 MongoDB 專屬配置 (如果有)
|
||||
rm -f ~/.mongosh_history
|
||||
|
||||
# 刪除臨時文件 (可選)
|
||||
rm -rf /tmp/mongodb-*
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== MongoDB 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 MongoDB 進程
|
||||
echo "1. MongoDB 進程:"
|
||||
ps aux | grep mongod | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. 檢查 Port 27017
|
||||
echo "2. Port 27017:"
|
||||
lsof -i :27017 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. 檢查 mongod 命令
|
||||
echo "3. mongod 命令:"
|
||||
which mongod > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. 檢查 launchctl
|
||||
echo "4. launchctl 服務:"
|
||||
sudo launchctl list | grep mongo > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. 檢查 Homebrew
|
||||
echo "5. Homebrew 移除:"
|
||||
brew list mongo > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 檢查數據目錄 (應該存在)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 檢查日誌目錄 (應該存在)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== MongoDB 卸載後檢查 ===
|
||||
1. MongoDB 進程:
|
||||
✓ 已停止
|
||||
2. Port 27017:
|
||||
✓ 已釋放
|
||||
3. mongod 命令:
|
||||
✓ 已移除
|
||||
4. launchctl 服務:
|
||||
✓ 已移除
|
||||
5. Homebrew 移除:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留
|
||||
7. 日誌目錄:
|
||||
✓ 保留
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查 Process 是否運行
|
||||
ps aux | grep mongo | grep -v grep
|
||||
|
||||
# 2. 檢查 Port 27017
|
||||
lsof -i :27017
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
mongosh --eval "db.adminCommand('ping')"
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --eval "db.adminCommand('ping')"
|
||||
|
||||
# 5. 查看所有資料庫
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --quiet --eval "db.adminCommand({listDatabases:1}).databases"
|
||||
|
||||
# 6. 查看用戶
|
||||
mongosh "mongodb://accusys:Test3200Test3200@localhost:27017/admin" --quiet --eval "db.getUser('accusys')"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/mongodb.log
|
||||
tail -20 /Users/accusys/momentry/log/mongodb.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 管理命令
|
||||
|
||||
### 啟動/停止
|
||||
|
||||
```bash
|
||||
# 使用 LaunchAgent (開機自動 - LaunchDaemons 目錄)
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.mongodb.plist # 啟動
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.mongodb.plist # 停止
|
||||
|
||||
# 手動啟動 (僅除錯用)
|
||||
nohup /opt/homebrew/bin/mongod \
|
||||
--dbpath /Users/accusys/momentry/var \
|
||||
--logpath /Users/accusys/momentry/log/mongodb.log \
|
||||
--port 27017 \
|
||||
--bind_ip 0.0.0.0 \
|
||||
> /Users/accusys/momentry/log/mongodb.log 2>&1 &
|
||||
|
||||
# 強制停止
|
||||
pkill mongod
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線字串
|
||||
|
||||
```bash
|
||||
# 無認證 (本地)
|
||||
mongodb://localhost:27017
|
||||
|
||||
# 有認證 (admin 資料庫)
|
||||
mongodb://accusys:Test3200Test3200@localhost:27017/admin
|
||||
|
||||
# 有認證 (momentry 資料庫)
|
||||
mongodb://accusys:Test3200Test3200@localhost:27017/momentry?authSource=admin
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
MONGODB_URL=mongodb://accusys:Test3200Test3200@localhost:27017/admin
|
||||
MONGODB_DATABASE=momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- MongoDB 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 建議設定防火牆規則限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MongoDB 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/mongodb.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 27017
|
||||
lsof -i :27017
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 數據目錄 | `/Users/accusys/momentry/var` | **共用 - 不要刪除** |
|
||||
| 日誌目錄 | `/Users/accusys/momentry/log` | **共用 - 不要刪除** |
|
||||
| mongod | `/opt/homebrew/bin/mongod` | 安裝後存在 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongodb-community/` | 卸載時刪除 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongodb-database-tools/` | 卸載時刪除 |
|
||||
| Homebrew | `/opt/homebrew/Cellar/mongosh/` | 卸載時刪除 |
|
||||
| 配置檔 | `/opt/homebrew/etc/mongod.conf` | 卸載時刪除 |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 用戶: accusys
|
||||
- 密碼: Test3200Test3200
|
||||
- 數據目錄: /Users/accusys/momentry/var (共用 - 不要刪除!)
|
||||
- 日誌目錄: /Users/accusys/momentry/log (共用 - 不要刪除!)
|
||||
@@ -1,489 +0,0 @@
|
||||
# n8n 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 n8n 工作流自動化平台,配置為本地部署,使用 Queue 模式。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| n8n | ✅ 已安裝 v2.12.3 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/n8n/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Main Plist | /Library/LaunchDaemons/com.momentry.n8n.main.plist |
|
||||
| Worker Plist | /Library/LaunchDaemons/com.momentry.n8n.worker.plist |
|
||||
| 數據庫 | PostgreSQL (n8n) |
|
||||
| 隊列 | Redis |
|
||||
| Launchd 狀態 | ✅ Main + Worker 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
### 重要更新 (2026-03-24)
|
||||
|
||||
1. **n8n Main + Worker**: 兩個服務都使用自定義 plist
|
||||
2. **Runner 禁用**: 為避免端口衝突,Main 服務設定 `N8N_RUNNERS_ENABLED=false`
|
||||
3. **Worker 端口**: Worker 使用 5681, 5682, 5690, 5691 端口
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 n8n (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 n8n
|
||||
brew install n8n
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
n8n --version
|
||||
# 2.12.3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/n8n
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/n8n.main.log
|
||||
touch /Users/accusys/momentry/log/n8n.main.error.log
|
||||
touch /Users/accusys/momentry/log/n8n.worker.log
|
||||
touch /Users/accusys/momentry/log/n8n.worker.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 數據遷移 (如果從舊位置遷移)
|
||||
|
||||
```bash
|
||||
# 停止舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.worker.plist
|
||||
|
||||
# 複製數據
|
||||
cp -r /Users/accusys/.n8n/* /Users/accusys/momentry/var/n8n/
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.n8n.main.plist /Library/LaunchDaemons/
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.n8n.worker.plist /Library/LaunchDaemons/
|
||||
|
||||
# 移除舊 plist (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.main.plist 2>/dev/null
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.n8n.worker.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.n8n.main.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.n8n.worker.plist 2>/dev/null
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "n8n"
|
||||
type: "http"
|
||||
port: 5678
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:5678/"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_n8n() {
|
||||
local start=$(date +%s%N)
|
||||
if curl -s http://localhost:5678/ > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} n8n (5678) - ${ms}ms"
|
||||
record_service "n8n" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} n8n (5678) - Down"
|
||||
record_service "n8n" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
### n8n Workflow 監控
|
||||
|
||||
n8n 有專門的工作流監控腳本,請參考 `monitor/workflow/n8n_workflow_monitor.sh`。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/n8n/` | 數據 | **不要刪除** - n8n 數據 |
|
||||
| `/Users/accusys/momentry/etc/n8n/` | 配置 | **不要刪除** - n8n 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - n8n 日誌 |
|
||||
| `/opt/homebrew/lib/node_modules/n8n/` | 安裝 | **刪除** - n8n 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 n8n
|
||||
|
||||
```bash
|
||||
# 停止 n8n 服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep n8n | grep -v grep || echo "n8n 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 n8n
|
||||
|
||||
```bash
|
||||
# 卸載 n8n
|
||||
brew uninstall n8n
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/n8n-*.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
# PostgreSQL n8n 數據庫 (如需保留)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== n8n 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 n8n 進程
|
||||
echo "1. n8n Main 進程:"
|
||||
ps aux | grep "n8n.*start" | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
echo "2. n8n Worker 進程:"
|
||||
ps aux | grep "n8n.*worker" | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 8085
|
||||
echo "3. Port 8085:"
|
||||
lsof -i :8085 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. Port 5679 (Worker)
|
||||
echo "4. Port 5679 (Worker):"
|
||||
lsof -i :5679 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 4. n8n 命令
|
||||
echo "5. n8n 命令:"
|
||||
which n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. brew 安裝
|
||||
echo "6. brew 安裝:"
|
||||
brew list n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. launchctl 服務
|
||||
echo "7. launchctl 服務:"
|
||||
sudo launchctl list | grep n8n > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份步驟
|
||||
|
||||
### 備份 n8n 數據
|
||||
|
||||
```bash
|
||||
# 建立備份目錄
|
||||
mkdir -p /Users/accusys/momentry/var/n8n_backup
|
||||
|
||||
# 1. 備份 PostgreSQL 數據庫
|
||||
PGPASSWORD=accusys pg_dump -U accusys -d n8n > /Users/accusys/momentry/var/n8n_backup/n8n_database_$(date +%Y%m%d).sql
|
||||
|
||||
# 2. 備份用戶數據夾
|
||||
cp -r /Users/accusys/momentry/var/n8n /Users/accusys/momentry/var/n8n_backup/
|
||||
|
||||
# 3. 壓縮備份
|
||||
cd /Users/accusys/momentry/var && tar -czvf n8n_backup_$(date +%Y%m%d).tar.gz n8n_backup/
|
||||
|
||||
# 4. 清理臨時備份
|
||||
rm -rf /Users/accusys/momentry/var/n8n_backup
|
||||
```
|
||||
|
||||
### 還原數據
|
||||
|
||||
```bash
|
||||
# 1. 停止 n8n
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 2. 還原 PostgreSQL 數據庫
|
||||
PGPASSWORD=accusys psql -U accusys -d n8n < /Users/accusys/momentry/var/n8n_backup/n8n_database_20260314.sql
|
||||
|
||||
# 3. 還原用戶數據夾
|
||||
rm -rf /Users/accusys/momentry/var/n8n
|
||||
cp -r /Users/accusys/momentry/var/n8n_backup/n8n /Users/accusys/momentry/var/n8n
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/n8n
|
||||
|
||||
# 4. 啟動 n8n
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep n8n | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :5678
|
||||
lsof -i :5679
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:5678/
|
||||
|
||||
# 4. 查看版本
|
||||
n8n --version
|
||||
|
||||
# 5. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/n8n-main.log
|
||||
tail -20 /Users/accusys/momentry/log/n8n-worker.log
|
||||
|
||||
# 6. 查看錯誤日誌
|
||||
tail -20 /Users/accusys/momentry/log/n8n-main.error.log
|
||||
tail -20 /Users/accusys/momentry/log/n8n-worker.error.log
|
||||
|
||||
# 7. 檢查 launchctl 狀態
|
||||
sudo launchctl list | grep n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| URL | http://localhost:5678 |
|
||||
| Domain | n8n.momentry.ddns.net |
|
||||
| 數據庫 | PostgreSQL (n8n) |
|
||||
| 隊列 | Redis |
|
||||
| Encryption Key | Test3200Test3200Test3200 |
|
||||
|
||||
### Queue 模式端口
|
||||
|
||||
| 服務 | Port |
|
||||
|------|------|
|
||||
| Main | 5678 |
|
||||
| Task Broker (Worker 連接) | 5679 |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
N8N_URL=http://localhost:5678
|
||||
N8N_USER_FOLDER=/Users/accusys/momentry/var/n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### n8n 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/n8n-main.log
|
||||
tail -f /Users/accusys/momentry/log/n8n-worker.log
|
||||
|
||||
# 檢查環境變數
|
||||
launchctl list | grep n8n
|
||||
|
||||
# 檢查數據庫連線
|
||||
PGPASSWORD=accusys psql -U accusys -d n8n -c "SELECT 1"
|
||||
|
||||
# 檢查 Redis 連線
|
||||
redis-cli -a accusys ping
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port
|
||||
lsof -i :8085
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 數據庫連線失敗
|
||||
|
||||
```bash
|
||||
# 檢查 PostgreSQL
|
||||
pg_isready -h 127.0.0.1 -p 5432 -U n8n
|
||||
|
||||
# 測試連線
|
||||
PGPASSWORD=accusys psql -h 127.0.0.1 -U n8n -d n8n -c "SELECT version();"
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.worker.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/lib/node_modules/n8n/` | n8n 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/bin/n8n` | n8n 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/n8n/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/n8n/` | 配置儲存 |
|
||||
| Main 日誌 | `/Users/accusys/momentry/log/n8n.main.log` | 主服務日誌 |
|
||||
| Main 錯誤日誌 | `/Users/accusys/momentry/log/n8n.main.error.log` | 主服務錯誤日誌 |
|
||||
| Worker 日誌 | `/Users/accusys/momentry/log/n8n.worker.log` | Worker 日誌 |
|
||||
| Worker 錯誤日誌 | `/Users/accusys/momentry/log/n8n.worker.error.log` | Worker 錯誤日誌 |
|
||||
| Main Plist | `/Library/LaunchDaemons/com.momentry.n8n.main.plist` | 主服務開機啟動 |
|
||||
| Worker Plist | `/Library/LaunchDaemons/com.momentry.n8n.worker.plist` | Worker 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/n8n_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 數據庫資訊
|
||||
|
||||
n8n 使用 PostgreSQL 作為數據庫:
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Database | n8n |
|
||||
| User | n8n |
|
||||
| Host | 127.0.0.1:5432 |
|
||||
| Password | accusys |
|
||||
|
||||
### Redis 隊列資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | 127.0.0.1:6379 |
|
||||
| Password | accusys |
|
||||
| Mode | Queue (Bull) |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 啟動 n8n Main
|
||||
n8n start
|
||||
|
||||
# 啟動 n8n Worker
|
||||
n8n worker
|
||||
|
||||
# 查看版本
|
||||
n8n --version
|
||||
|
||||
# 備份數據
|
||||
PGPASSWORD=accusys pg_dump -U accusys -d n8n > n8n_backup.sql
|
||||
|
||||
# 重新載入服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.n8n.main.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 2.3.5
|
||||
- Main Port: 5678
|
||||
- Task Broker (Worker): 5679
|
||||
- 數據目錄: /Users/accusys/momentry/var/n8n/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
- 數據庫: PostgreSQL n8n
|
||||
- 隊列: Redis
|
||||
@@ -1,375 +0,0 @@
|
||||
# Ollama 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Ollama,配置為本地部署,用於運行大型語言模型 (LLM)。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Ollama | ✅ 已安裝 v0.13.5 |
|
||||
| Port | 11434 |
|
||||
| Models 目錄 | /Users/accusys/momentry/var/ollama/models |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.ollama.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Ollama (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Ollama
|
||||
brew install ollama
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
ollama --version
|
||||
# ollama version is 0.13.5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/ollama
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/ollama
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/ollama.log
|
||||
touch /Users/accusys/momentry/log/ollama.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/ollama
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/ollama
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.ollama.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "ollama"
|
||||
type: "http"
|
||||
port: 11434
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:11434/api/tags"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_ollama() {
|
||||
local start=$(date +%s%N)
|
||||
if curl -s http://localhost:11434/api/tags > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} Ollama (11434) - ${ms}ms"
|
||||
record_service "ollama" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} Ollama (11434) - Down"
|
||||
record_service "ollama" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/ollama/` | 數據 | **不要刪除** - Ollama 數據 |
|
||||
| `/Users/accusys/momentry/etc/ollama/` | 配置 | **不要刪除** - Ollama 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/ollama/` | 安裝 | **刪除** - Ollama 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Ollama
|
||||
|
||||
```bash
|
||||
# 找到 Ollama 進程
|
||||
ps aux | grep ollama | grep -v grep
|
||||
|
||||
# 停止 Ollama
|
||||
pkill ollama
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep ollama | grep -v grep || echo "Ollama 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Ollama
|
||||
|
||||
```bash
|
||||
# 卸載 Ollama
|
||||
brew uninstall ollama
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/ollama.log
|
||||
rm -f /Users/accusys/momentry/log/ollama.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下目錄**:
|
||||
```bash
|
||||
# 這些是重要的,不要刪除!
|
||||
# /Users/accusys/.ollama/models
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Ollama 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Ollama 進程
|
||||
echo "1. Ollama 進程:"
|
||||
ps aux | grep ollama | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 11434
|
||||
echo "2. Port 11434:"
|
||||
lsof -i :11434 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. ollama 命令
|
||||
echo "3. ollama 命令:"
|
||||
which ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep ollama > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 模型目錄 (應該保留)
|
||||
echo "6. 模型目錄:"
|
||||
[ -d "/Users/accusys/.ollama/models" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep ollama | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :11434
|
||||
|
||||
# 3. 測試連線
|
||||
curl http://localhost:11434/
|
||||
|
||||
# 4. 查看版本
|
||||
ollama --version
|
||||
|
||||
# 5. 查看已安裝的模型
|
||||
ollama list
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/ollama.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 11434 |
|
||||
| Models | /Users/accusys/.ollama/models |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
OLLAMA_HOST=0.0.0.0:11434
|
||||
OLLAMA_MODELS=/Users/accusys/.ollama/models
|
||||
OLLAMA_FLASH_ATTENTION=1
|
||||
OLLAMA_KV_CACHE_TYPE=q8_0
|
||||
```
|
||||
|
||||
### 環境變數說明
|
||||
|
||||
| 變數 | 說明 | 預設值 |
|
||||
|------|------|---------|
|
||||
| OLLAMA_HOST | 綁定主機和端口 | 127.0.0.1:11434 |
|
||||
| OLLAMA_MODELS | 模型儲存目錄 | ~/.ollama/models |
|
||||
| OLLAMA_FLASH_ATTENTION | 啟用 Flash Attention | 0 |
|
||||
| OLLAMA_KV_CACHE_TYPE | KV 緩存類型 | f16 |
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Ollama 綁定到 `0.0.0.0:11434` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請注意安全風險
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Ollama 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/ollama.log
|
||||
|
||||
# 檢查模型目錄權限
|
||||
ls -la /Users/accusys/.ollama/models/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/.ollama
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 11434
|
||||
lsof -i :11434
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.ollama.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.ollama.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/ollama/` | Ollama 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/ollama/bin/ollama` | Ollama 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/ollama/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/ollama/` | 配置儲存 |
|
||||
| 模型目錄 | `/Users/accusys/.ollama/models/` | AI 模型儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/ollama.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/ollama.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.ollama.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/ollama_backup/environment.txt` | 環境變數備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 查看版本
|
||||
ollama --version
|
||||
|
||||
# 查看已安裝的模型
|
||||
ollama list
|
||||
|
||||
# 拉取模型
|
||||
ollama pull mistral
|
||||
ollama pull llama2
|
||||
|
||||
# 運行模型
|
||||
ollama run mistral
|
||||
|
||||
# 刪除模型
|
||||
ollama remove mistral
|
||||
|
||||
# 查看模型資訊
|
||||
ollama show mistral
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 已安裝的模型
|
||||
|
||||
查看已安裝的模型:
|
||||
```bash
|
||||
ollama list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 0.13.5
|
||||
- Port: 11434
|
||||
- Models: /Users/accusys/.ollama/models/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,395 +0,0 @@
|
||||
# PHP 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 PHP 及 PHP-FPM,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| PHP | ✅ 已安裝 v8.5.2 |
|
||||
| PHP-FPM | ✅ 執行中 |
|
||||
| 配置目錄 | /Users/accusys/momentry/etc/php/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.php.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 PHP (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 PHP
|
||||
brew install php
|
||||
|
||||
# 安裝 PHP-FPM (通常包含在 php 中)
|
||||
brew install php --fpm
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
php --version
|
||||
# PHP 8.5.2 (cli)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/php
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/php.log
|
||||
touch /Users/accusys/momentry/log/php.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/php
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立設定檔
|
||||
|
||||
建立 `/Users/accusys/momentry/etc/php/php-fpm.conf`:
|
||||
|
||||
```ini
|
||||
[global]
|
||||
pid = /Users/accusys/momentry/var/php-fpm.pid
|
||||
error_log = /Users/accusys/momentry/log/php.error.log
|
||||
log_level = notice
|
||||
|
||||
[www]
|
||||
user = accusys
|
||||
group = staff
|
||||
listen = 127.0.0.1:9000
|
||||
listen.owner = accusys
|
||||
listen.group = staff
|
||||
pm = dynamic
|
||||
pm.max_children = 5
|
||||
pm.start_servers = 2
|
||||
pm.min_spare_servers = 1
|
||||
pm.max_spare_servers = 3
|
||||
```
|
||||
|
||||
複製 php.ini:
|
||||
```bash
|
||||
cp /opt/homebrew/etc/php/8.5/php.ini /Users/accusys/momentry/etc/php/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.php.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "php-fpm"
|
||||
type: "tcp"
|
||||
port: 9000
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/etc/php/` | 配置 | **不要刪除** - PHP 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/php/` | 安裝 | **刪除** - PHP 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 PHP-FPM
|
||||
|
||||
```bash
|
||||
# 找到 PHP-FPM 進程
|
||||
ps aux | grep php-fpm | grep -v grep
|
||||
|
||||
# 停止 PHP-FPM
|
||||
pkill php-fpm
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep php-fpm | grep -v grep || echo "PHP-FPM 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 PHP
|
||||
|
||||
```bash
|
||||
# 卸載 PHP
|
||||
brew uninstall php
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.php.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/php
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/php.log
|
||||
rm -f /Users/accusys/momentry/log/php.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== PHP 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 PHP-FPM 進程
|
||||
echo "1. PHP-FPM 進程:"
|
||||
ps aux | grep php-fpm | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 9000
|
||||
echo "2. Port 9000:"
|
||||
lsof -i :9000 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. php 命令
|
||||
echo "3. php 命令:"
|
||||
which php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep php > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 配置目錄 (可選刪除)
|
||||
echo "6. 配置目錄:"
|
||||
[ -d "/Users/accusys/momentry/etc/php" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查 PHP 版本
|
||||
php --version
|
||||
|
||||
# 2. 檢查 PHP-FPM 進程
|
||||
ps aux | grep php-fpm | grep -v grep
|
||||
|
||||
# 3. 檢查 Port
|
||||
lsof -i :9000
|
||||
|
||||
# 4. 測試 PHP
|
||||
php -r "echo 'PHP OK' . PHP_EOL;"
|
||||
|
||||
# 5. 查看 PHP 模組
|
||||
php -m
|
||||
|
||||
# 6. 查看 PHP 配置
|
||||
php -i | grep "Loaded Configuration File"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/php.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| PHP-FPM Port | 9000 |
|
||||
| PHP Version | 8.5.2 |
|
||||
| Config | /Users/accusys/momentry/etc/php/php-fpm.conf |
|
||||
| php.ini | /Users/accusys/momentry/etc/php/php.ini |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
PHP_INI_SCAN_DIR=/Users/accusys/momentry/etc/php/conf.d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### PHP-FPM 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/php.error.log
|
||||
|
||||
# 檢查配置語法
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/php-fpm.conf
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/etc/php/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/etc/php
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 9000
|
||||
lsof -i :9000
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.php.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.php.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/php/` | PHP 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/bin/php` | PHP 執行檔 |
|
||||
| PHP-FPM | `/opt/homebrew/opt/php/sbin/php-fpm` | PHP-FPM 執行檔 |
|
||||
| php.ini | `/Users/accusys/momentry/etc/php/8.5/php.ini` | PHP 配置 |
|
||||
| PHP-FPM 配置 | `/Users/accusys/momentry/etc/php/8.5/php-fpm.conf` | PHP-FPM 主配置 |
|
||||
| PHP-FPM pool | `/Users/accusys/momentry/etc/php/8.5/php-fpm.d/` | Pool 配置 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/php.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/opt/homebrew/var/log/php-fpm.log` | PHP-FPM 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.php.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/backup/daily/php/` | 配置備份 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 測試 PHP-FPM 配置
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/php-fpm.conf
|
||||
|
||||
# 查看 PHP 模組
|
||||
php -m
|
||||
|
||||
# 查看已載入的配置
|
||||
php -i
|
||||
|
||||
# 測試 PHP 腳本
|
||||
php -r "echo 'Hello World' . PHP_EOL;"
|
||||
|
||||
# 查看 PHP-FPM 狀態
|
||||
curl http://127.0.0.1:9000/status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/daily/php"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 備份配置 (注意:PHP-FPM 實際使用 /Users/accusys/momentry/etc/php/8.5/ 配置)
|
||||
tar -czf "$BACKUP_DIR/php_cfg_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/etc/php/8.5/php.ini \
|
||||
/Users/accusys/momentry/etc/php/8.5/php-fpm.conf \
|
||||
/Users/accusys/momentry/etc/php/8.5/php-fpm.d/
|
||||
|
||||
# 驗證
|
||||
sha256sum "$BACKUP_DIR/php_cfg_${TIMESTAMP}.tar.gz" > "$BACKUP_DIR/php_${TIMESTAMP}.sha256"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 解壓配置
|
||||
tar -xzf /Users/accusys/momentry/backup/daily/php/php_cfg_20260316_102727.tar.gz -C /
|
||||
|
||||
# 測試配置
|
||||
/opt/homebrew/opt/php/sbin/php-fpm --test --fpm-config /Users/accusys/momentry/etc/php/8.5/php-fpm.conf
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- PHP Version: 8.5.2
|
||||
- PHP-FPM Port: 9000
|
||||
- 配置目錄: /Users/accusys/momentry/etc/php/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,397 +0,0 @@
|
||||
# PostgreSQL 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 PostgreSQL,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| PostgreSQL | ✅ 已安裝 v18.1 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/postgresql |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.postgresql.plist |
|
||||
| Launchd 狀態 | ✅ 已註冊 |
|
||||
| RunAtLoad | ✅ 已設定 |
|
||||
| KeepAlive | ✅ 已設定 |
|
||||
|
||||
### 重要更新 (2026-03-24)
|
||||
|
||||
1. **資料目錄已變更**: 從 `/opt/homebrew/var/postgresql@18` 遷移到 `/Users/accusys/momentry/var/postgresql`
|
||||
2. **統一管理**: 所有 Momentry 服務現在都使用 `/Library/LaunchDaemons/` 下的自定義 plist
|
||||
3. **避免衝突**: 刪除了 homebrew plist,避免 reboot 後使用舊資料目錄
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 PostgreSQL (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 PostgreSQL
|
||||
brew install postgresql@18
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
postgres --version
|
||||
# postgres (PostgreSQL) 18.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/postgresql
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/postgresql.log
|
||||
touch /Users/accusys/momentry/log/postgresql.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/postgresql
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/postgresql
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
**注意**: 如果需要從舊數據遷移,需要先初始化新目錄:
|
||||
```bash
|
||||
# 初始化新數據目錄 (會創建默認數據庫)
|
||||
initdb -D /Users/accusys/momentry/var/postgresql -U accusys
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.postgresql.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
postgresql:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 5432
|
||||
user: "accusys"
|
||||
database: "momentry"
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/database/postgres_monitor.sh` 中已包含 PostgreSQL 監控。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/postgresql/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/postgresql/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/postgresql@18/` | 安裝 | **刪除** - PostgreSQL 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 找到 PostgreSQL 進程
|
||||
ps aux | grep postgres | grep -v grep
|
||||
|
||||
# 停止 PostgreSQL
|
||||
pg_ctl -D /opt/homebrew/var/postgresql@18 stop
|
||||
# 或
|
||||
pkill -f postgresql
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep postgres | grep -v grep || echo "PostgreSQL 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 卸載 PostgreSQL
|
||||
brew uninstall postgresql@18
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/postgresql.log
|
||||
rm -f /Users/accusys/momentry/log/postgresql.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== PostgreSQL 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 PostgreSQL 進程
|
||||
echo "1. PostgreSQL 進程:"
|
||||
ps aux | grep postgres | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 5432
|
||||
echo "2. Port 5432:"
|
||||
lsof -i :5432 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. postgres 命令
|
||||
echo "3. postgres 命令:"
|
||||
which postgres > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list postgresql@18 > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep postgresql > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/postgresql" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== PostgreSQL 卸載後檢查 ===
|
||||
1. PostgreSQL 進程:
|
||||
✓ 已停止
|
||||
2. Port 5432:
|
||||
✓ 已釋放
|
||||
3. postgres 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep postgres | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :5432
|
||||
|
||||
# 3. 測試連線
|
||||
psql -U accusys -l
|
||||
|
||||
# 4. 查看所有數據庫
|
||||
psql -U accusys -c "\l"
|
||||
|
||||
# 5. 查看連接
|
||||
psql -U accusys -c "\conninfo"
|
||||
|
||||
# 6. 查看表
|
||||
psql -U accusys -d momentry -c "\dt"
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/postgresql.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 5432 |
|
||||
| User | accusys |
|
||||
| Database | momentry, video_register, gitea, n8n |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
POSTGRES_URL=postgresql://accusys@localhost:5432
|
||||
POSTGRES_DB=momentry
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- PostgreSQL 綁定到所有網路介面 (0.0.0.0)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 請設定 `pg_hba.conf` 限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### PostgreSQL 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/postgresql.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/postgresql/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/postgresql
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 5432
|
||||
lsof -i :5432
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.postgresql.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/postgresql@18/` | PostgreSQL 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/postgresql@18/bin/postgres` | PostgreSQL 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/postgresql/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/postgresql.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/postgresql.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.postgresql.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/momentry_db_backup_latest.sql` | momentry 數據庫備份 |
|
||||
| 備份 | `/Users/accusys/momentry/var/video_register_db_backup_latest.sql` | video_register 數據庫備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份 (pg_dump)
|
||||
|
||||
```bash
|
||||
# 備份 momentry 數據庫
|
||||
pg_dump -U accusys momentry > /Users/accusys/momentry/var/momentry_db_backup_latest.sql
|
||||
|
||||
# 備份 video_register 數據庫
|
||||
pg_dump -U accusys video_register > /Users/accusys/momentry/var/video_register_db_backup_latest.sql
|
||||
```
|
||||
|
||||
### 恢復 (psql)
|
||||
|
||||
```bash
|
||||
# 恢復 momentry 數據庫
|
||||
psql -U accusys -d momentry < /Users/accusys/momentry/var/momentry_db_backup_latest.sql
|
||||
|
||||
# 恢復 video_register 數據庫
|
||||
psql -U accusys -d video_register < /Users/accusys/momentry/var/video_register_db_backup_latest.sql
|
||||
```
|
||||
|
||||
### 數據目錄複製 (完整遷移)
|
||||
|
||||
```bash
|
||||
# 1. 停止 PostgreSQL
|
||||
pg_ctl -D /Users/accusys/momentry/var/postgresql stop
|
||||
|
||||
# 2. 複製數據目錄
|
||||
cp -r /opt/homebrew/var/postgresql@18/* /Users/accusys/momentry/var/postgresql/
|
||||
|
||||
# 3. 設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/postgresql
|
||||
|
||||
# 4. 啟動 PostgreSQL
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.postgresql.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 18.1
|
||||
- Port: 5432
|
||||
- User: accusys
|
||||
- 數據目錄: /Users/accusys/momentry/var/postgresql/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,472 +0,0 @@
|
||||
# Qdrant 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Qdrant Vector Database,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Qdrant | ✅ 已安裝 v1.17.0 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/qdrant/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.qdrant.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Qdrant (使用 cargo)
|
||||
|
||||
```bash
|
||||
# 安裝 Qdrant 從 GitHub
|
||||
cargo install --git https://github.com/qdrant/qdrant.git --locked
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
qdrant --version
|
||||
# qdrant 1.17.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 驗證 Qdrant 安裝
|
||||
|
||||
```bash
|
||||
# 驗證 Qdrant 安裝
|
||||
~/.cargo/bin/qdrant --version
|
||||
# qdrant 1.17.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/qdrant
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/qdrant.log
|
||||
touch /Users/accusys/momentry/log/qdrant.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/qdrant
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/qdrant
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.qdrant.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
qdrant:
|
||||
enabled: true
|
||||
host: "localhost"
|
||||
port: 6333
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/database/qdrant_monitor.sh` 中已包含 Qdrant 監控。
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/qdrant/` | 數據 | **不要刪除** - Qdrant 數據 |
|
||||
| `/Users/accusys/momentry/etc/qdrant/` | 配置 | **不要刪除** - Qdrant 配置 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `~/.cargo/bin/qdrant` | 安裝 | **刪除** - Qdrant 執行檔 |
|
||||
|
||||
### Step 1: 停止 Qdrant
|
||||
|
||||
```bash
|
||||
# 找到 Qdrant 進程
|
||||
ps aux | grep qdrant | grep -v grep
|
||||
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
# 或
|
||||
kill <PID>
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep qdrant | grep -v grep || echo "Qdrant 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Qdrant (cargo)
|
||||
|
||||
```bash
|
||||
# 移除 cargo 安裝的 Qdrant
|
||||
cargo uninstall qdrant
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/qdrant
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/qdrant.log
|
||||
rm -f /opt/homebrew/var/log/qdrant.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Qdrant 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Qdrant 進程
|
||||
echo "1. Qdrant 進程:"
|
||||
ps aux | grep qdrant | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 6333
|
||||
echo "2. Port 6333:"
|
||||
lsof -i :6333 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. Port 6334
|
||||
echo "3. Port 6334:"
|
||||
lsof -i :6334 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 4. qdrant 命令
|
||||
echo "4. qdrant 命令:"
|
||||
which qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. cargo 安裝
|
||||
echo "5. cargo 安裝:"
|
||||
cargo install --list | grep qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. launchctl 服務
|
||||
echo "6. launchctl 服務:"
|
||||
sudo launchctl list | grep qdrant > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 7. 數據目錄 (可選刪除)
|
||||
echo "7. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/qdrant" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 8. 日誌目錄 (可選刪除)
|
||||
echo "8. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Qdrant 卸載後檢查 ===
|
||||
1. Qdrant 進程:
|
||||
✓ 已停止
|
||||
2. Port 6333:
|
||||
✓ 已釋放
|
||||
3. Port 6334:
|
||||
✓ 已釋放
|
||||
4. qdrant 命令:
|
||||
✓ 已移除
|
||||
5. cargo 安裝:
|
||||
✓ 已移除
|
||||
6. launchctl 服務:
|
||||
✓ 已移除
|
||||
7. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
8. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep qdrant | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :6333
|
||||
lsof -i :6334
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
curl http://localhost:6333/collections
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
curl -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
|
||||
# 5. 查看所有 collections
|
||||
curl -s -H "api-key: Test3200Test3200Test3200" http://localhost:6333/collections
|
||||
|
||||
# 6. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/qdrant.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| REST API | http://localhost:6333 |
|
||||
| gRPC | localhost:6334 |
|
||||
| API Key | Test3200Test3200Test3200 |
|
||||
| Qdrant UI | http://localhost:6333/dashboard |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
QDRANT_URL=http://localhost:6333
|
||||
QDRANT_API_KEY=Test3200Test3200Test3200
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Qdrant 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 建議設定防火牆規則限制訪問 IP
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Qdrant 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/qdrant.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/qdrant/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/qdrant
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 6333
|
||||
lsof -i :6333
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.qdrant.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/.cargo/bin/qdrant` | 二進制 | cargo 安裝位置 (直接使用) |
|
||||
| `/opt/homebrew/bin/qdrant` | 符號連結 | ~~已棄用~~ - 不再需要 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/qdrant/` | 數據儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/qdrant.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/opt/homebrew/var/log/qdrant.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.qdrant.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/qdrant_backup/` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
Qdrant 提供兩種備份方式:Snapshots (推薦) 和手動複製。
|
||||
|
||||
#### 方式一:使用 Snapshots API (推薦)
|
||||
|
||||
```bash
|
||||
# 創建備份目錄
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant_backup
|
||||
|
||||
# 獲取所有 collections
|
||||
curl -s -H "api-key: Test3200Test3200Test3200" \
|
||||
http://localhost:6333/collections | jq -r '.result[].name'
|
||||
|
||||
# 為每個 collection 創建 snapshot
|
||||
# 假設 collection 名稱為 "chunks"
|
||||
curl -X POST -H "api-key: Test3200Test3200Test3200" \
|
||||
http://localhost:6333/collections/chunks/snapshots \
|
||||
-o /Users/accusys/momentry/var/qdrant_backup/chunks_snapshot_$(date +%Y%m%d).tar.gz
|
||||
```
|
||||
|
||||
#### 方式二:手動複製數據目錄 (停機備份)
|
||||
|
||||
```bash
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
|
||||
# 等待停止
|
||||
sleep 2
|
||||
|
||||
# 複製數據目錄
|
||||
TIMESTAMP=$(date +%Y%m%d)
|
||||
mkdir -p /Users/accusys/momentry/var/qdrant_backup
|
||||
tar -czf /Users/accusys/momentry/var/qdrant_backup/qdrant_data_${TIMESTAMP}.tar.gz \
|
||||
-C /Users/accusys/momentry/var qdrant/
|
||||
|
||||
# 啟動 Qdrant
|
||||
launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
#### 自動備份腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# backup_qdrant.sh
|
||||
set -e
|
||||
|
||||
QDRANT_HOST="localhost"
|
||||
QDRANT_PORT="6333"
|
||||
QDRANT_API_KEY="Test3200Test3200Test3200"
|
||||
BACKUP_DIR="/Users/accusys/momentry/var/qdrant_backup"
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
echo "開始 Qdrant 備份..."
|
||||
|
||||
# 獲取所有 collections
|
||||
COLLECTIONS=$(curl -s -H "api-key: $QDRANT_API_KEY" \
|
||||
http://${QDRANT_HOST}:${QDRANT_PORT}/collections | \
|
||||
jq -r '.result[].name')
|
||||
|
||||
if [ -z "$COLLECTIONS" ]; then
|
||||
echo "警告: 沒有找到任何 collections"
|
||||
else
|
||||
for COLLECTION in $COLLECTIONS; do
|
||||
echo "備份 collection: $COLLECTION"
|
||||
curl -X POST -H "api-key: $QDRANT_API_KEY" \
|
||||
"http://${QDRANT_HOST}:${QDRANT_PORT}/collections/${COLLECTION}/snapshots" \
|
||||
-o "${BACKUP_DIR}/${COLLECTION}_${TIMESTAMP}.tar.gz" 2>/dev/null || \
|
||||
echo "警告: $COLLECTION 備份失敗"
|
||||
done
|
||||
fi
|
||||
|
||||
# 壓縮所有 snapshot
|
||||
cd "$BACKUP_DIR"
|
||||
tar -czf qdrant_snapshots_${TIMESTAMP}.tar.gz *.tar.gz 2>/dev/null || true
|
||||
rm -f *.tar.gz
|
||||
|
||||
# 清理 30 天前的備份
|
||||
find "$BACKUP_DIR" -name "qdrant_snapshots_*.tar.gz" -mtime +30 -delete
|
||||
|
||||
echo "Qdrant 備份完成: ${BACKUP_DIR}/qdrant_snapshots_${TIMESTAMP}.tar.gz"
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 停止 Qdrant
|
||||
pkill qdrant
|
||||
sleep 2
|
||||
|
||||
# 解壓縮備份
|
||||
TIMESTAMP="20260315"
|
||||
tar -xzf /Users/accusys/momentry/var/qdrant_backup/qdrant_snapshots_${TIMESTAMP}.tar.gz \
|
||||
-C /Users/accusys/momentry/var/qdrant_backup/
|
||||
|
||||
# 恢復數據目錄 (方式二備份)
|
||||
# rm -rf /Users/accusys/momentry/var/qdrant/*
|
||||
# tar -xzf /Users/accusys/momentry/var/qdrant_backup/qdrant_data_${TIMESTAMP}.tar.gz \
|
||||
# -C /Users/accusys/momentry/var/
|
||||
|
||||
# 啟動 Qdrant
|
||||
launchctl load /Library/LaunchDaemons/com.momentry.qdrant.plist
|
||||
```
|
||||
|
||||
### 排程備份
|
||||
|
||||
```bash
|
||||
# 編輯 crontab
|
||||
crontab -e
|
||||
|
||||
# 添加每天凌晨 3 點執行備份
|
||||
0 3 * * * /Users/accusys/momentry/scripts/backup_qdrant.sh >> /Users/accusys/momentry/log/backup.log 2>&1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.17.0
|
||||
- API Key: Test3200Test3200Test3200
|
||||
- 數據目錄: /Users/accusys/momentry/var/qdrant/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
@@ -1,481 +0,0 @@
|
||||
# Redis 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-21 | 更新 rust redis crate 版本至 0.32.7 | OpenCode | - |
|
||||
| V1.2 | 2026-03-21 | 添加 Redis 用戶配置說明 | OpenCode | - |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 Redis,配置為本地部署,支援遠端訪問。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| Redis | ✅ 已安裝 v8.4.0 |
|
||||
| 數據目錄 | /opt/homebrew/var/db/redis/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| Plist | /Library/LaunchDaemons/com.momentry.redis.plist |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 Redis (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 Redis
|
||||
brew install redis
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
redis-server --version
|
||||
# Redis server v8.4.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄結構
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/redis
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/redis.log
|
||||
touch /Users/accusys/momentry/log/redis.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/redis
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/redis
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.redis.plist /Library/LaunchDaemons/
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/redis/` | 數據 | **不要刪除** - 數據目錄 |
|
||||
| `/Users/accusys/momentry/etc/redis/` | 配置 | **不要刪除** - 配置目錄 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/opt/redis/` | 安裝 | **刪除** - Redis 安裝目錄 |
|
||||
|
||||
### Step 1: 停止 Redis
|
||||
|
||||
```bash
|
||||
# 找到 Redis 進程
|
||||
ps aux | grep redis | grep -v grep
|
||||
|
||||
# 停止 Redis
|
||||
redis-cli -a accusys SHUTDOWN
|
||||
# 或
|
||||
pkill redis-server
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep redis | grep -v grep || echo "Redis 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 Redis
|
||||
|
||||
```bash
|
||||
# 卸載 Redis
|
||||
brew uninstall redis
|
||||
|
||||
# 移除 plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/redis
|
||||
|
||||
# 刪除配置目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/etc/redis
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/redis.log
|
||||
rm -f /Users/accusys/momentry/log/redis.error.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/etc
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 卸載後檢查清單
|
||||
|
||||
```bash
|
||||
echo "=== Redis 卸載後檢查 ==="
|
||||
|
||||
# 1. 檢查 Redis 進程
|
||||
echo "1. Redis 進程:"
|
||||
ps aux | grep redis | grep -v grep && echo " ✗ 仍在運行" || echo " ✓ 已停止"
|
||||
|
||||
# 2. Port 6379
|
||||
echo "2. Port 6379:"
|
||||
lsof -i :6379 > /dev/null 2>&1 && echo " ✗ 仍被佔用" || echo " ✓ 已釋放"
|
||||
|
||||
# 3. redis-server 命令
|
||||
echo "3. redis-server 命令:"
|
||||
which redis-server > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 4. brew 安裝
|
||||
echo "4. brew 安裝:"
|
||||
brew list redis > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 5. launchctl 服務
|
||||
echo "5. launchctl 服務:"
|
||||
sudo launchctl list | grep redis > /dev/null 2>&1 && echo " ✗ 仍存在" || echo " ✓ 已移除"
|
||||
|
||||
# 6. 數據目錄 (可選刪除)
|
||||
echo "6. 數據目錄:"
|
||||
[ -d "/Users/accusys/momentry/var/redis" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
|
||||
# 7. 日誌目錄 (可選刪除)
|
||||
echo "7. 日誌目錄:"
|
||||
[ -d "/Users/accusys/momentry/log" ] && echo " ✓ 保留" || echo " ✗ 已刪除"
|
||||
```
|
||||
|
||||
**預期結果**:
|
||||
```
|
||||
=== Redis 卸載後檢查 ===
|
||||
1. Redis 進程:
|
||||
✓ 已停止
|
||||
2. Port 6379:
|
||||
✓ 已釋放
|
||||
3. redis-server 命令:
|
||||
✓ 已移除
|
||||
4. brew 安裝:
|
||||
✓ 已移除
|
||||
5. launchctl 服務:
|
||||
✓ 已移除
|
||||
6. 數據目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
7. 日誌目錄:
|
||||
✓ 保留 (或 ✗ 已刪除)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "redis"
|
||||
type: "tcp"
|
||||
port: 6379
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 添加健康檢查函數
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加:
|
||||
|
||||
```bash
|
||||
check_redis() {
|
||||
local start=$(date +%s%N)
|
||||
if redis-cli -a accusys ping > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} Redis (6379) - ${ms}ms"
|
||||
record_service "redis" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} Redis (6379) - Down"
|
||||
record_service "redis" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep redis | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :6379
|
||||
|
||||
# 3. 測試連線 (無認證)
|
||||
redis-cli -a accusys PING
|
||||
|
||||
# 4. 測試連線 (有認證)
|
||||
redis-cli -a accusys -e "PING"
|
||||
|
||||
# 5. 查看所有 keys
|
||||
redis-cli -a accusys KEYS '*'
|
||||
|
||||
# 6. 查看 info
|
||||
redis-cli -a accusys INFO
|
||||
|
||||
# 7. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/redis.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Host | localhost |
|
||||
| Port | 6379 |
|
||||
| Password | accusys |
|
||||
|
||||
---
|
||||
|
||||
## 環境變數
|
||||
|
||||
在 `.env` 中:
|
||||
|
||||
```env
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 遠端訪問
|
||||
|
||||
- Redis 綁定到 `0.0.0.0` (所有網路介面)
|
||||
- 本地網路其他機器可透過 IP 訪問
|
||||
- 密碼認證: `accusys`
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### Redis 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/redis.log
|
||||
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/momentry/var/redis/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/redis
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port 6379
|
||||
lsof -i :6379
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務 (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist 2>/dev/null
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/opt/redis/` | Redis 安裝目錄 |
|
||||
| 執行檔 | `/opt/homebrew/opt/redis/bin/redis-server` | Redis 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/redis/` | 數據儲存 |
|
||||
| 配置目錄 | `/Users/accusys/momentry/etc/redis/` | 配置儲存 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/redis.log` | 執行日誌 |
|
||||
| 錯誤日誌 | `/Users/accusys/momentry/log/redis.error.log` | 錯誤日誌 |
|
||||
| plist | `/Library/LaunchDaemons/com.momentry.redis.plist` | 開機啟動 |
|
||||
| 備份 | `/Users/accusys/momentry/var/redis_backup_latest.rdb` | 數據備份 |
|
||||
|
||||
---
|
||||
|
||||
## 備份與恢復
|
||||
|
||||
### 備份
|
||||
|
||||
```bash
|
||||
# 觸發保存並備份
|
||||
redis-cli -a accusys SAVE
|
||||
cp /opt/homebrew/var/db/redis/dump.rdb /Users/accusys/momentry/var/redis_backup_latest.rdb
|
||||
```
|
||||
|
||||
### 恢復
|
||||
|
||||
```bash
|
||||
# 停止 Redis
|
||||
redis-cli -a accusys SHUTDOWN
|
||||
|
||||
# 複製備份文件覆蓋
|
||||
cp /Users/accusys/momentry/var/redis_backup_latest.rdb /Users/accusys/momentry/var/redis/dump.rdb
|
||||
|
||||
# 啟動 Redis
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Redis Server | 8.4.0 |
|
||||
| Rust redis crate | 0.32.7 |
|
||||
| Port | 6379 |
|
||||
| Password | accusys |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/redis/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
|
||||
---
|
||||
|
||||
## Rust redis crate 版本
|
||||
|
||||
Cargo.toml 中的 redis 依賴:
|
||||
|
||||
```toml
|
||||
redis = { version = "0.32", features = ["tokio-comp"] }
|
||||
```
|
||||
|
||||
### 版本歷史
|
||||
|
||||
| 版本 | 日期 | 變更 |
|
||||
|------|------|-------|
|
||||
| 0.25.4 | - | 原始版本(有未來相容性警告) |
|
||||
| 0.32.7 | 2026-03-21 | **升級** - 修復 Rust 2024 never type 回退問題 |
|
||||
|
||||
### 升級說明
|
||||
|
||||
升級到 0.32.x 的優點:
|
||||
- 修復 Rust 2024 edition 未來相容性問題
|
||||
- API 完全向後相容
|
||||
- 無需修改現有程式碼
|
||||
|
||||
---
|
||||
|
||||
## Redis 用戶配置說明
|
||||
|
||||
### 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| 用戶類型 | 僅有 `default` 用戶 |
|
||||
| 自訂用戶 | ❌ 未配置 |
|
||||
| ACL 持久化 | ❌ 未配置 |
|
||||
|
||||
### Redis ACL 狀態
|
||||
|
||||
```bash
|
||||
# 查看 ACL
|
||||
redis-cli -a accusys ACL LIST
|
||||
|
||||
# 輸出:
|
||||
# user default on sanitize-payload #hash ~* &* +@all
|
||||
```
|
||||
|
||||
### 連線格式說明
|
||||
|
||||
| 格式 | 狀態 | 說明 |
|
||||
|------|------|------|
|
||||
| `redis://:accusys@localhost:6379` | ✅ 正確 | 使用默認用戶 + 密碼 |
|
||||
| `redis://accusys:accusys@localhost:6379` | ❌ 失敗 | 用戶 `accusys` 不存在 |
|
||||
|
||||
### 為何用戶名不可用
|
||||
|
||||
1. **Redis 啟動方式**:使用 `--requirepass` 參數,僅設定默認用戶密碼
|
||||
2. **無 ACL 配置文件**:未指定 `--aclfile` 參數
|
||||
3. **動態建立用戶**:手動建立的用戶不會持久化(重啟後消失)
|
||||
|
||||
### 解決方案
|
||||
|
||||
#### 方案 A:使用默認用戶(現行)
|
||||
|
||||
```env
|
||||
REDIS_URL=redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
**適用於**:單一應用、簡單部署
|
||||
|
||||
#### 方案 B:建立 ACL 配置文件
|
||||
|
||||
```bash
|
||||
# 1. 建立 ACL 文件
|
||||
cat > /Users/accusys/momentry/etc/redis/users.acl << 'EOF'
|
||||
user default on sanitize-payload ~* &* +@all >accusys
|
||||
user accusys on sanitize-payload ~* &* +@all >accusys
|
||||
EOF
|
||||
|
||||
# 2. 修改 plist (添加 --aclfile 參數)
|
||||
# --aclfile /Users/accusys/momentry/etc/redis/users.acl
|
||||
|
||||
# 3. 重啟 Redis
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.redis.plist
|
||||
```
|
||||
|
||||
**適用於**:多應用、需要用戶隔離
|
||||
|
||||
### 參考
|
||||
|
||||
- 問題追蹤:`docs/PENDING_ISSUES.md` 問題 #5
|
||||
- 測試結果:2026-03-21 Redis 認證測試
|
||||
@@ -1,300 +0,0 @@
|
||||
# RustDesk 安裝指南 (本地部署)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-15 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-15 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上安裝 RustDesk 遠端桌面服務,配置為本地部署。
|
||||
|
||||
---
|
||||
|
||||
## 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| RustDesk | ✅ 已安裝 |
|
||||
| 數據目錄 | /Users/accusys/momentry/var/rustdesk/ |
|
||||
| 日誌目錄 | /Users/accusys/momentry/log/ |
|
||||
| HBBS Plist | /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist |
|
||||
| HBBR Plist | /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist |
|
||||
|
||||
---
|
||||
|
||||
## 服務端口
|
||||
|
||||
| 服務 | Port | 協議 |
|
||||
|------|------|------|
|
||||
| hbbs (TCP) | 21115 | 主端口 |
|
||||
| hbbs (TCP/UDP) | 21116 | NAT 測試 |
|
||||
| hbbs (WebSocket) | 21118 | WebSocket |
|
||||
| hbbr (TCP) | 21117 | 中繼端口 |
|
||||
| hbbr (TCP) | 21119 | 中繼 extra |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 RustDesk (使用 brew)
|
||||
|
||||
```bash
|
||||
# 安裝 RustDesk
|
||||
brew install rustdesk
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
```bash
|
||||
hbbs --version
|
||||
hbbr --version
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 建立目錄
|
||||
|
||||
```bash
|
||||
# 建立數據目錄
|
||||
mkdir -p /Users/accusys/momentry/var/rustdesk
|
||||
|
||||
# 建立配置目錄
|
||||
mkdir -p /Users/accusys/momentry/etc/rustdesk
|
||||
|
||||
# 建立日誌目錄
|
||||
mkdir -p /Users/accusys/momentry/log
|
||||
|
||||
# 建立日誌文件
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbs.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbs.error.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbr.log
|
||||
touch /Users/accusys/momentry/log/rustdesk.hbbr.error.log
|
||||
|
||||
# 設定權限
|
||||
chown -R accusys:staff /Users/accusys/momentry/var/rustdesk
|
||||
chown -R accusys:staff /Users/accusys/momentry/etc/rustdesk
|
||||
chown -R accusys:staff /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 使用 plist 開機自動啟動
|
||||
|
||||
```bash
|
||||
# 複製 plist 到 LaunchDaemons 目錄
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.rustdesk.hbbs.plist /Library/LaunchDaemons/
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.rustdesk.hbbr.plist /Library/LaunchDaemons/
|
||||
|
||||
# 移除舊 plist (如果存在)
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.rustdesk.hbbs.plist 2>/dev/null
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.rustdesk.hbbr.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.rustdesk.hbbs.plist 2>/dev/null
|
||||
sudo rm /Library/LaunchDaemons/com.rustdesk.hbbr.plist 2>/dev/null
|
||||
|
||||
# 載入並啟動
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 監控配置
|
||||
|
||||
### 添加到監控配置
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "rustdesk-hbbs"
|
||||
type: "tcp"
|
||||
port: 21115
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
- name: "rustdesk-hbbr"
|
||||
type: "tcp"
|
||||
port: 21117
|
||||
host: "localhost"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 卸載步驟
|
||||
|
||||
### 重要: 路徑說明
|
||||
|
||||
| 路徑 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `/Users/accusys/momentry/var/rustdesk/` | 數據 | **不要刪除** - RustDesk 數據 |
|
||||
| `/Users/accusys/momentry/log/` | 日誌 | **不要刪除** - 日誌目錄 |
|
||||
| `/opt/homebrew/bin/hbbr` | 安裝 | **刪除** - RustDesk 安裝 |
|
||||
| `/opt/homebrew/bin/hbbs` | 安裝 | **刪除** - RustDesk 安裝 |
|
||||
|
||||
### Step 1: 停止 RustDesk
|
||||
|
||||
```bash
|
||||
# 停止 RustDesk 服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
|
||||
# 確認停止
|
||||
ps aux | grep rustdesk | grep -v grep || echo "RustDesk 已停止"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 卸載 RustDesk
|
||||
|
||||
```bash
|
||||
# 卸載 RustDesk
|
||||
brew uninstall rustdesk
|
||||
|
||||
# 移除 plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 刪除專屬檔案
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄 (可選)
|
||||
rm -rf /Users/accusys/momentry/var/rustdesk
|
||||
|
||||
# 刪除日誌 (可選)
|
||||
rm -f /Users/accusys/momentry/log/rustdesk-*.log
|
||||
```
|
||||
|
||||
**注意: 不要刪除以下共用目錄**:
|
||||
```bash
|
||||
# 這些是共用的,不要刪除!
|
||||
# /Users/accusys/momentry/var
|
||||
# /Users/accusys/momentry/log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 手動檢查命令
|
||||
|
||||
```bash
|
||||
# 1. 檢查進程
|
||||
ps aux | grep rustdesk | grep -v grep
|
||||
|
||||
# 2. 檢查 Port
|
||||
lsof -i :21115
|
||||
lsof -i :21116
|
||||
lsof -i :21117
|
||||
lsof -i :21118
|
||||
lsof -i :21119
|
||||
|
||||
# 3. 測試連線
|
||||
nc -zv localhost 21115
|
||||
nc -zv localhost 21116
|
||||
|
||||
# 4. 查看日誌
|
||||
tail -20 /Users/accusys/momentry/log/rustdesk-hbbs.log
|
||||
tail -20 /Users/accusys/momentry/log/rustdesk-hbbr.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| Server ID | 59.124.167.225 |
|
||||
| NAT Test Port | 21116 |
|
||||
| Relay Port | 21117, 21119 |
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### RustDesk 無法啟動
|
||||
|
||||
```bash
|
||||
# 檢查日誌
|
||||
tail -f /Users/accusys/momentry/log/rustdesk-hbbs.log
|
||||
tail -f /Users/accusys/momentry/log/rustdesk-hbbr.log
|
||||
|
||||
# 檢查數據目錄權限
|
||||
ls -la /Users/accusys/momentry/var/rustdesk/
|
||||
|
||||
# 重新設定權限
|
||||
chown -R $(whoami):staff /Users/accusys/momentry/var/rustdesk
|
||||
```
|
||||
|
||||
### Port 被佔用
|
||||
|
||||
```bash
|
||||
# 檢查哪個程序佔用 port
|
||||
lsof -i :21116
|
||||
|
||||
# 終止佔用程序
|
||||
kill <PID>
|
||||
```
|
||||
|
||||
### 需要重新載入 plist
|
||||
|
||||
```bash
|
||||
# 卸載舊服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
|
||||
# 載入新服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 安裝 | `/opt/homebrew/bin/hbbs` | RustDesk Server 執行檔 |
|
||||
| 安裝 | `/opt/homebrew/bin/hbbr` | RustDesk Relay 執行檔 |
|
||||
| 數據目錄 | `/Users/accusys/momentry/var/rustdesk/` | 數據儲存 |
|
||||
| HBBS 日誌 | `/Users/accusys/momentry/log/rustdesk-hbbs.log` | 服務日誌 |
|
||||
| HBBR 日誌 | `/Users/accusys/momentry/log/rustdesk-hbbr.log` | 中繼日誌 |
|
||||
| HBBS Plist | `/Library/LaunchDaemons/com.momentry.rustdesk.hbbs.plist` | 開機啟動 |
|
||||
| HBBR Plist | `/Library/LaunchDaemons/com.momentry.rustdesk.hbbr.plist` | 開機啟動 |
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 安裝方式: Homebrew (Cask)
|
||||
- Client 版本: 1.4.6
|
||||
- Server 版本: 1.1.15 (hbbs/hbbr binaries from homebrew)
|
||||
- 數據目錄: /Users/accusys/momentry/var/rustdesk/
|
||||
- 日誌目錄: /Users/accusys/momentry/log/
|
||||
|
||||
---
|
||||
|
||||
## 注意事項
|
||||
|
||||
### Server 版本
|
||||
|
||||
Homebrew 的 RustDesk Cask 只提供客戶端應用程序。服務器二進制文件 (hbbs, hbbr) 需要從其他來源安裝或自行編譯。當前使用的版本較舊 (1.1.15)。
|
||||
|
||||
如需更新服務器版本,可以考慮:
|
||||
1. 從源代碼編譯最新版本
|
||||
2. 使用 RustDesk 官方提供的 Docker 鏡像
|
||||
3. 等待 Homebrew 添加服務器公式
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,332 +0,0 @@
|
||||
# WordPress 安裝指南 (Portal)
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-22 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建文件 | Warren | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 1. 概述
|
||||
|
||||
本文檔說明 Momentry Portal 的 WordPress 安裝配置,作為系統入口整合 n8n 自動化與 sftpgo 檔案服務。
|
||||
|
||||
---
|
||||
|
||||
## 2. 當前狀態
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| WordPress 版本 | 6.x |
|
||||
| URL | https://wp.momentry.ddns.net |
|
||||
| 安裝路徑 | `/Users/accusys/wordpress/web` |
|
||||
| 資料庫 | wordpress (MariaDB) |
|
||||
| 資料庫用戶 | wp_user |
|
||||
|
||||
---
|
||||
|
||||
## 3. 目錄結構
|
||||
|
||||
```
|
||||
/Users/accusys/wordpress/
|
||||
├── web/ # WordPress 主目錄
|
||||
│ ├── wp-admin/ # WordPress 管理面板
|
||||
│ ├── wp-content/ # 內容目錄
|
||||
│ │ ├── ai1wm-backups/ # 備份檔案 (*.wpress)
|
||||
│ │ ├── languages/ # 語言檔案
|
||||
│ │ ├── plugins/ # 插件目錄
|
||||
│ │ ├── themes/ # 主題目錄
|
||||
│ │ ├── uploads/ # 上傳檔案
|
||||
│ │ └── cache/ # 快取目錄
|
||||
│ ├── wp-includes/ # WordPress 核心
|
||||
│ └── wp-config.php # 配置文件
|
||||
├── docker-compose.yml # Docker 配置
|
||||
└── wordpress_backup.sql # 資料庫備份
|
||||
```
|
||||
|
||||
### 空間使用
|
||||
|
||||
| 目錄 | 大小 | 說明 |
|
||||
|------|------|------|
|
||||
| `ai1wm-backups/` | ~250MB | 完整備份 (保留 2 個) |
|
||||
| `plugins/` | 80MB | 插件 |
|
||||
| `themes/` | 14MB | 主題 |
|
||||
| `uploads/` | 12MB | 上傳檔案 |
|
||||
|
||||
---
|
||||
|
||||
## 4. 程式碼位置
|
||||
|
||||
自訂程式碼存放位置:
|
||||
|
||||
| 類型 | 路徑 |
|
||||
|------|------|
|
||||
| 主題 | `/Users/accusys/wordpress/web/wp-content/themes/` |
|
||||
| 插件 | `/Users/accusys/wordpress/web/wp-content/plugins/` |
|
||||
| 必須插件 | `/Users/accusys/wordpress/web/wp-content/mu-plugins/` |
|
||||
|
||||
---
|
||||
|
||||
## 5. 插件清單
|
||||
|
||||
| 插件 | 用途 | 說明 |
|
||||
|------|------|------|
|
||||
| elementor | 頁面建構 | 視覺化頁面編輯器 |
|
||||
| all-in-one-wp-migration | 網站遷移/備份 | 完整網站備份工具 |
|
||||
| akismet | 垃圾留言過濾 | 保護留言區域 |
|
||||
| code-snippets | 自訂程式碼 | 無需修改主題即可添加 PHP |
|
||||
|
||||
### Elementor 版本
|
||||
- 版本: 最新穩定版
|
||||
- 用途: 頁面建構(開發階段)
|
||||
|
||||
### 未來計畫
|
||||
- Phase 2: OpenCode 重構
|
||||
- 目標: 交付無 Elementor 依賴版本
|
||||
|
||||
---
|
||||
|
||||
## 6. 主題清單
|
||||
|
||||
| 主題 | 說明 |
|
||||
|------|------|
|
||||
| twentytwentyfive | 目前使用主題 |
|
||||
| twentytwentyfour | 備用 |
|
||||
| twentytwentythree | 備用 |
|
||||
|
||||
---
|
||||
|
||||
## 7. 整合計畫
|
||||
|
||||
### 7.1 n8n 整合
|
||||
|
||||
n8n 作為自動化引擎,WordPress 頁面透過 REST API 或 Webhook 與 n8n 通訊。
|
||||
|
||||
| 整合方式 | 說明 |
|
||||
|----------|------|
|
||||
| REST API | WordPress 呼叫 n8n API |
|
||||
| Webhook | n8n 觸發 WordPress 動作 |
|
||||
|
||||
### 7.2 sftpgo 整合
|
||||
|
||||
sftpgo 作為檔案服務,WordPress 頁面提供檔案上傳/下載功能。
|
||||
|
||||
| 整合方式 | 說明 |
|
||||
|----------|------|
|
||||
| WebDAV | 透過 WebDAV API 操作檔案 |
|
||||
| REST API | 透過 sftpgo API 操作檔案 |
|
||||
|
||||
---
|
||||
|
||||
## 8. 管理命令
|
||||
|
||||
### 8.1 清理 ai1wm 備份
|
||||
|
||||
```bash
|
||||
# 查看現有備份
|
||||
ls -lt /Users/accusys/wordpress/web/wp-content/ai1wm-backups/*.wpress
|
||||
|
||||
# 保留最近 2 個,刪除舊的
|
||||
ls -t /Users/accusys/wordpress/web/wp-content/ai1wm-backups/*.wpress | tail -n +3 | xargs rm
|
||||
|
||||
# 驗證結果
|
||||
du -sh /Users/accusys/wordpress/web/wp-content/ai1wm-backups/
|
||||
```
|
||||
|
||||
### 8.2 清理 WordPress 快取
|
||||
|
||||
```bash
|
||||
# 刪除 Object Cache
|
||||
wp cache flush
|
||||
|
||||
# 刪除 Elementor 快取
|
||||
wp elementor flush_css
|
||||
|
||||
# 刪除全部快取
|
||||
wp cache flush && wp elementor flush_css
|
||||
```
|
||||
|
||||
### 8.3 資料庫操作
|
||||
|
||||
```bash
|
||||
# 匯出資料庫
|
||||
mysqldump -u wp_user -p wordpress > wordpress_backup.sql
|
||||
|
||||
# 匯入資料庫
|
||||
mysql -u wp_user -p wordpress < wordpress_backup.sql
|
||||
```
|
||||
|
||||
### 8.4 權限檢查
|
||||
|
||||
```bash
|
||||
# 檢查目錄權限
|
||||
ls -la /Users/accusys/wordpress/web/wp-content/
|
||||
|
||||
# 確認 wp-content 可寫入
|
||||
chown -R _www:_www /Users/accusys/wordpress/web/wp-content/
|
||||
chmod -R 755 /Users/accusys/wordpress/web/wp-content/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. 故障排除
|
||||
|
||||
### 9.1 常見問題
|
||||
|
||||
| 問題 | 解決方案 |
|
||||
|------|----------|
|
||||
| 頁面載入緩慢 | 清理 Elementor/Object Cache |
|
||||
| 上傳檔案失敗 | 檢查 wp-content/uploads 權限 |
|
||||
| 502/504 錯誤 | 重啟 PHP-FPM |
|
||||
| 資料庫連線失敗 | 檢查 wp-config.php 設定 |
|
||||
|
||||
### 9.2 診斷命令
|
||||
|
||||
```bash
|
||||
# 檢查 PHP-FPM 狀態
|
||||
lsof -i :9000
|
||||
|
||||
# 檢查 MySQL/MariaDB 狀態
|
||||
lsof -i :3306
|
||||
|
||||
# 檢查 Apache/Nginx 狀態
|
||||
lsof -i :80
|
||||
|
||||
# 查看 WordPress 錯誤日誌
|
||||
tail -100 /Users/accusys/momentry/log/php-fpm.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. 開發協作
|
||||
|
||||
### 10.1 與 marcom 團隊協作
|
||||
|
||||
| 角色 | 負責 |
|
||||
|------|------|
|
||||
| marcom 團隊 | Figma 設計 / Elementor 建構 |
|
||||
| OpenCode | 程式碼實作 / 重構 |
|
||||
|
||||
### 10.2 開發流程
|
||||
|
||||
```
|
||||
Phase 1: marcom 建構 (現在)
|
||||
└── Elementor 頁面建構
|
||||
|
||||
Phase 2: 交付審視 (TBD)
|
||||
└── 功能確認 / 重構評估
|
||||
|
||||
Phase 3: OpenCode 重構 (討論後)
|
||||
└── 純程式碼實作
|
||||
└── 交付客戶 (無 Elementor 依賴)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. PHP LSP 開發環境
|
||||
|
||||
### 11.1 軟體需求
|
||||
|
||||
| 軟體 | 版本 | 安裝方式 |
|
||||
|------|------|----------|
|
||||
| PHP | 8.0+ | 已安裝 (8.5.2) |
|
||||
| Composer | 2.0+ | `brew install composer` |
|
||||
| phpactor | Latest | PHAR 安裝 |
|
||||
|
||||
### 11.2 安裝步驟
|
||||
|
||||
#### 1. 安裝 Composer
|
||||
|
||||
```bash
|
||||
brew install composer
|
||||
```
|
||||
|
||||
#### 2. 安裝 phpactor
|
||||
|
||||
```bash
|
||||
curl -sSL https://github.com/phpactor/phpactor/releases/latest/download/phpactor.phar -o ~/bin/phpactor
|
||||
chmod +x ~/bin/phpactor
|
||||
export PATH="$HOME/bin:$PATH"
|
||||
```
|
||||
|
||||
#### 3. 安裝 WordPress Stubs
|
||||
|
||||
```bash
|
||||
cd /Users/accusys/wordpress/web
|
||||
composer require --dev php-stubs/wordpress-stubs
|
||||
```
|
||||
|
||||
#### 4. 設定 phpactor
|
||||
|
||||
```bash
|
||||
# 設定檔位置
|
||||
mkdir -p ~/.config/phpactor
|
||||
|
||||
# 設定內容
|
||||
cat > ~/.config/phpactor/phpactor.json << 'EOF'
|
||||
{
|
||||
"core.min_memory_limit": 1610612736,
|
||||
"worse_reflection.additive_stubs": [
|
||||
"/Users/accusys/wordpress/web/vendor/php-stubs/wordpress-stubs/wordpress-stubs.php"
|
||||
]
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
#### 5. 建立索引
|
||||
|
||||
```bash
|
||||
cd /Users/accusys/wordpress/web
|
||||
~/bin/phpactor index:build --reset
|
||||
```
|
||||
|
||||
### 11.3 OpenCode 使用方式
|
||||
|
||||
```bash
|
||||
# 確認安裝
|
||||
~/bin/phpactor --version
|
||||
|
||||
# 查詢類別
|
||||
~/bin/phpactor class:search "WP_User"
|
||||
|
||||
# 查看類別資訊
|
||||
~/bin/phpactor index:query WP_User
|
||||
|
||||
# 導航到定義
|
||||
~/bin/phpactor navigate /path/to/file.php
|
||||
|
||||
# 查詢參照
|
||||
~/bin/phpactor references /path/to/file.php
|
||||
```
|
||||
|
||||
### 11.4 常用指令
|
||||
|
||||
| 指令 | 用途 |
|
||||
|------|------|
|
||||
| `phpactor class:search` | 搜尋類別 |
|
||||
| `phpactor index:query` | 查詢索引 |
|
||||
| `phpactor index:build` | 建立索引 |
|
||||
| `phpactor index:clean` | 清除索引 |
|
||||
| `phpactor config:dump` | 顯示設定 |
|
||||
|
||||
---
|
||||
|
||||
## 12. 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| WordPress 主目錄 | `/Users/accusys/wordpress/web` | 網站根目錄 |
|
||||
| 備份目錄 | `/Users/accusys/momentry/backup/wordpress/` | 每日備份 |
|
||||
| 日誌目錄 | `/Users/accusys/momentry/log/` | PHP/Apache 日誌 |
|
||||
| phpactor | `~/bin/phpactor` | PHP LSP 主程式 |
|
||||
| phpactor 設定 | `~/.config/phpactor/phpactor.json` | LSP 設定檔 |
|
||||
| WordPress Stubs | `/Users/accusys/wordpress/web/vendor/php-stubs/` | WordPress 函數定義 |
|
||||
@@ -1,249 +0,0 @@
|
||||
# n8n 整合範例
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-18 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-18 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-25 | 更新API回應格式 (media_url→file_path) 與認證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## 基本設定
|
||||
|
||||
### API 端點
|
||||
- **Base URL:** `http://localhost:3002/api/v1`
|
||||
- **Method:** `POST`
|
||||
- **Content-Type:** `application/json`
|
||||
- **Authentication:** `X-API-Key: YOUR_API_KEY` (所有 `/api/v1/*` 端點皆需要)
|
||||
|
||||
---
|
||||
|
||||
## Workflow 1: 基礎搜尋
|
||||
|
||||
### Trigger: Manual / Webhook
|
||||
|
||||
```
|
||||
[Manual Trigger]
|
||||
↓
|
||||
[HTTP Request] → POST http://localhost:3002/api/v1/search
|
||||
↓
|
||||
[Set] → 設定搜尋詞 "charade"
|
||||
↓
|
||||
[Code] → 處理回傳結果
|
||||
↓
|
||||
[Respond]
|
||||
```
|
||||
|
||||
### HTTP Request 設定
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:3002/api/v1/search",
|
||||
"method": "POST",
|
||||
"body": {
|
||||
"query": "={{ $json.searchTerm }}",
|
||||
"limit": 5
|
||||
},
|
||||
"options": {
|
||||
"headers": {
|
||||
"Content-Type": "application/json",
|
||||
"X-API-Key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Code (處理結果)
|
||||
```javascript
|
||||
const results = $input.first().json.results;
|
||||
|
||||
const videoUrl = "https://wp.momentry.ddns.net/Old_Time_Movie_Show_-_Charade_1963.HD.mov";
|
||||
|
||||
return results.map(r => ({
|
||||
chunk_id: r.chunk_id,
|
||||
text: r.text,
|
||||
start: r.start_time,
|
||||
end: r.end_time,
|
||||
score: r.score,
|
||||
video_url: `${videoUrl}#t=${r.start_time},${r.end_time}`
|
||||
}));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 2: n8n 專用格式
|
||||
|
||||
使用 `/n8n/search` 端點(已包含 file_path)
|
||||
|
||||
### HTTP Request
|
||||
```json
|
||||
{
|
||||
"url": "http://localhost:3002/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"body": {
|
||||
"query": "={{ $json.searchTerm }}",
|
||||
"limit": 5
|
||||
},
|
||||
"options": {
|
||||
"headers": {
|
||||
"Content-Type": "application/json",
|
||||
"X-API-Key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 回傳格式
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 5,
|
||||
"hits": [
|
||||
{
|
||||
"id": "sentence_0006",
|
||||
"vid": "a1b10138a6bbb0cd",
|
||||
"start": 48.8,
|
||||
"end": 55.44,
|
||||
"title": "Chunk sentence_0006",
|
||||
"text": "fun plot twists...",
|
||||
"score": 0.526,
|
||||
"file_path": "/Users/accusys/momentry/var/sftpgo/data/demo/video.mp4"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> **注意**: API 現在返回 `file_path`(檔案系統路徑)而非 `media_url`(網頁 URL)。如需在網頁中播放影片,請將檔案路徑轉換為可訪問的 URL(例如透過 SFTPGo 分享連結)。
|
||||
|
||||
---
|
||||
|
||||
## Workflow 3: 訊息機器人整合
|
||||
|
||||
### Telegram Bot 範例
|
||||
|
||||
```
|
||||
[Webhook: Telegram]
|
||||
↓
|
||||
[Extract: /search charade]
|
||||
↓
|
||||
[HTTP Request] → POST /api/v1/search
|
||||
↓
|
||||
[Format Response]
|
||||
↓
|
||||
[Telegram: Send Message]
|
||||
```
|
||||
|
||||
### 回傳格式
|
||||
```
|
||||
🎬 搜尋結果: "charade"
|
||||
|
||||
1. "fun plot twists, Woody Dialog and charming performances..."
|
||||
⏱ 48.8s - 55.4s
|
||||
📊 分數: 0.526
|
||||
|
||||
2. "Don't you like me to say that a pretty girl..."
|
||||
⏱ 4745.6s - 4748.6s
|
||||
📊 分數: 0.525
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 4: 多影片搜尋
|
||||
|
||||
### 取得所有影片
|
||||
```
|
||||
[HTTP Request]
|
||||
GET http://localhost:3002/api/v1/videos
|
||||
```
|
||||
|
||||
### 依 UUID 篩選
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 5,
|
||||
"uuid": "a1b10138a6bbb0cd"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow 5: 定時更新
|
||||
|
||||
```
|
||||
[Cron: 每小時]
|
||||
↓
|
||||
[HTTP Request] → GET /api/v1/videos
|
||||
↓
|
||||
[Loop Over Items]
|
||||
↓
|
||||
[Check: 新影片?]
|
||||
↓
|
||||
[Process: 執行 vectorize]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 實用場景
|
||||
|
||||
### 1. 客服機器人
|
||||
用戶問「這部片在哪一段有談到 charade?」
|
||||
→ 搜尋 API → 回傳時戳 → 直接播放該片段
|
||||
|
||||
### 2. 內容推薦
|
||||
根據用戶輸入的關鍵字,找到相關影片片段
|
||||
|
||||
### 3. 自動化剪輯
|
||||
搜尋多個片段 → 組合成精華影片
|
||||
|
||||
---
|
||||
|
||||
## 錯誤處理
|
||||
|
||||
```javascript
|
||||
const response = $input.first();
|
||||
|
||||
if (!response.json.results || response.json.results.length === 0) {
|
||||
return {
|
||||
success: false,
|
||||
message: "找不到相關結果"
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
count: response.json.results.length,
|
||||
data: response.json.results
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 測試用 cURL
|
||||
|
||||
```bash
|
||||
# 基本搜尋
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}'
|
||||
|
||||
# n8n 格式
|
||||
curl -X POST http://localhost:3002/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"query": "charade", "limit": 3}'
|
||||
|
||||
# 取得影片列表
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos
|
||||
|
||||
# 取得特定影片的區塊
|
||||
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:3002/api/v1/videos/a1b10138a6bbb0cd/chunks
|
||||
```
|
||||
@@ -1,355 +0,0 @@
|
||||
# n8n Video RAG Demo - API 執行記錄
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-22 |
|
||||
| 文件版本 | V1.1 |
|
||||
| 目標 | 完整執行 n8n Video RAG Workflow 並記錄所有 API 呼叫 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建文件 | Warren | OpenCode |
|
||||
| V1.1 | 2026-03-26 | 更新 API 範例,新增 X-API-Key 驗證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: SFTPGo 準備
|
||||
|
||||
### Step 1.1: 取得 Demo User Token
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:8080/api/v2/user/token" \
|
||||
-u "demo:demopassword123"
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```
|
||||
GET /api/v2/user/token
|
||||
Authorization: Basic ZG9tbzpkZW1vcGFzc3dvcmQxMjM=
|
||||
```
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
|
||||
"expires_at": "2026-03-22T07:05:57Z"
|
||||
}
|
||||
```
|
||||
|
||||
**Token 有效期限:** 20 分鐘
|
||||
|
||||
**Session Token (Demo User):**
|
||||
```
|
||||
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiQVBJVXNlciIsIjo6MSJdLCJleHAiOjE3NzQxNjMxNTcsImlhdCI6MTc3NDE2MTk1NywianRpIjoiZDZ2cDA5YWcyZnIwMnY3aTlybDAiLCJuYmYiOjE3NzQxNjE5NDcsInN1YiI6IjE3NzQxNjE5NTM0OTMiLCJ1c2VybmFtZSI6ImRlbW8ifQ.yw0UCv8sQXXCkOr7qmK2ejLzuoA8IDrmC9bpgFE4R_Q
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.2: 上傳測試影片到 SFTPGo
|
||||
|
||||
**影片選擇:** `Old_Time_Movie_Show_-_Charade_1963.HD.mov` (2.3 GB)
|
||||
- 路徑: `/Users/accusys/test_video/Old_Time_Movie_Show_-_Charade_1963.HD.mov`
|
||||
- ASR Segments: 1,917 (已預處理)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
curl -X POST "http://localhost:8080/api/v2/user/files" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-F "path=/demo" \
|
||||
-F "mkdir_parents=true" \
|
||||
-F "filenames=@/Users/accusys/test_video/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```
|
||||
POST /api/v2/user/files
|
||||
Authorization: Bearer <token>
|
||||
Content-Type: multipart/form-data
|
||||
|
||||
path: /demo
|
||||
mkdir_parents: true
|
||||
filenames: @/path/to/Old_Time_Movie_Show_-_Charade_1963.HD.mov
|
||||
```
|
||||
|
||||
**Response (201 Created):**
|
||||
```json
|
||||
{"message":"Upload completed"}
|
||||
```
|
||||
|
||||
**上傳統計:**
|
||||
- 檔案大小: 2,361,629,896 bytes (2.3 GB)
|
||||
- 上傳時間: 7 秒
|
||||
- 平均速度: ~337 MB/s
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.3: 建立分享連結
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:8080/api/v2/user/shares" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "Charade_1963_Demo",
|
||||
"paths": ["/Old_Time_Movie_Show_-_Charade_1963.HD.mov"],
|
||||
"scope": 1,
|
||||
"expires_at": 0
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v2/user/shares
|
||||
Authorization: Bearer <token>
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "Charade_1963_Demo",
|
||||
"paths": ["/Old_Time_Movie_Show_-_Charade_1963.HD.mov"],
|
||||
"scope": 1,
|
||||
"expires_at": 0
|
||||
}
|
||||
```
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{"message":"Share created"}
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
### Step 1.4: 驗證上傳結果
|
||||
|
||||
**API 呼叫 - 列出分享:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:8080/api/v2/user/shares" \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "CjmQfrkXY5qDtC46WVZY2S",
|
||||
"name": "Charade_1963_Demo",
|
||||
"scope": 1,
|
||||
"paths": [
|
||||
"/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
],
|
||||
"username": "demo",
|
||||
"created_at": 1774162072853,
|
||||
"updated_at": 1774162072853,
|
||||
"password": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
**分享連結:**
|
||||
- Share ID: `CjmQfrkXY5qDtC46WVZY2S`
|
||||
- Browse URL: `http://localhost:8080/web/client/pubshares/CjmQfrkXY5qDtC46WVZY2S/browse`
|
||||
|
||||
**本地目錄驗證:**
|
||||
```
|
||||
/Users/accusys/sftpgo_test/demo/
|
||||
└── Old_Time_Movie_Show_-_Charade_1963.HD.mov (2,361,629,896 bytes)
|
||||
```
|
||||
|
||||
**結果:** ✅ 成功
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Momentry 註冊
|
||||
|
||||
### Step 2.1: 健康檢查
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:3002/health"
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2.2: 註冊影片
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/register" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"path": "/Users/accusys/sftpgo_test/demo/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v1/register
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"path": "/Users/accusys/sftpgo_test/demo/Old_Time_Movie_Show_-_Charade_1963.HD.mov"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
{
|
||||
"uuid": "...",
|
||||
"video_id": ...,
|
||||
"file_name": "...",
|
||||
"duration": ...,
|
||||
"width": ...,
|
||||
"height": ...
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: 處理進度追蹤
|
||||
|
||||
### Step 3.1: 查詢處理進度 (新版 API)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X GET "http://localhost:3002/api/v1/progress/{uuid}"
|
||||
```
|
||||
|
||||
**Response (新版 - 包含影片資訊與系統資源):**
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"user": null,
|
||||
"group": null,
|
||||
"file_name": "Old_Time_Movie_Show_-_Charade_1963.HD.mov",
|
||||
"duration": 6879.33,
|
||||
"overall_progress": 28,
|
||||
"cpu_percent": 3.7,
|
||||
"gpu_percent": null,
|
||||
"memory_percent": 0.1,
|
||||
"memory_mb": 19328,
|
||||
"processors": [
|
||||
{"name": "asr", "status": "complete", "current": 1867, "total": 0, "progress": 100, "message": "1867 segments"},
|
||||
{"name": "cut", "status": "complete", "current": 1331, "total": 1331, "progress": 100, "message": "1331 scenes"},
|
||||
{"name": "asrx", "status": "error", "current": 0, "total": 0, "progress": 0, "message": "0 segments"},
|
||||
{"name": "yolo", "status": "progress", "current": 69400, "total": 412343, "progress": 16, "message": "frame 69400"},
|
||||
{"name": "ocr", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""},
|
||||
{"name": "face", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""},
|
||||
{"name": "pose", "status": "pending", "current": 0, "total": 0, "progress": 0, "message": ""}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**欄位說明:**
|
||||
| 欄位 | 說明 |
|
||||
|------|------|
|
||||
| uuid | 影片唯一識別碼 |
|
||||
| user | 處理所屬用戶 (如已設定) |
|
||||
| group | 處理所屬群組 (如已設定) |
|
||||
| file_name | 影片檔案名稱 |
|
||||
| duration | 影片時長 (秒) |
|
||||
| overall_progress | 整體進度 (百分比) |
|
||||
| cpu_percent | CPU 使用率 (%) |
|
||||
| gpu_percent | GPU 使用率 (%),無 GPU 則為 null |
|
||||
| memory_percent | 記憶體使用率 (%) |
|
||||
| memory_mb | 記憶體使用量 (MB) |
|
||||
| processors | 各處理器狀態陣列 |
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: 自然語言檢索
|
||||
|
||||
### Step 4.1: RAG 搜尋
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "..."
|
||||
}'
|
||||
```
|
||||
|
||||
**Request:**
|
||||
```json
|
||||
POST /api/v1/search
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "<uuid from registration>"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4.2: n8n 搜尋 (含 file_path)
|
||||
|
||||
**API 呼叫:**
|
||||
```bash
|
||||
curl -X POST "http://localhost:3002/api/v1/n8n/search" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: demo_api_key_12345" \
|
||||
-d '{
|
||||
"query": "What is the movie about?",
|
||||
"limit": 10,
|
||||
"uuid": "..."
|
||||
}'
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```
|
||||
(待填寫)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 憑證彙整
|
||||
|
||||
| 服務 | 項目 | 值 |
|
||||
|------|------|------|
|
||||
| SFTPGo | API Base | `http://localhost:8080/api/v2` |
|
||||
| SFTPGo | Demo User | `demo` |
|
||||
| SFTPGo | Demo Password | `demopassword123` (已重設) |
|
||||
| SFTPGo | Demo Home | `/Users/accusys/sftpgo_test/demo` |
|
||||
| SFTPGo | Token Endpoint | `/api/v2/user/token` |
|
||||
| SFTPGo | Share ID | `CjmQfrkXY5qDtC46WVZY2S` |
|
||||
| Momentry | Server | `http://localhost:3002` |
|
||||
| Momentry | MEDIA_BASE_URL | `https://wp.momentry.ddns.net` |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 日期 | 版本 | 變更 |
|
||||
|------|------|------|
|
||||
| 2026-03-22 | v1.0 | 初始建立文件 |
|
||||
| 2026-03-22 | v1.1 | 成功取得 Demo Token |
|
||||
| 2026-03-22 | v1.2 | Phase 1 完成 (上傳 Charade 2.3GB) |
|
||||
@@ -1,269 +0,0 @@
|
||||
# n8n HTTP Request Node 設定指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-26 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V1.1 | 2026-03-26 | 新增 API Key 驗證說明,更新 curl 範例 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
> **API URL 說明**:
|
||||
> - **本地測試**: `http://localhost:3002`
|
||||
> - **n8n workflow**: `https://api.momentry.ddns.net`
|
||||
>
|
||||
> ⚠️ 在 n8n 中請使用 `api.momentry.ddns.net`,不要使用 `localhost:3002`
|
||||
|
||||
---
|
||||
|
||||
## 錯誤排除
|
||||
|
||||
### 錯誤訊息: "Your request is invalid or could not be processed by the service"
|
||||
|
||||
這通常表示 HTTP Request Node 的設定不正確。
|
||||
|
||||
---
|
||||
|
||||
## 正確的 Node 設定方式
|
||||
|
||||
### 方法 1: 使用 JSON Body (推薦)
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Content Type: JSON
|
||||
├── Body:
|
||||
│ {
|
||||
│ "query": "={{ $json.query }}",
|
||||
│ "limit": "={{ $json.limit }}"
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 方法 2: 使用 Raw Body + Headers
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Authentication: None
|
||||
├── Send Body: ✓ (checked)
|
||||
├── Specify Body: Using JSON
|
||||
├── JSON Body:
|
||||
│ {
|
||||
│ "query": "charade",
|
||||
│ "limit": 3
|
||||
│ }
|
||||
├── Send Headers: ✓ (checked)
|
||||
└── Header Parameters:
|
||||
├── Content-Type: application/json
|
||||
└── X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
```
|
||||
|
||||
### 方法 3: 最簡單的 Hardcoded 測試
|
||||
|
||||
```
|
||||
Node: HTTP Request
|
||||
├── URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
├── Method: POST
|
||||
├── Send Body: ✓
|
||||
├── Content Type: JSON
|
||||
└── Body:
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見錯誤與解決
|
||||
|
||||
### ❌ 錯誤 1: Body 格式錯誤
|
||||
|
||||
**錯誤設定:**
|
||||
```
|
||||
Body Parameters:
|
||||
query = {{ $json.query }}
|
||||
limit = {{ $json.limit }}
|
||||
```
|
||||
|
||||
**正確設定:**
|
||||
```
|
||||
Content Type: JSON
|
||||
Body:
|
||||
{
|
||||
"query": "={{ $json.query }}",
|
||||
"limit": "={{ $json.limit }}"
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ 錯誤 2: 缺少引號
|
||||
|
||||
**錯誤:**
|
||||
```json
|
||||
{
|
||||
query: "charade",
|
||||
limit: 3
|
||||
}
|
||||
```
|
||||
|
||||
**正確:**
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ 錯誤 3: URL 錯誤
|
||||
|
||||
**錯誤:**
|
||||
```
|
||||
URL: http://localhost:3002/api/v1/n8n/search
|
||||
```
|
||||
|
||||
**正確:**
|
||||
```
|
||||
URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 測試步驟
|
||||
|
||||
### 步驟 1: 創建最簡單的測試
|
||||
|
||||
1. 新建工作流程
|
||||
2. 添加 **Manual Trigger** Node
|
||||
3. 添加 **HTTP Request** Node
|
||||
4. 設定如下:
|
||||
- URL: `https://api.momentry.ddns.net/api/v1/n8n/search`
|
||||
- Method: POST
|
||||
- Send Body: ✓
|
||||
- Content Type: JSON
|
||||
- Body: `{"query": "charade", "limit": 2}`
|
||||
|
||||
### 步驟 2: 執行測試
|
||||
|
||||
1. 點擊 **Execute Workflow**
|
||||
2. 查看 HTTP Request Node 的輸出
|
||||
3. 應該看到 JSON 回應
|
||||
|
||||
### 步驟 3: 確認成功
|
||||
|
||||
成功的回應應該包含:
|
||||
```json
|
||||
{
|
||||
"query": "charade",
|
||||
"count": 2,
|
||||
"hits": [...]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 直接複製使用的工作流程 JSON
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Video Search - Working Example",
|
||||
"nodes": [
|
||||
{
|
||||
"parameters": {},
|
||||
"name": "When clicking \"Execute Workflow\"",
|
||||
"type": "n8n-nodes-base.manualTrigger",
|
||||
"typeVersion": 1,
|
||||
"position": [250, 300]
|
||||
},
|
||||
{
|
||||
"parameters": {
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"contentType": "json",
|
||||
"body": {
|
||||
"query": "charade",
|
||||
"limit": 3
|
||||
},
|
||||
"options": {}
|
||||
},
|
||||
"name": "Search Video API",
|
||||
"type": "n8n-nodes-base.httpRequest",
|
||||
"typeVersion": 4.1,
|
||||
"position": [450, 300]
|
||||
}
|
||||
],
|
||||
"connections": {
|
||||
"When clicking \"Execute Workflow\"": {
|
||||
"main": [
|
||||
[
|
||||
{
|
||||
"node": "Search Video API",
|
||||
"type": "main",
|
||||
"index": 0
|
||||
}
|
||||
]
|
||||
]
|
||||
}
|
||||
},
|
||||
"settings": {
|
||||
"executionOrder": "v1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**導入方式:**
|
||||
1. 在 n8n UI 中,點擊左上角的 Menu
|
||||
2. 選擇 **Import from File**
|
||||
3. 選擇上面的 JSON 文件
|
||||
|
||||
---
|
||||
|
||||
## 驗證 API 可用性
|
||||
|
||||
在終端機測試:
|
||||
```bash
|
||||
# 需要 API Key 驗證 (設定環境變數或直接替換)
|
||||
export MOMENTRY_API_KEY="muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69"
|
||||
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: $MOMENTRY_API_KEY" \
|
||||
-d '{"query":"charade","limit":2}'
|
||||
```
|
||||
|
||||
如果 curl 成功但 n8n 失敗,問題在於 n8n HTTP Request Node 的設定。
|
||||
|
||||
---
|
||||
|
||||
## 需要幫助?
|
||||
|
||||
如果仍然無法工作:
|
||||
1. 開啟工作流程
|
||||
2. 點擊 HTTP Request Node
|
||||
3. 點擊右上角的 **Execute Node** 單獨執行
|
||||
4. 查看錯誤訊息的詳細內容
|
||||
5. 檢查 Network tab 中的 request/response
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [API_INDEX.md](./API_INDEX.md) - 文件總覽(起點)
|
||||
- [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) - n8n 快速使用指南
|
||||
- [API_ENDPOINTS.md](./API_ENDPOINTS.md) - 端點完整說明
|
||||
@@ -1,575 +0,0 @@
|
||||
# Momentry n8n 整合使用手冊
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-22 | 創建 n8n 整合手冊 | Warren | OpenCode |
|
||||
| V1.1 | 2026-03-23 | 新增 API Key 驗證與完整工作流範例 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
**目標讀者**: n8n 使用者、DevOps
|
||||
|
||||
---
|
||||
|
||||
## 目錄
|
||||
|
||||
1. [概述](#1-概述)
|
||||
2. [前置作業](#2-前置作業)
|
||||
3. [建立 n8n API Key](#3-建立-n8n-api-key)
|
||||
4. [在 n8n 中使用 Momentry API](#4-在-n8n-中使用-momentry-api)
|
||||
5. [工作流範例](#5-工作流範例)
|
||||
6. [常見問題](#6-常見問題)
|
||||
|
||||
---
|
||||
|
||||
## 1. 概述
|
||||
|
||||
### 1.1 什麼是 n8n?
|
||||
|
||||
n8n 是一個開源的工作流自動化工具,可以連接各種服務和 API。
|
||||
|
||||
### 1.2 為什麼需要整合?
|
||||
|
||||
| 場景 | 說明 |
|
||||
|------|------|
|
||||
| 自動化影片處理 | 新影片上傳時自動觸發處理流程 |
|
||||
| 監控告警 | API Key 異常時發送通知 |
|
||||
| 定時備份 | 定期備份 API Key 資料 |
|
||||
| 跨系統同步 | 與其他系統同步 API Key 狀態 |
|
||||
|
||||
### 1.3 架構圖
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ 觸發器 │────▶│ n8n 工作流 │────▶│ Momentry │
|
||||
│ (Webhook/ │ │ (處理邏輯) │ │ API │
|
||||
│ Cron) │ └─────────────┘ └─────────────┘
|
||||
└─────────────┘ │ │
|
||||
│ │
|
||||
▼ ▼
|
||||
┌─────────────┐ ┌─────────────┐
|
||||
│ 通知 │ │ 動作 │
|
||||
│ (Slack/Email)│ │ (建立/查詢) │
|
||||
└─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 1.4 API URL 選擇
|
||||
|
||||
| 環境 | URL | 說明 |
|
||||
|------|-----|------|
|
||||
| **本地測試** | `http://localhost:3002` | 直接訪問 API |
|
||||
| **n8n workflow** | `https://api.momentry.ddns.net` | 通過反向代理 |
|
||||
|
||||
> ⚠️ **重要**: 在 n8n HTTP Request Node 中,請使用 `https://api.momentry.ddns.net` 而非 `localhost:3002`,因為 n8n 需要從外部訪問 API。
|
||||
|
||||
**本地測試時**:
|
||||
```bash
|
||||
curl http://localhost:3002/health
|
||||
```
|
||||
|
||||
**n8n Workflow 中**:
|
||||
```
|
||||
URL: https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. 前置作業
|
||||
|
||||
### 2.1 確認服務狀態
|
||||
|
||||
```bash
|
||||
# 檢查 Momentry API
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 檢查 n8n
|
||||
curl https://n8n.momentry.ddns.net/api/v1/workflows \
|
||||
-H "X-N8N-API-KEY: your-api-key"
|
||||
```
|
||||
|
||||
### 2.2 取得 n8n API Key
|
||||
|
||||
#### 方式 A: 透過 Momentry CLI
|
||||
|
||||
```bash
|
||||
# 建立 n8n API Key
|
||||
momentry n8n create \
|
||||
--api-key "your-existing-n8n-api-key" \
|
||||
--label "momentry-integration" \
|
||||
--expires-in-days 90
|
||||
|
||||
# 輸出:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# API Key: eyJhbGciOiJIUzI1NiIs...
|
||||
```
|
||||
|
||||
#### 方式 B: 透過 n8n 介面
|
||||
|
||||
1. 登入 n8n: https://n8n.momentry.ddns.net
|
||||
2. 前往 Settings → n8n API
|
||||
3. 點擊「Create an API Key」
|
||||
4. 複製 API Key
|
||||
|
||||
### 2.3 設定環境變數
|
||||
|
||||
在 n8n 中設定以下環境變數:
|
||||
|
||||
| 變數名稱 | 值 | 說明 |
|
||||
|----------|-----|------|
|
||||
| `MOMENTRY_API_URL` | `http://localhost:3002` | Momentry API URL |
|
||||
| `MOMENTRY_API_KEY` | `your-api-key` | Momentry API Key |
|
||||
|
||||
---
|
||||
|
||||
## 3. 建立 n8n API Key
|
||||
|
||||
### 3.1 CLI 命令
|
||||
|
||||
```bash
|
||||
# 基本建立
|
||||
momentry n8n create \
|
||||
--api-key <existing-n8n-key> \
|
||||
--label <key-name>
|
||||
|
||||
# 設定過期時間
|
||||
momentry n8n create \
|
||||
--api-key <existing-n8n-key> \
|
||||
--label "ci-pipeline" \
|
||||
--expires-in-days 30
|
||||
```
|
||||
|
||||
### 3.2 範例:建立監控用 Key
|
||||
|
||||
```bash
|
||||
momentry n8n create \
|
||||
--api-key "n8n_api_1234567890" \
|
||||
--label "monitoring-key" \
|
||||
--expires-in-days 180
|
||||
|
||||
# 輸出:
|
||||
# ✅ n8n API Key created successfully!
|
||||
# Key ID: abc123-def456
|
||||
# Label: monitoring-key
|
||||
# API Key: eyJhbGciOiJIUz...
|
||||
```
|
||||
|
||||
### 3.3 列出已建立的 Key
|
||||
|
||||
```bash
|
||||
momentry n8n list --api-key <existing-n8n-key>
|
||||
|
||||
# 輸出:
|
||||
# 📋 n8n API Keys
|
||||
# ┌────────────────────────────────────────────────────────────────────────────┐
|
||||
# │ Label │ ID │
|
||||
# ├────────────────────────────────────────────────────────────────────────────┤
|
||||
# │ monitoring-key │ abc123-def456 │
|
||||
# │ ci-pipeline │ xyz789-abc123 │
|
||||
# └────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 在 n8n 中使用 Momentry API
|
||||
|
||||
> ⚠️ **注意**: API Key 管理端點 (`/api/v1/api-keys/*`) 目前仍在規劃中,尚未實作。以下為規劃中的 API 說明。
|
||||
|
||||
### 4.1 設定 HTTP Request 節點
|
||||
|
||||
```
|
||||
Method: POST
|
||||
URL: {{ $env.MOMENTRY_API_URL }}/api/v1/api-keys
|
||||
Headers:
|
||||
X-API-Key: {{ $env.MOMENTRY_API_KEY }}
|
||||
Content-Type: application/json
|
||||
Body:
|
||||
{
|
||||
"name": "auto-generated-key",
|
||||
"key_type": "service",
|
||||
"ttl_days": 90
|
||||
}
|
||||
```
|
||||
|
||||
### 4.2 可用的 API 端點
|
||||
|
||||
> ⚠️ **API Key 管理端點為規劃功能,目前尚未實作**
|
||||
|
||||
#### 已實作端點
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/health` | 健康檢查 |
|
||||
| POST | `/api/v1/search` | 語意搜尋 |
|
||||
| POST | `/api/v1/n8n/search` | n8n 格式搜尋 |
|
||||
| GET | `/api/v1/videos` | 列出所有影片 |
|
||||
| GET | `/api/v1/lookup` | 查詢影片 |
|
||||
| GET | `/api/v1/progress/:uuid` | 處理進度 |
|
||||
|
||||
#### 規劃中端點 *(尚未實作)*
|
||||
|
||||
| 方法 | 端點 | 說明 |
|
||||
|------|------|------|
|
||||
| GET | `/api/v1/api-keys` | 列出所有 API Keys |
|
||||
| POST | `/api/v1/api-keys` | 建立新的 API Key |
|
||||
| DELETE | `/api/v1/api-keys/{id}` | 刪除 API Key |
|
||||
| POST | `/api/v1/api-keys/{id}/rotate` | 請求 Key 輪換 |
|
||||
|
||||
---
|
||||
|
||||
## 5. 工作流範例
|
||||
|
||||
### 範例 1:定時檢查 API Key 狀態
|
||||
|
||||
**目的**: 每天早上 9 點檢查即將過期的 API Keys
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Filter │────▶│ Slack │
|
||||
│ (每天 9AM) │ │ Request │ │ (7天內過期) │ │ 通知 │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Filter 設定**:
|
||||
|
||||
```javascript
|
||||
// 檢查是否在 7 天內過期
|
||||
const expiresAt = new Date($json.expires_at);
|
||||
const now = new Date();
|
||||
const sevenDaysLater = new Date(now.getTime() + 7 * 24 * 60 * 60 * 1000);
|
||||
|
||||
return expiresAt <= sevenDaysLater && expiresAt > now;
|
||||
```
|
||||
|
||||
**Slack 通知格式**:
|
||||
|
||||
```
|
||||
⚠️ API Key 即將過期提醒
|
||||
|
||||
以下 API Key 將在 7 天內過期:
|
||||
{{ $json.map(k => `• ${k.name} (${k.key_id}) - 過期時間: ${k.expires_at}`).join('\n') }}
|
||||
|
||||
請及時處理!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 2:新影片上傳時自動建立 API Key
|
||||
|
||||
**目的**: 當有新影片上傳時,自動為該影片建立專用 API Key
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Webhook │────▶│ HTTP │────▶│ Set │────▶│ Respond │
|
||||
│ 觸發器 │ │ Request │ │ (組裝回應) │ │ Webhook │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Webhook 設定**:
|
||||
|
||||
```
|
||||
Method: POST
|
||||
Path: /new-video
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "POST",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
},
|
||||
"body": {
|
||||
"name": "video-{{ $json.video_id }}",
|
||||
"key_type": "service",
|
||||
"permissions": ["read"],
|
||||
"ttl_days": 30
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**回應格式**:
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"video_id": "{{ $json.video_id }}",
|
||||
"api_key_id": "{{ $json.key_id }}",
|
||||
"message": "API Key 已建立"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 3:API Key 異常告警
|
||||
|
||||
**目的**: 監控 API Key 異常使用,發送告警通知
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Webhook │────▶│ Switch │────▶│ Email │ │ Slack │
|
||||
│ (異常通知) │ │ (嚴重程度) │────▶│ 通知 │ │ 通知 │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Webhook 觸發設定** (在 Momentry 中):
|
||||
|
||||
```bash
|
||||
export WEBHOOK_URL="https://n8n.momentry.ddns.net/webhook/anomaly-alert"
|
||||
export WEBHOOK_EVENTS="anomaly_detected,rate_limited,ip_blocked"
|
||||
```
|
||||
|
||||
**Switch 節點設定**:
|
||||
|
||||
```javascript
|
||||
// 根據嚴重程度分流
|
||||
switch ($json.data.severity) {
|
||||
case 'critical':
|
||||
return 0; // Email + Slack
|
||||
case 'high':
|
||||
return 1; // Slack only
|
||||
default:
|
||||
return 2; // Log only
|
||||
}
|
||||
```
|
||||
|
||||
**Email 通知格式**:
|
||||
|
||||
```
|
||||
Subject: [{{ $json.data.severity }}] API Key 異常告警 - {{ $json.data.key_id }}
|
||||
|
||||
Dear Admin,
|
||||
|
||||
偵測到 API Key 異常使用:
|
||||
|
||||
Key ID: {{ $json.data.key_id }}
|
||||
異常類型: {{ $json.data.anomaly_type }}
|
||||
嚴重程度: {{ $json.data.severity }}
|
||||
時間: {{ $json.timestamp }}
|
||||
|
||||
請立即檢查系統狀態。
|
||||
|
||||
Best regards,
|
||||
Momentry Monitoring
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 4:定時備份 API Key 統計
|
||||
|
||||
**目的**: 每週一早上備份 API Key 統計報表
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Google │
|
||||
│ (每週一) │ │ Request │ │ Sheets │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**HTTP Request 設定**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys/stats",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Google Sheets 設定**:
|
||||
|
||||
```
|
||||
Spreadsheet: Momentry API Key Reports
|
||||
Sheet: Weekly Stats
|
||||
Append Row:
|
||||
- Date: {{ $now }}
|
||||
- Total Keys: {{ $json.total_keys }}
|
||||
- Active Keys: {{ $json.active_keys }}
|
||||
- Expired Keys: {{ $json.expired_keys }}
|
||||
- Anomalies (24h): {{ $json.anomalies_last_24h }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 範例 5:自動輪換即將過期的 Key
|
||||
|
||||
**目的**: 自動為即將過期的 Key 請求輪換
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Schedule │────▶│ HTTP │────▶│ Filter │────▶│ HTTP │
|
||||
│ (每天) │ │ (取得 Keys) │ │ (即將過期) │ │ (請求輪換) │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**第一個 HTTP Request (取得 Keys)**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "GET",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Filter 設定**:
|
||||
|
||||
```javascript
|
||||
// 14 天內過期且未請求輪換的 Key
|
||||
const expiresAt = new Date($json.expires_at);
|
||||
const now = new Date();
|
||||
const fourteenDaysLater = new Date(now.getTime() + 14 * 24 * 60 * 60 * 1000);
|
||||
|
||||
return expiresAt <= fourteenDaysLater &&
|
||||
!$json.rotation_required &&
|
||||
$json.status === 'active';
|
||||
```
|
||||
|
||||
**第二個 HTTP Request (請求輪換)**:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "POST",
|
||||
"url": "{{ $env.MOMENTRY_API_URL }}/api/v1/api-keys/{{ $json.key_id }}/rotate",
|
||||
"headers": {
|
||||
"X-API-Key": "{{ $env.MOMENTRY_API_KEY }}"
|
||||
},
|
||||
"body": {
|
||||
"reason": "auto_rotation_approaching_expiry"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 常見問題
|
||||
|
||||
### Q1: n8n 無法連接到 Momentry API
|
||||
|
||||
**檢查項目**:
|
||||
|
||||
```bash
|
||||
# 1. 確認 API 是否運行
|
||||
curl http://localhost:3002/health
|
||||
|
||||
# 2. 確認 API Key 是否有效
|
||||
momentry api-key validate --key "your-key"
|
||||
|
||||
# 3. 檢查防火牆設定
|
||||
nc -zv localhost 3002
|
||||
```
|
||||
|
||||
### Q2: API Key 建立失敗
|
||||
|
||||
**可能原因**:
|
||||
- API Key 已存在
|
||||
- 權限不足
|
||||
- 格式錯誤
|
||||
|
||||
**解決方式**:
|
||||
|
||||
```bash
|
||||
# 檢查現有 Keys
|
||||
momentry api-key list
|
||||
|
||||
# 使用不同的 label
|
||||
momentry n8n create --api-key "..." --label "unique-label-$(date +%s)"
|
||||
```
|
||||
|
||||
### Q3: Webhook 通知沒有收到
|
||||
|
||||
**檢查項目**:
|
||||
|
||||
```bash
|
||||
# 1. 確認 Webhook URL 設定
|
||||
echo $WEBHOOK_URL
|
||||
|
||||
# 2. 測試 Webhook
|
||||
curl -X POST $WEBHOOK_URL \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"test": true}'
|
||||
|
||||
# 3. 檢查 n8n 工作流是否啟用
|
||||
# 登入 n8n → 檢查工作流狀態
|
||||
```
|
||||
|
||||
### Q4: 如何撤銷 n8n API Key
|
||||
|
||||
```bash
|
||||
# 列出所有 Keys
|
||||
momentry n8n list --api-key "your-admin-key"
|
||||
|
||||
# 刪除指定 Key
|
||||
momentry n8n delete \
|
||||
--api-key "your-admin-key" \
|
||||
--label "key-to-delete"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### A. n8n 工作流匯出
|
||||
|
||||
將上述範例工作流匯入 n8n:
|
||||
|
||||
1. 複製工作流 JSON
|
||||
2. 登入 n8n
|
||||
3. 點擊「+」→「Import from File」
|
||||
4. 貼上 JSON 並儲存
|
||||
|
||||
### B. 環境變數總覽
|
||||
|
||||
```bash
|
||||
# Momentry
|
||||
MOMENTRY_API_URL=http://localhost:3002
|
||||
MOMENTRY_API_KEY=your-api-key
|
||||
|
||||
# n8n
|
||||
N8N_URL=https://n8n.momentry.ddns.net
|
||||
N8N_API_KEY=your-n8n-api-key
|
||||
|
||||
# Webhook
|
||||
WEBHOOK_URL=https://n8n.momentry.ddns.net/webhook/alerts
|
||||
WEBHOOK_SECRET=your-secret
|
||||
WEBHOOK_EVENTS=anomaly_detected,key_expired,key_revoked
|
||||
```
|
||||
|
||||
### C. 相關文件
|
||||
|
||||
| 文件 | 說明 |
|
||||
|------|------|
|
||||
| [API_INDEX.md](./API_INDEX.md) | 文件總覽(起點) |
|
||||
| [API_N8N_GUIDE.md](./API_N8N_GUIDE.md) | n8n 快速使用指南 |
|
||||
| `docs/API_KEY_MANAGEMENT.md` | API Key 管理系統設計 |
|
||||
| `docs/API_KEY_ARCHITECTURE.md` | 系統架構圖 |
|
||||
| `docs/API_KEY_INTEGRATION_TESTS.md` | 整合測試文件 |
|
||||
@@ -1,227 +0,0 @@
|
||||
# OpenCode n8n MCP 整合設定
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-23 |
|
||||
| 文件版本 | V1.0 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-23 | 創建 n8n MCP 整合設定文件 | Warren | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
> 建立時間: 2026-03-23
|
||||
> 更新時間: 2026-03-23
|
||||
|
||||
---
|
||||
|
||||
## n8n MCP 工具列表 (43 個)
|
||||
|
||||
### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_workflows` | 列出所有 workflows |
|
||||
| `n8n_get_workflow` | 取得 workflow 詳情 |
|
||||
| `n8n_create_workflow` | 建立新 workflow |
|
||||
| `n8n_update_workflow` | 更新 workflow |
|
||||
| `n8n_delete_workflow` | 刪除 workflow |
|
||||
| `n8n_activate_workflow` | 啟用 workflow |
|
||||
| `n8n_deactivate_workflow` | 停用 workflow |
|
||||
| `n8n_execute_workflow` | 執行 workflow |
|
||||
| `n8n_get_workflow_tags` | 取得 workflow 標籤 |
|
||||
| `n8n_update_workflow_tags` | 更新 workflow 標籤 |
|
||||
|
||||
### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_executions` | 列出執行記錄 |
|
||||
| `n8n_get_execution` | 取得執行詳情 |
|
||||
| `n8n_delete_execution` | 刪除執行記錄 |
|
||||
|
||||
### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_datatables` | 列出資料表 |
|
||||
| `n8n_create_datatable` | 建立資料表 |
|
||||
| `n8n_get_datatable` | 取得資料表結構 |
|
||||
| `n8n_get_datatable_rows` | 取得資料表列 |
|
||||
| `n8n_insert_datatable_rows` | 插入資料列 |
|
||||
| `n8n_update_datatable_rows` | 更新資料列 |
|
||||
| `n8n_upsert_datatable_row` | 插入或更新資料列 |
|
||||
| `n8n_delete_datatable_rows` | 刪除資料列 |
|
||||
|
||||
### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_tags` | 列出所有標籤 |
|
||||
| `n8n_get_tag` | 取得標籤 |
|
||||
| `n8n_create_tag` | 建立標籤 |
|
||||
| `n8n_update_tag` | 更新標籤 |
|
||||
| `n8n_delete_tag` | 刪除標籤 |
|
||||
|
||||
### Credentials (4)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_credentials` | 列出憑證 |
|
||||
| `n8n_create_credential` | 建立憑證 |
|
||||
| `n8n_delete_credential` | 刪除憑證 |
|
||||
| `n8n_get_credential_schema` | 取得憑證 schema |
|
||||
|
||||
### Users (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_users` | 列出使用者 |
|
||||
| `n8n_get_user` | 取得使用者 |
|
||||
| `n8n_delete_user` | 刪除使用者 |
|
||||
|
||||
### Variables (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_variables` | 列出變數 |
|
||||
| `n8n_create_variable` | 建立變數 |
|
||||
| `n8n_delete_variable` | 刪除變數 |
|
||||
|
||||
### 其他 (7)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_projects` | 列出專案 |
|
||||
| `n8n_create_project` | 建立專案 |
|
||||
| `n8n_update_project` | 更新專案 |
|
||||
| `n8n_delete_project` | 刪除專案 |
|
||||
| `n8n_generate_audit` | 產生安全審計報告 |
|
||||
| `n8n_health_check` | 健康檢查 |
|
||||
| `n8n_trigger_webhook` | 觸發 webhook |
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### 1. 安裝 n8n MCP Server
|
||||
|
||||
```bash
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
```
|
||||
|
||||
驗證:
|
||||
```bash
|
||||
which mcp-n8n
|
||||
# /opt/homebrew/bin/mcp-n8n
|
||||
```
|
||||
|
||||
### 2. 取得 n8n API Key
|
||||
|
||||
1. 開啟 n8n UI: `http://localhost:5678`
|
||||
2. 登入後點擊右上角 **Settings** → **API**
|
||||
3. 點擊 **Create New API Key**
|
||||
4. 複製產生的 key
|
||||
|
||||
### 3. 設定 OpenCode MCP 設定檔
|
||||
|
||||
建立或編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 驗證 MCP 運作
|
||||
|
||||
重啟 OpenCode,確認 n8n MCP tools 可用。
|
||||
|
||||
---
|
||||
|
||||
## n8n API 端點
|
||||
|
||||
n8n v2 REST API 路徑為 `/rest/`(不是 `/api/v1/`)
|
||||
|
||||
| 端點 | 方法 | 說明 |
|
||||
|------|------|------|
|
||||
| `/rest/workflows` | GET | 列出 workflows |
|
||||
| `/rest/workflows/:id` | GET | 取得 workflow |
|
||||
| `/rest/workflows` | POST | 建立 workflow |
|
||||
| `/rest/workflows/:id` | PUT | 更新 workflow |
|
||||
| `/rest/workflows/:id` | DELETE | 刪除 workflow |
|
||||
| `/rest/workflows/:id/activate` | POST | 啟用 workflow |
|
||||
| `/rest/workflows/:id/deactivate` | POST | 停用 workflow |
|
||||
| `/rest/workflows/:id/execute` | POST | 執行 workflow |
|
||||
|
||||
**認證方式:**
|
||||
```bash
|
||||
curl -H "X-N8N-API-KEY: YOUR_API_KEY" \
|
||||
http://localhost:5678/rest/workflows
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 疑難排解
|
||||
|
||||
### API 404 問題
|
||||
|
||||
如果 API 傳回 404,檢查:
|
||||
|
||||
1. **n8n 是否運行中**
|
||||
```bash
|
||||
curl http://localhost:5678
|
||||
```
|
||||
|
||||
2. **n8n 初始設定(重要!)**
|
||||
- 第一次使用必須在瀏覽器完成初始化
|
||||
- 開啟 `http://localhost:5678`
|
||||
- 按照畫面指示建立管理員帳號
|
||||
- 完成後才能使用 API
|
||||
|
||||
3. **API Key 是否正確**
|
||||
```bash
|
||||
curl -H "X-N8N-API-KEY: YOUR_KEY" \
|
||||
http://localhost:5678/rest/workflows
|
||||
```
|
||||
|
||||
### n8n 初始設定(第一次使用)
|
||||
|
||||
1. 開啟瀏覽器: `http://localhost:5678`
|
||||
2. 輸入 email 和密碼建立管理員帳號
|
||||
3. 完成後進入 Settings → API
|
||||
4. 建立 API Key 並複製
|
||||
|
||||
### CLI Import vs PostgreSQL
|
||||
|
||||
n8n 使用 PostgreSQL 儲存資料:
|
||||
- CLI `n8n import:workflow` 可能寫入 SQLite
|
||||
- 手動在 UI import 會寫入 PostgreSQL
|
||||
|
||||
建議直接使用 UI 或 MCP import。
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OPENCODE_GUIDE.md](./OPENCODE_GUIDE.md) - OpenCode 使用規範
|
||||
- [INSTALL_N8N.md](./INSTALL_N8N.md) - n8n 安裝指南
|
||||
- [N8N_DEMO_WORKFLOW.md](./N8N_DEMO_WORKFLOW.md) - n8n Workflow 範例
|
||||
@@ -1,152 +0,0 @@
|
||||
# Momentry Video RAG - n8n 工作流程設定完成
|
||||
|
||||
## ✅ 最終成功版本
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| **工作流程名稱** | Video Search - Working v3 |
|
||||
| **ID** | 4vQo8I4SXEaR5E1A |
|
||||
| **狀態** | ✅ SUCCESS |
|
||||
| **執行 ID** | 1620 |
|
||||
|
||||
---
|
||||
|
||||
## 成功關鍵
|
||||
|
||||
### HTTP Request Node 正確設定
|
||||
```json
|
||||
{
|
||||
"url": "https://api.momentry.ddns.net/api/v1/n8n/search",
|
||||
"method": "POST",
|
||||
"sendBody": true,
|
||||
"specifyBody": "json",
|
||||
"jsonBody": "{\"query\":\"charade\",\"limit\":3}",
|
||||
"options": {}
|
||||
}
|
||||
```
|
||||
|
||||
**重點**:
|
||||
- ✅ `specifyBody`: "json" (不是 "body")
|
||||
- ✅ `jsonBody`: 字串格式 (不是物件)
|
||||
- ✅ 使用 `"{\"query\":\"..."}` 轉義引號
|
||||
|
||||
---
|
||||
|
||||
## 所有可用工作流程
|
||||
|
||||
| 工作流程 | ID | 狀態 | 說明 |
|
||||
|---------|-----|------|------|
|
||||
| Video Search - Working v3 | 4vQo8I4SXEaR5E1A | ✅ 成功 | **推薦使用** |
|
||||
| Video Search - HTTP Only | tZbljQCFZDOJ4C0s | ❌ 失敗 | body 格式錯誤 |
|
||||
| Video Search - Debug Simple | e2CMjonwILMUYjp0 | ⚠️ 待測 | Code Node 版本 |
|
||||
| Video Search - Instant | zC5K3TbFzWGAh0la | ❌ 失敗 | `$httpRequest` 不可用 |
|
||||
|
||||
---
|
||||
|
||||
## 如何使用
|
||||
|
||||
### 方法 1: 直接執行
|
||||
```bash
|
||||
# 開啟工作流程
|
||||
open https://n8n.momentry.ddns.net/workflow/4vQo8I4SXEaR5E1A
|
||||
```
|
||||
|
||||
然後:
|
||||
1. 點擊 **"Execute Workflow"** ▶️
|
||||
2. 點擊 **"Show Result"** 節點
|
||||
3. 查看 JSON 結果
|
||||
|
||||
### 方法 2: 修改搜尋關鍵字
|
||||
1. 點擊 **"Search API"** 節點
|
||||
2. 修改 `jsonBody`:
|
||||
```json
|
||||
"{\"query\":\"您的關鍵字\",\"limit\":5}"
|
||||
```
|
||||
3. 儲存並重新執行
|
||||
|
||||
---
|
||||
|
||||
## API 端點
|
||||
|
||||
### Momentry Core API
|
||||
```
|
||||
POST https://api.momentry.ddns.net/api/v1/n8n/search
|
||||
Content-Type: application/json
|
||||
|
||||
Body:
|
||||
{
|
||||
"query": "charade",
|
||||
"limit": 3,
|
||||
"uuid": "可選的影片UUID"
|
||||
}
|
||||
```
|
||||
|
||||
### 直接測試
|
||||
```bash
|
||||
curl -X POST https://api.momentry.ddns.net/api/v1/n8n/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query":"charade","limit":3}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 已建立的文件
|
||||
|
||||
| 文件 | 路徑 | 內容 |
|
||||
|------|------|------|
|
||||
| API URL 範例 | `docs/API_URL_EXAMPLES.md` | 完整 URL 和 curl 指令 |
|
||||
| HTTP Request 指南 | `docs/N8N_HTTP_REQUEST_GUIDE.md` | Node 設定說明 |
|
||||
| 輸出查看指南 | `docs/N8N_VIEW_OUTPUT_GUIDE.md` | 如何查看結果 |
|
||||
| MCP 測試報告 | `docs/N8N_MCP_TEST_REPORT.md` | 43 個 MCP 工具 |
|
||||
| API 修復總結 | `docs/N8N_API_FIX_SUMMARY.md` | 問題修復過程 |
|
||||
| 工作流程 JSON | `docs/n8n_workflow_video_rag_mcp.json` | 原始工作流程 |
|
||||
| 測試腳本 | `docs/test_all.sh` | 自動測試腳本 |
|
||||
|
||||
---
|
||||
|
||||
## 服務狀態
|
||||
|
||||
✅ **Momentry Core**: https://api.momentry.ddns.net (Port 3002)
|
||||
✅ **n8n**: https://n8n.momentry.ddns.net (Port 5678)
|
||||
✅ **MCP 整合**: 43 個工具可用
|
||||
|
||||
---
|
||||
|
||||
## 下一步建議
|
||||
|
||||
### 1. 建立帶有參數的工作流程
|
||||
修改現有工作流程,讓 query 和 limit 可以動態輸入:
|
||||
- 添加 Webhook Node 接收外部請求
|
||||
- 或使用 Set Node 設定變數
|
||||
|
||||
### 2. 建立完整的 RAG 流程
|
||||
結合 OpenAI:
|
||||
- 搜尋影片片段
|
||||
- 使用 GPT 生成回答
|
||||
- 回傳格式化的 RAG 結果
|
||||
|
||||
### 3. 自動化監控
|
||||
- 建立定時執行的工作流程
|
||||
- 監控 API 健康狀態
|
||||
- 發送 Telegram/Email 通知
|
||||
|
||||
---
|
||||
|
||||
## 問題排除
|
||||
|
||||
如果再次遇到 "Your request is invalid":
|
||||
1. 檢查 `specifyBody` 必須設為 `"json"`
|
||||
2. `jsonBody` 必須是字串格式,不是物件
|
||||
3. 確保使用正確的 JSON 轉義: `{\"key\":\"value\"}`
|
||||
|
||||
---
|
||||
|
||||
## 完成!🎉
|
||||
|
||||
所有設定已完成:
|
||||
- ✅ n8n REST API 修復並運作正常
|
||||
- ✅ MCP 整合完成 (43 個工具)
|
||||
- ✅ Momentry Core API 可外部存取
|
||||
- ✅ 成功的工作流程已創建並測試
|
||||
|
||||
您可以開始使用 n8n 自動化管理 Momentry Core 了!
|
||||
@@ -1,141 +0,0 @@
|
||||
# n8n 工作流程輸出查看指南
|
||||
|
||||
## 問題:"Node executed successfully but no output data"
|
||||
|
||||
這是正常的!在 n8n 中,你需要**點擊節點**才能看到輸出資料。
|
||||
|
||||
---
|
||||
|
||||
## 如何查看輸出資料
|
||||
|
||||
### 方法 1: 點擊節點查看
|
||||
|
||||
1. 執行工作流程後(點擊 Execute Workflow)
|
||||
2. **點擊任何一個節點**(Node)
|
||||
3. 在右側面板會顯示該節點的輸出
|
||||
4. 查看 **JSON** 分頁看到完整資料
|
||||
|
||||
### 方法 2: 查看執行記錄
|
||||
|
||||
1. 執行工作流程
|
||||
2. 點擊左側的 **"Executions"** 選單
|
||||
3. 找到最近的執行記錄
|
||||
4. 點擊展開查看每個節點的輸出
|
||||
|
||||
### 方法 3: 使用 Respond to Webhook
|
||||
|
||||
如果你想直接看到結果,添加一個 Respond to Webhook 節點:
|
||||
|
||||
```javascript
|
||||
// 在最後一個節點之後添加:
|
||||
Node: Respond to Webhook
|
||||
├── Response Mode: Last Node
|
||||
└── Response Body: {{ JSON.stringify($json) }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 新增的工作流程
|
||||
|
||||
### ✅ Video Search - Debug Simple
|
||||
- **ID**: e2CMjonwILMUYjp0
|
||||
- **URL**: https://n8n.momentry.ddns.net/workflow/e2CMjonwILMUYjp0
|
||||
|
||||
這個版本保證有輸出!
|
||||
|
||||
### 執行步驟
|
||||
|
||||
1. 開啟工作流程
|
||||
2. 點擊 **"Execute Workflow"** ▶️
|
||||
3. 等待執行完成(約 3-5 秒)
|
||||
4. **點擊最後一個節點** "Step 3 - Show Results"
|
||||
5. 查看右側的 **JSON** 分頁
|
||||
|
||||
### 預期看到的輸出
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "SUCCESS",
|
||||
"query": "charade",
|
||||
"totalResults": 2,
|
||||
"firstHit": {
|
||||
"text": "fun plot twists, Woody Dialog and charming perform...",
|
||||
"time": "48.8s - 55.44s",
|
||||
"score": "53%"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
或如果失敗:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "FAILED",
|
||||
"error": "error message here"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 截圖說明
|
||||
|
||||
### 執行後的畫面
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ When clicking "Execute Workflow" │ ✅ (綠色勾)
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 1 - Set Query │ ✅ (綠色勾)
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 2 - Call API │ ✅ (綠色勾) ← 點擊這裡
|
||||
├─────────────────────────────────────┤
|
||||
│ Step 3 - Show Results │ ✅ (綠色勾) ← 或這個
|
||||
└─────────────────────────────────────┘
|
||||
|
||||
[右側面板 - 點擊節點後顯示]
|
||||
┌─────────────────────────────────────┐
|
||||
│ Node: Step 2 - Call API │
|
||||
│ │
|
||||
│ [JSON] [Table] [Schema] │ ← 點擊 JSON
|
||||
│ │
|
||||
│ { │
|
||||
│ "success": true, │
|
||||
│ "query": "charade", │
|
||||
│ ... │
|
||||
│ } │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 快速測試
|
||||
|
||||
如果不想用瀏覽器,直接在這裡執行:
|
||||
|
||||
```bash
|
||||
# 開啟簡化版工作流程
|
||||
open https://n8n.momentry.ddns.net/workflow/e2CMjonwILMUYjp0
|
||||
```
|
||||
|
||||
然後:
|
||||
1. 點擊 **Execute Workflow**
|
||||
2. 點擊 **"Step 3 - Show Results"** 節點
|
||||
3. 看右側 JSON 面板
|
||||
|
||||
---
|
||||
|
||||
## 如果仍然看不到資料
|
||||
|
||||
檢查:
|
||||
1. ✅ 工作流程已儲存
|
||||
2. ✅ 點擊了正確的節點(有綠色勾的)
|
||||
3. ✅ 右側面板已展開(點擊 JSON 分頁)
|
||||
4. ✅ 沒有紅色錯誤訊息
|
||||
|
||||
---
|
||||
|
||||
## 聯絡支援
|
||||
|
||||
如果還是有問題,請告訴我:
|
||||
1. 你點擊的是哪個節點?
|
||||
2. 右側面板顯示什麼?
|
||||
3. 有沒有紅色錯誤訊息?
|
||||
@@ -1,430 +0,0 @@
|
||||
# OpenCode 使用規範
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-21 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-21 | 創建文件 | Warren |
|
||||
| V1.1 | 2026-03-21 | 新增 MCP 設定章節 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔定義使用 OpenCode 進行專案開發的最佳實踐,確保開發效率和程式碼品質。
|
||||
|
||||
---
|
||||
|
||||
## 任務管理
|
||||
|
||||
### 任務批次策略
|
||||
|
||||
**原則**: 一次處理 1-2 個功能,完成後驗證,再繼續下一個。
|
||||
|
||||
| 批次大小 | 適用場景 | 說明 |
|
||||
|----------|----------|------|
|
||||
| 1 個 | 緊急修復、簡單任務 | 快速完成 |
|
||||
| 2-3 個 | 一般功能開發 | 平衡效率與品質 |
|
||||
| 3+ 個 | 大型重構 | 需要更詳細的追蹤 |
|
||||
|
||||
### 驗證流程
|
||||
|
||||
每個任務完成後必須執行:
|
||||
|
||||
```bash
|
||||
# 1. 編譯檢查
|
||||
cargo check
|
||||
|
||||
# 2. Lint 檢查
|
||||
cargo clippy --lib
|
||||
|
||||
# 3. 單元測試
|
||||
cargo test --lib
|
||||
|
||||
# 4. 格式化檢查
|
||||
cargo fmt -- --check
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 溝通模式
|
||||
|
||||
### 有效的任務描述
|
||||
|
||||
**建議格式**:
|
||||
```
|
||||
執行 [功能名稱]
|
||||
- 優先級: 高/中/低
|
||||
- 驗收標準: [明確的標準]
|
||||
- 約束: [限制條件]
|
||||
```
|
||||
|
||||
**範例**:
|
||||
```
|
||||
實作 monitor_jobs 表
|
||||
- 優先級: 高
|
||||
- 驗收標準: CRUD 操作可用,單元測試通過
|
||||
- 約束: 使用現有架構
|
||||
```
|
||||
|
||||
### 明確的暫停點
|
||||
|
||||
在每個階段完成後主動詢問:
|
||||
|
||||
```
|
||||
[任務] 完成。要繼續:
|
||||
1. 實作功能 A
|
||||
2. 添加測試
|
||||
3. 更新文檔
|
||||
```
|
||||
|
||||
### 不建議的溝通
|
||||
|
||||
| 模式 | 問題 | 建議 |
|
||||
|------|------|------|
|
||||
| 一次指定太多項目 | 增加複雜度,難以追蹤 | 分批處理 |
|
||||
| 模糊的任務描述 | 難以評估進度 | 使用明確的驗收標準 |
|
||||
| 從不驗證 | 累積問題 | 每步驟完成後驗證 |
|
||||
|
||||
---
|
||||
|
||||
## 決策點
|
||||
|
||||
### 常見決策點
|
||||
|
||||
| 階段 | 問題 | 選項 |
|
||||
|------|------|------|
|
||||
| 開始 | 如何開始? | 先了解現況 / 直接實作 |
|
||||
| 實作 | 實作方式? | 保持現有架構 / 重構 |
|
||||
| 驗證 | 通過了嗎? | 繼續 / 修復問題 |
|
||||
| 完成 | 還有什麼? | 下一個任務 / 結束 |
|
||||
|
||||
### 決策準則
|
||||
|
||||
1. **安全優先**: 破壞性變更需要明確確認
|
||||
2. **驗證後繼續**: 每步驟完成後驗證
|
||||
3. **文檔同步**: 變更後更新文檔
|
||||
|
||||
---
|
||||
|
||||
## 文檔使用
|
||||
|
||||
### 必讀文檔
|
||||
|
||||
| 文檔 | 用途 | 查閱時機 |
|
||||
|------|------|----------|
|
||||
| `AGENTS.md` | 專案規範 | 每次對話開始 |
|
||||
| `docs/*.md` | 技術規格 | 功能實作前 |
|
||||
|
||||
### 文檔更新時機
|
||||
|
||||
| 變更類型 | 需要更新 |
|
||||
|----------|----------|
|
||||
| 新功能 | `AGENTS.md` + 相關技術文檔 |
|
||||
| 架構變更 | `ARCHITECTURE_EVALUATION.md` |
|
||||
| 問題修復 | `PENDING_ISSUES.md` |
|
||||
| 環境變更 | `INSTALL_*.md` |
|
||||
|
||||
---
|
||||
|
||||
## 審查清單
|
||||
|
||||
### 實作完成後檢查
|
||||
|
||||
- [ ] `cargo clippy --lib` 通過
|
||||
- [ ] `cargo test --lib` 通過
|
||||
- [ ] `cargo fmt -- --check` 通過
|
||||
- [ ] 文檔已更新
|
||||
- [ ] 新功能有單元測試
|
||||
- [ ] Pre-commit hook 通過
|
||||
|
||||
### 對話結束前
|
||||
|
||||
- [ ] 所有變更已驗證
|
||||
- [ ] 文檔已同步
|
||||
- [ ] 下一步計劃明確
|
||||
|
||||
---
|
||||
|
||||
## 範例流程
|
||||
|
||||
### 範例 1: 實作新功能
|
||||
|
||||
```
|
||||
用戶: 實作使用者認證功能
|
||||
|
||||
OpenCode:
|
||||
1. 分析現有架構
|
||||
2. 創建任務清單
|
||||
3. 實作核心功能
|
||||
4. 添加單元測試
|
||||
5. 更新文檔
|
||||
6. 驗證通過
|
||||
|
||||
用戶: 完成,繼續下一個
|
||||
```
|
||||
|
||||
### 範例 2: 修復問題
|
||||
|
||||
```
|
||||
用戶: 修復登入超時問題
|
||||
|
||||
OpenCode:
|
||||
1. 重現問題
|
||||
2. 分析根因
|
||||
3. 實作修復
|
||||
4. 驗證修復
|
||||
5. 添加測試防止回歸
|
||||
|
||||
用戶: 確認修復完成
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常見問題
|
||||
|
||||
### Q: 如何避免一次處理太多?
|
||||
|
||||
**A**: 使用 `/todo` 追蹤任務,分批處理。
|
||||
|
||||
### Q: 如何確保文檔同步?
|
||||
|
||||
**A**: 每個任務完成後檢查是否需要更新文檔。
|
||||
|
||||
### Q: 何時應該結束對話?
|
||||
|
||||
**A**: 當主要任務完成,且沒有緊急的後續步驟時。
|
||||
|
||||
---
|
||||
|
||||
## MCP 設定
|
||||
|
||||
### 設定檔案
|
||||
|
||||
OpenCode MCP 設定位於 `~/.config/opencode/opencode.json`
|
||||
|
||||
### 已啟用的 MCP Servers
|
||||
|
||||
| Server | 用途 | 命令 |
|
||||
|--------|------|------|
|
||||
| gitea | Gitea API 操作 | `/opt/homebrew/bin/gitea-mcp-server` |
|
||||
| n8n | n8n Workflow 操作 | `/opt/homebrew/bin/mcp-n8n` |
|
||||
| postgres | PostgreSQL 資料庫查詢 | `/opt/homebrew/bin/mcp-server-postgres` |
|
||||
| redis | Redis 快取操作 | `/opt/homebrew/bin/mcp-server-redis` |
|
||||
| qdrant | Qdrant 向量搜尋 | `/opt/homebrew/bin/mcp-server-qdrant` |
|
||||
| filesystem | 檔案系統操作 | `/opt/homebrew/bin/mcp-server-filesystem` |
|
||||
|
||||
### MCP 設定格式
|
||||
|
||||
**Schema 參考**: `https://opencode.ai/config.json`
|
||||
|
||||
**必要欄位**:
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `type` | string | `"local"` 或 `"remote"` |
|
||||
| `command` | array | 命令和參數(local 必要) |
|
||||
| `url` | string | 遠端 URL(remote 必要) |
|
||||
|
||||
**可選欄位**:
|
||||
| 欄位 | 類型 | 說明 |
|
||||
|------|------|------|
|
||||
| `environment` | object | 環境變數(local only) |
|
||||
| `enabled` | boolean | 是否啟用 |
|
||||
| `timeout` | number | 請求超時(毫秒) |
|
||||
| `headers` | object | 請求頭(remote only) |
|
||||
|
||||
**Local MCP 範例**:
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token", "<GITEA_TOKEN>",
|
||||
"-host", "http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
},
|
||||
"postgres": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-postgres"],
|
||||
"environment": {
|
||||
"DATABASE_URL": "postgresql://accusys:accusys@localhost:5432/momentry"
|
||||
}
|
||||
},
|
||||
"redis": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-redis"],
|
||||
"environment": {
|
||||
"REDIS_URL": "redis://:accusys@localhost:6379"
|
||||
}
|
||||
},
|
||||
"qdrant": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-qdrant"],
|
||||
"environment": {
|
||||
"QDRANT_URL": "http://localhost:6333",
|
||||
"QDRANT_API_KEY": ""
|
||||
}
|
||||
},
|
||||
"filesystem": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-filesystem"],
|
||||
"args": ["/Users/accusys/momentry"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Remote MCP 範例**:
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"jira": {
|
||||
"type": "remote",
|
||||
"url": "https://jira.example.com/mcp",
|
||||
"enabled": true,
|
||||
"headers": {
|
||||
"Authorization": "Bearer your-token"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### n8n MCP 工具 (43 個)
|
||||
|
||||
#### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_workflows` | 列出所有 workflows |
|
||||
| `n8n_get_workflow` | 取得 workflow 詳情 |
|
||||
| `n8n_create_workflow` | 建立新 workflow |
|
||||
| `n8n_update_workflow` | 更新 workflow |
|
||||
| `n8n_delete_workflow` | 刪除 workflow |
|
||||
| `n8n_activate_workflow` | 啟用 workflow |
|
||||
| `n8n_deactivate_workflow` | 停用 workflow |
|
||||
| `n8n_execute_workflow` | 執行 workflow |
|
||||
| `n8n_get_workflow_tags` | 取得 workflow 標籤 |
|
||||
| `n8n_update_workflow_tags` | 更新 workflow 標籤 |
|
||||
|
||||
#### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_executions` | 列出執行記錄 |
|
||||
| `n8n_get_execution` | 取得執行詳情 |
|
||||
| `n8n_delete_execution` | 刪除執行記錄 |
|
||||
|
||||
#### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_datatables` | 列出資料表 |
|
||||
| `n8n_create_datatable` | 建立資料表 |
|
||||
| `n8n_get_datatable` | 取得資料表結構 |
|
||||
| `n8n_get_datatable_rows` | 取得資料表列 |
|
||||
| `n8n_insert_datatable_rows` | 插入資料列 |
|
||||
| `n8n_update_datatable_rows` | 更新資料列 |
|
||||
| `n8n_upsert_datatable_row` | 插入或更新資料列 |
|
||||
| `n8n_delete_datatable_rows` | 刪除資料列 |
|
||||
|
||||
#### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_tags` | 列出所有標籤 |
|
||||
| `n8n_get_tag` | 取得標籤 |
|
||||
| `n8n_create_tag` | 建立標籤 |
|
||||
| `n8n_update_tag` | 更新標籤 |
|
||||
| `n8n_delete_tag` | 刪除標籤 |
|
||||
|
||||
#### Credentials (4)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_credentials` | 列出憑證 |
|
||||
| `n8n_create_credential` | 建立憑證 |
|
||||
| `n8n_delete_credential` | 刪除憑證 |
|
||||
| `n8n_get_credential_schema` | 取得憑證 schema |
|
||||
|
||||
#### Users (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_users` | 列出使用者 |
|
||||
| `n8n_get_user` | 取得使用者 |
|
||||
| `n8n_delete_user` | 刪除使用者 |
|
||||
|
||||
#### Variables (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_variables` | 列出變數 |
|
||||
| `n8n_create_variable` | 建立變數 |
|
||||
| `n8n_delete_variable` | 刪除變數 |
|
||||
|
||||
#### 其他 (7)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| `n8n_list_projects` | 列出專案 |
|
||||
| `n8n_create_project` | 建立專案 |
|
||||
| `n8n_update_project` | 更新專案 |
|
||||
| `n8n_delete_project` | 刪除專案 |
|
||||
| `n8n_generate_audit` | 產生安全審計報告 |
|
||||
| `n8n_health_check` | 健康檢查 |
|
||||
| `n8n_trigger_webhook` | 觸發 webhook |
|
||||
|
||||
### 安裝 n8n MCP
|
||||
|
||||
```bash
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
```
|
||||
|
||||
### n8n API Key 設定
|
||||
|
||||
1. 開啟 n8n UI (http://localhost:5678)
|
||||
2. 前往 Settings → API
|
||||
3. 建立 API Key
|
||||
4. 將 API Key 加入 `opencode.json` 的 `N8N_API_KEY`
|
||||
|
||||
### 驗證 MCP 運作
|
||||
|
||||
```bash
|
||||
# 測試 MCP server
|
||||
N8N_BASE_URL=https://n8n.momentry.ddns.net \
|
||||
N8N_API_KEY="your-key" \
|
||||
mcp-n8n
|
||||
|
||||
# 測試工具列表
|
||||
echo '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0"}}}
|
||||
{"jsonrpc": "2.0", "id": 2, "method": "tools/list", "params": {}}' | \
|
||||
N8N_BASE_URL=https://n8n.momentry.ddns.net \
|
||||
N8N_API_KEY="your-key" \
|
||||
mcp-n8n
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [AGENTS.md](../AGENTS.md) - 專案開發規範
|
||||
- [ARCHITECTURE_EVALUATION.md](./ARCHITECTURE_EVALUATION.md) - 架構優化評估
|
||||
- [PENDING_ISSUES.md](./PENDING_ISSUES.md) - 待解決問題追蹤
|
||||
- [INSTALL_N8N.md](./INSTALL_N8N.md) - n8n 安裝指南
|
||||
@@ -1,535 +0,0 @@
|
||||
# OpenCode MCP Servers 安裝指南
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | OpenCode |
|
||||
| 建立時間 | 2026-03-24 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-24 | 創建文件 | OpenCode | OpenCode / big-pickle |
|
||||
| V1.1 | 2026-03-24 | 新增 sentry, context7, playwright MCP | OpenCode | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔說明如何在 macOS 上為 OpenCode 安裝和配置 MCP (Model Context Protocol) Servers,透過標準化的協定讓 AI 助手能夠存取各種外部服務和工具。
|
||||
|
||||
MCP Servers 提供:
|
||||
- 標準化的工具調用介面
|
||||
- 安全的資源存取控制
|
||||
- 統一的配置和管理方式
|
||||
|
||||
---
|
||||
|
||||
## 已安裝的 MCP Servers
|
||||
|
||||
| Server | 安裝方式 | 用途 | 狀態 |
|
||||
|--------|----------|------|------|
|
||||
| gitea | Homebrew | Gitea API 操作 | ✅ |
|
||||
| n8n | NPM (@nextoolsolutions/mcp-n8n) | n8n Workflow 管理 | ✅ |
|
||||
| postgres | NPM (@modelcontextprotocol/server-postgres) | PostgreSQL 資料庫查詢 | ✅ |
|
||||
| redis | NPM (@modelcontextprotocol/server-redis) | Redis 快取操作 | ✅ |
|
||||
| mongodb | NPM (mongodb-mcp-server) | MongoDB 文件資料庫 | ✅ |
|
||||
| qdrant | Python (qdrant/mcp-server-qdrant) | Qdrant 向量搜尋 | ✅ |
|
||||
| filesystem | NPM (@modelcontextprotocol/server-filesystem) | 檔案系統操作 | ✅ |
|
||||
| sentry | NPM (@sentry/mcp-server) | 錯誤追蹤和監控 | ⏳ |
|
||||
| context7 | NPM (@upstash/context7-mcp) | 技術文檔搜尋 | ✅ |
|
||||
| playwright | NPM (@playwright/mcp) | 瀏覽器自動化 | ✅ |
|
||||
|
||||
---
|
||||
|
||||
## 前置條件
|
||||
|
||||
- OpenCode 已安裝
|
||||
- Node.js (用於 NPM 套件)
|
||||
- Python 3.11+ (用於 qdrant-mcp)
|
||||
- 相關服務已運行 (PostgreSQL, Redis, Qdrant, Gitea, n8n, MongoDB)
|
||||
|
||||
---
|
||||
|
||||
## 安裝步驟
|
||||
|
||||
### Step 1: 安裝 NPM MCP Servers
|
||||
|
||||
```bash
|
||||
npm install -g @modelcontextprotocol/server-postgres
|
||||
npm install -g @modelcontextprotocol/server-redis
|
||||
npm install -g @modelcontextprotocol/server-filesystem
|
||||
npm install -g @modelcontextprotocol/server-everything
|
||||
npm install -g @nextoolsolutions/mcp-n8n
|
||||
npm install -g mongodb-mcp-server
|
||||
npm install -g @sentry/mcp-server
|
||||
npm install -g @upstash/context7-mcp
|
||||
npm install -g @playwright/mcp
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which mcp-server-postgres
|
||||
which mcp-server-redis
|
||||
which mcp-server-filesystem
|
||||
which mcp-n8n
|
||||
which mongodb-mcp-server
|
||||
which sentry-mcp
|
||||
which context7-mcp
|
||||
which playwright-mcp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 2: 安裝 gitea-mcp-server
|
||||
|
||||
```bash
|
||||
brew install gitea-mcp-server
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which gitea-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: 安裝 MongoDB MCP Server (已包含在 Step 1)
|
||||
|
||||
MongoDB MCP 已透過 NPM 安裝:
|
||||
|
||||
```bash
|
||||
npm install -g mongodb-mcp-server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 4: 安裝 Qdrant MCP Server (Python)
|
||||
|
||||
```bash
|
||||
cd /tmp
|
||||
git clone https://github.com/qdrant/mcp-server-qdrant.git
|
||||
cd mcp-server-qdrant
|
||||
/opt/homebrew/bin/python3.11 -m pip install -e .
|
||||
```
|
||||
|
||||
**驗證**:
|
||||
|
||||
```bash
|
||||
which mcp-server-qdrant
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 5: 配置 OpenCode MCP 設定
|
||||
|
||||
編輯 `~/.config/opencode/opencode.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"gitea": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/gitea-mcp-server",
|
||||
"-token",
|
||||
"<GITEA_TOKEN>",
|
||||
"-host",
|
||||
"http://localhost:3000"
|
||||
]
|
||||
},
|
||||
"n8n": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-n8n"],
|
||||
"environment": {
|
||||
"N8N_BASE_URL": "http://localhost:5678",
|
||||
"N8N_API_KEY": "<N8N_API_KEY>"
|
||||
}
|
||||
},
|
||||
"postgres": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-postgres",
|
||||
"postgresql://accusys:accusys@localhost:5432/momentry"
|
||||
]
|
||||
},
|
||||
"redis": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-redis",
|
||||
"redis://:accusys@localhost:6379"
|
||||
]
|
||||
},
|
||||
"mongodb": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mongodb-mcp-server"],
|
||||
"environment": {
|
||||
"MONGODB_URI": "mongodb://localhost:27017"
|
||||
}
|
||||
},
|
||||
"qdrant": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/mcp-server-qdrant"],
|
||||
"environment": {
|
||||
"QDRANT_URL": "http://localhost:6333",
|
||||
"QDRANT_API_KEY": ""
|
||||
}
|
||||
},
|
||||
"filesystem": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/mcp-server-filesystem",
|
||||
"/Users/accusys/momentry"
|
||||
]
|
||||
},
|
||||
"sentry": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": [
|
||||
"/opt/homebrew/bin/sentry-mcp",
|
||||
"--access-token",
|
||||
"<SENTRY_ACCESS_TOKEN>"
|
||||
]
|
||||
},
|
||||
"context7": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/context7-mcp"]
|
||||
},
|
||||
"playwright": {
|
||||
"type": "local",
|
||||
"enabled": true,
|
||||
"command": ["/opt/homebrew/bin/playwright-mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 6: 驗證 MCP Servers
|
||||
|
||||
```bash
|
||||
# 列出所有 MCP servers
|
||||
opencode mcp ls
|
||||
|
||||
# 或在 OpenCode 中執行
|
||||
/mcps
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## MCP Server 工具說明
|
||||
|
||||
### gitea
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| list_repos | 列出倉庫 |
|
||||
| get_repo | 取得倉庫詳情 |
|
||||
| list_issues | 列出 Issues |
|
||||
| create_issue | 建立 Issue |
|
||||
| list_pulls | 列出 Pull Requests |
|
||||
|
||||
---
|
||||
|
||||
### n8n (43 個工具)
|
||||
|
||||
#### Workflows (10)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_workflows | 列出所有 workflows |
|
||||
| n8n_get_workflow | 取得 workflow 詳情 |
|
||||
| n8n_create_workflow | 建立新 workflow |
|
||||
| n8n_update_workflow | 更新 workflow |
|
||||
| n8n_delete_workflow | 刪除 workflow |
|
||||
| n8n_activate_workflow | 啟用 workflow |
|
||||
| n8n_deactivate_workflow | 停用 workflow |
|
||||
| n8n_execute_workflow | 執行 workflow |
|
||||
| n8n_get_workflow_tags | 取得 workflow 標籤 |
|
||||
| n8n_update_workflow_tags | 更新 workflow 標籤 |
|
||||
|
||||
#### Executions (3)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_executions | 列出執行記錄 |
|
||||
| n8n_get_execution | 取得執行詳情 |
|
||||
| n8n_delete_execution | 刪除執行記錄 |
|
||||
|
||||
#### Data Tables (8)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_datatables | 列出資料表 |
|
||||
| n8n_create_datatable | 建立資料表 |
|
||||
| n8n_get_datatable | 取得資料表結構 |
|
||||
| n8n_get_datatable_rows | 取得資料表列 |
|
||||
| n8n_insert_datatable_rows | 插入資料列 |
|
||||
| n8n_update_datatable_rows | 更新資料列 |
|
||||
| n8n_upsert_datatable_row | 插入或更新資料列 |
|
||||
| n8n_delete_datatable_rows | 刪除資料列 |
|
||||
|
||||
#### Tags (5)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_tags | 列出所有標籤 |
|
||||
| n8n_get_tag | 取得標籤 |
|
||||
| n8n_create_tag | 建立標籤 |
|
||||
| n8n_update_tag | 更新標籤 |
|
||||
| n8n_delete_tag | 刪除標籤 |
|
||||
|
||||
#### 其他 (17)
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| n8n_list_credentials | 列出憑證 |
|
||||
| n8n_create_credential | 建立憑證 |
|
||||
| n8n_delete_credential | 刪除憑證 |
|
||||
| n8n_get_credential_schema | 取得憑證 schema |
|
||||
| n8n_list_users | 列出使用者 |
|
||||
| n8n_get_user | 取得使用者 |
|
||||
| n8n_delete_user | 刪除使用者 |
|
||||
| n8n_list_variables | 列出變數 |
|
||||
| n8n_create_variable | 建立變數 |
|
||||
| n8n_delete_variable | 刪除變數 |
|
||||
| n8n_list_projects | 列出專案 |
|
||||
| n8n_create_project | 建立專案 |
|
||||
| n8n_update_project | 更新專案 |
|
||||
| n8n_delete_project | 刪除專案 |
|
||||
| n8n_generate_audit | 產生安全審計報告 |
|
||||
| n8n_health_check | 健康檢查 |
|
||||
| n8n_trigger_webhook | 觸發 webhook |
|
||||
|
||||
---
|
||||
|
||||
### postgres
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| query | 執行唯讀 SQL 查詢 |
|
||||
|
||||
**範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"sql": "SELECT * FROM users LIMIT 10;"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### redis
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| set | 設定 key-value 配對 |
|
||||
| get | 取得 key 的值 |
|
||||
| delete | 刪除 key(s) |
|
||||
| list | 列出符合模式的 keys |
|
||||
|
||||
---
|
||||
|
||||
### mongodb
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| mongodb_list_databases | 列出所有資料庫 |
|
||||
| mongodb_list_collections | 列出資料庫中的集合 |
|
||||
| mongodb_find | 查詢文件 |
|
||||
| mongodb_insert_one | 插入單個文件 |
|
||||
| mongodb_insert_many | 插入多個文件 |
|
||||
| mongodb_update_one | 更新單個文件 |
|
||||
| mongodb_update_many | 更新多個文件 |
|
||||
| mongodb_delete_one | 刪除單個文件 |
|
||||
| mongodb_delete_many | 刪除多個文件 |
|
||||
| mongodb_aggregate | 聚合查詢 |
|
||||
|
||||
**範例**:
|
||||
|
||||
```json
|
||||
{
|
||||
"database": "momentry",
|
||||
"collection": "videos",
|
||||
"filter": {"uuid": "abc123"}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### qdrant
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| 查詢工具 | 向量搜尋和集合管理 |
|
||||
|
||||
---
|
||||
|
||||
### filesystem
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| read_file | 讀取檔案 |
|
||||
| write_file | 寫入檔案 |
|
||||
| list_directory | 列出目錄 |
|
||||
| create_directory | 建立目錄 |
|
||||
|
||||
---
|
||||
|
||||
### sentry
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| sentry_list_issues | 列出 issues |
|
||||
| sentry_get_issue | 取得 issue 詳情 |
|
||||
| sentry_create_issue | 建立 issue |
|
||||
| sentry_update_issue | 更新 issue |
|
||||
| sentry_list_projects | 列出專案 |
|
||||
| sentry_search_docs | 搜尋 Sentry 文件 |
|
||||
|
||||
**注意**: 需要設定 `SENTRY_ACCESS_TOKEN`
|
||||
|
||||
**取得 Token**:
|
||||
1. 登入 https://sentry.io
|
||||
2. Settings → Developer Tools → API Keys
|
||||
3. 建立新 Token (需要 `event:read`, `project:read` 權限)
|
||||
|
||||
---
|
||||
|
||||
### context7
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| context7_resolve-library-id | 解析函式庫 ID |
|
||||
| context7_query-docs | 查詢函式庫文件 |
|
||||
|
||||
**用途**: 即時技術文件和函式庫查詢,獲取最新的 API 語法和範例。
|
||||
|
||||
---
|
||||
|
||||
### playwright
|
||||
|
||||
| 工具 | 說明 |
|
||||
|------|------|
|
||||
| playwright_navigate | 導航到 URL |
|
||||
| playwright_screenshot | 截圖 |
|
||||
| playwright_click | 點擊元素 |
|
||||
| playwright_type | 輸入文字 |
|
||||
| playwright_evaluate | 執行 JavaScript |
|
||||
|
||||
**用途**: 瀏覽器自動化測試、網頁截圖、網頁內容抓取。
|
||||
|
||||
---
|
||||
|
||||
## 管理指令
|
||||
|
||||
### 新增 MCP Server
|
||||
|
||||
```bash
|
||||
opencode mcp add
|
||||
```
|
||||
|
||||
### 列出 MCP Servers
|
||||
|
||||
```bash
|
||||
opencode mcp ls
|
||||
```
|
||||
|
||||
### 認證 OAuth Server
|
||||
|
||||
```bash
|
||||
opencode mcp auth <server-name>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### MCP Server 連線失敗
|
||||
|
||||
1. 檢查服務是否運行:
|
||||
```bash
|
||||
# PostgreSQL
|
||||
pg_isready -h localhost -p 5432
|
||||
|
||||
# Redis
|
||||
redis-cli -a accusys ping
|
||||
|
||||
# Qdrant
|
||||
curl -s http://localhost:6333/
|
||||
```
|
||||
|
||||
2. 檢查 MCP Server 是否安裝:
|
||||
```bash
|
||||
which mcp-server-postgres
|
||||
which mcp-server-redis
|
||||
```
|
||||
|
||||
3. 驗證配置格式正確
|
||||
|
||||
---
|
||||
|
||||
### Token 或 API Key 無效
|
||||
|
||||
1. PostgreSQL: 確認使用者名稱和密碼
|
||||
2. Redis: 確認密碼
|
||||
3. n8n: 確認 API Key 未過期
|
||||
4. Gitea: 確認 Token 有效
|
||||
|
||||
---
|
||||
|
||||
## 檔案位置
|
||||
|
||||
| 類型 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| OpenCode 配置 | ~/.config/opencode/opencode.json | MCP 設定檔 |
|
||||
| Gitea MCP | /opt/homebrew/bin/gitea-mcp-server | 安裝路徑 |
|
||||
| n8n MCP | /opt/homebrew/bin/mcp-n8n | 安裝路徑 |
|
||||
| Postgres MCP | /opt/homebrew/bin/mcp-server-postgres | 安裝路徑 |
|
||||
| Redis MCP | /opt/homebrew/bin/mcp-server-redis | 安裝路徑 |
|
||||
| Qdrant MCP | /opt/homebrew/bin/mcp-server-qdrant | 安裝路徑 |
|
||||
| Filesystem MCP | /opt/homebrew/bin/mcp-server-filesystem | 安裝路徑 |
|
||||
|
||||
---
|
||||
|
||||
## 常用指令
|
||||
|
||||
```bash
|
||||
# 列出所有 MCP servers
|
||||
opencode mcp ls
|
||||
|
||||
# 測試 PostgreSQL MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"query","arguments":{"sql":"SELECT 1;"}}}' | \
|
||||
/opt/homebrew/bin/mcp-server-postgres postgresql://accusys:accusys@localhost:5432/momentry
|
||||
|
||||
# 測試 Redis MCP
|
||||
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"ping","arguments":{}}}' | \
|
||||
/opt/homebrew/bin/mcp-server-redis redis://:accusys@localhost:6379
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本資訊
|
||||
|
||||
- 版本: 1.0
|
||||
- 安裝日期: 2026-03-24
|
||||
- 文件更新: 2026-03-24
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [OpenCode Guide](./OPENCODE_GUIDE.md) - OpenCode 使用指南
|
||||
- [Gitea MCP 安裝](./INSTALL_GITEA_MCP.md) - Gitea MCP 詳細設定
|
||||
- [n8n MCP 設定](./N8N_MCP_SETUP.md) - n8n MCP 詳細設定
|
||||
- [服務總覽](./SERVICES.md) - 所有服務狀態總覽
|
||||
@@ -1,102 +0,0 @@
|
||||
# YOLO Resume 功能整合規劃
|
||||
|
||||
## 現有資源
|
||||
|
||||
### 1. video_yolo_player 專案
|
||||
**位置**: `/Users/accusys/video_yolo_player/video_yolo_object_prescan.py`
|
||||
|
||||
**功能**:
|
||||
- ✅ Ctrl+C 暫停並保存進度
|
||||
- ✅ 自動從上一次繼續 (自動偵測 last_processed_frame)
|
||||
- ✅ 可配置自動保存間隔 (預設 30 秒)
|
||||
- ✅ 完整 metadata 追蹤 (處理時間、檢測數量等)
|
||||
- ✅ 互動式詢問是否繼續
|
||||
|
||||
### 2. momentry_core_0.1 專案
|
||||
**位置**: `/Users/accusys/momentry_core_0.1/scripts/yolo_processor.py`
|
||||
|
||||
## 整合狀態
|
||||
|
||||
| 項目 | 狀態 | 完成日期 |
|
||||
|------|------|----------|
|
||||
| Python script 整合 | ✅ 已完成 | 2026-03-22 |
|
||||
| Rust JSON 格式支援 | ✅ 已完成 | 2026-03-22 |
|
||||
| Auto-save 功能 (時間) | ✅ 已完成 | 2026-03-22 |
|
||||
| Auto-save 功能 (frame) | ✅ 已完成 | 2026-03-22 |
|
||||
| Ctrl+C 信號處理 | ✅ 已完成 | 2026-03-22 |
|
||||
| --force 參數 | ✅ 已完成 | 2026-03-22 |
|
||||
| --auto-save-frames 參數 | ✅ 已完成 | 2026-03-22 |
|
||||
|
||||
## 已實作功能
|
||||
|
||||
### momentry_core_0.1/scripts/yolo_processor.py
|
||||
|
||||
```python
|
||||
# 新增功能:
|
||||
def load_existing_data(output_file) # 載入現有資料
|
||||
def save_detection_data(output_file) # 保存進度
|
||||
def signal_handler(signum, frame) # Ctrl+C 處理
|
||||
|
||||
# 新增參數:
|
||||
--auto-save 30 # 自動保存間隔 (秒)
|
||||
--auto-save-frames 300 # 每 N frames 保存一次 (先到為準)
|
||||
--force # 強制從頭開始
|
||||
```
|
||||
|
||||
### 輸出格式
|
||||
|
||||
```json
|
||||
{
|
||||
"metadata": {
|
||||
"video_path": "...",
|
||||
"fps": 24.0,
|
||||
"total_frames": 1000,
|
||||
"status": "in_progress" | "completed" | "interrupted",
|
||||
"total_detections": 5000,
|
||||
"processing_time": 120.5,
|
||||
"auto_save_count": 4,
|
||||
"auto_save_interval": 30,
|
||||
"auto_save_frames": 300,
|
||||
"last_saved_frame": 12500,
|
||||
"last_saved_at": "ISO timestamp"
|
||||
},
|
||||
"frames": {
|
||||
"1": { "frame_number": 1, "time_seconds": 0.0, "detections": [...] },
|
||||
"2": { "frame_number": 2, "time_seconds": 0.042, "detections": [...] }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Auto-save 觸發條件
|
||||
|
||||
**滿足以下任一條件就會寫入磁碟:**
|
||||
1. 距離上次儲存已超過 `--auto-save` 秒數
|
||||
2. 距離上次儲存已處理超過 `--auto-save-frames` 個 frames
|
||||
|
||||
### 使用方式
|
||||
|
||||
```bash
|
||||
# 第一次執行 (預設: 30秒 或 300 frames)
|
||||
python yolo_processor.py video.mp4 output.json --uuid "abc123"
|
||||
|
||||
# 中斷後繼續 (自動偵測)
|
||||
python yolo_processor.py video.mp4 output.json --uuid "abc123"
|
||||
|
||||
# 強制從頭開始
|
||||
python yolo_processor.py video.mp4 output.json --force
|
||||
|
||||
# 自訂自動保存間隔
|
||||
python yolo_processor.py video.mp4 output.json --auto-save 10 --auto-save-frames 100
|
||||
```
|
||||
|
||||
### Rust 端支援
|
||||
|
||||
`check_json_completeness()` 已更新以支援新格式:
|
||||
- 讀取 `frames` dict 的最後一個 key 作為 `last_processed_frame`
|
||||
- 檢查 `metadata.status` 判斷是否完成
|
||||
|
||||
## 待測試項目
|
||||
|
||||
- [ ] 實際執行中斷後繼續
|
||||
- [ ] 驗證 large video (如 Old_Time_Movie_Show) 繼續處理
|
||||
- [ ] 驗證 Rust --resume 參數正確傳遞
|
||||
@@ -1,193 +0,0 @@
|
||||
# Momentry Core 搜尋能力驗收標準 (Search Acceptance Criteria)
|
||||
|
||||
本文檔記錄了系統必須能夠支援的複雜搜尋場景。這些問句將作為我們開發與測試的**最高指導原則**,用於驗證每個模組的可行性與系統整合度。
|
||||
|
||||
> **更新日期**: 2026-04-12
|
||||
> **狀態**: 草稿 (待實測驗證)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 驗收維度與測試用例 (Test Cases)
|
||||
|
||||
### 1. 🕰️ WHEN (時間與劇情序列)
|
||||
**挑戰點**: 系統需具備「劇情連貫性理解」與「相對時間/事件計數」的能力。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「男女主角第二次見面那段」** | `face_id` 匹配 + **Interaction Counter (同框次數統計)** | ⚠️ 待開發 | 需建立場景聚合邏輯 (Scene Grouping) |
|
||||
| **「第一個壞人死後, 男女主角討論 who did it 的場景」** | **Event Timeline** (Gunshot/Death 事件) + **Contextual Search** (討論兇手) | ⚠️ 待開發 | 需結合事件偵測與對話語義分析 |
|
||||
| **「被捕之前最後見的人場景」** | **Causal Reasoning** (被捕事件前的最後互動) | 🔴 高難度 | 需 LLM 深度理解劇情因果 |
|
||||
|
||||
### 2. 😡 EMOTION (情緒氛圍)
|
||||
**挑戰點**: 從音頻能量、面部表情或對話內容推導出「氛圍」。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「很緊張的場景」** | Audio Energy (高能量無對話/配樂變奏) + Sentiment Analysis | ✅ 部分可用 | 需結合配樂切分與打鬥偵測 |
|
||||
| **「很感動的場景」** | Music Segment (抒情樂段) + Positive Sentiment | 🔴 高難度 | 需 LLM 分析劇情語義 |
|
||||
| **「很憤怒的場景」** | Conflict Detection (爭吵) + Angry Sentiment | ✅ 可用 | 已有 Argument 偵測機制 |
|
||||
| **「很尷尬的場景」** | Silence/Long Pause + Awkward Sentiment | ⚠️ 待開發 | 需 LLM 辨識潛台詞 |
|
||||
|
||||
### 3. 🗣️ INTENT (對話意圖)
|
||||
**挑戰點**: 僅靠關鍵字無法區分「質問」與「詢問」,需依賴 LLM 語義分類。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「在說服的場景」** | Dialogue Intent Classification (Persuasion) | 🔴 需 LLM | 需建立語義索引 (Semantic Index) |
|
||||
| **「在質問的場景」** | Interrogation Keywords + Aggressive Sentiment | ✅ 可用 | 已有 Conflict/Argument 數據 |
|
||||
| **「在解釋的場景」** | Dialogue Intent (Explanation) | 🔴 需 LLM | 需語義索引支援 |
|
||||
| **「在談判的場景」** | Dialogue Intent (Negotiation) | 🔴 需 LLM | 需語義索引支援 |
|
||||
|
||||
### 4. 📦 OBJECT (視覺物件)
|
||||
**挑戰點**: 依賴 YOLO 的物件辨識準確度與標籤對應。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「畫面有手機的場景」** | YOLO Object Detection (`cell phone`) | ✅ 可用 | 已有 YOLO JSON 數據 |
|
||||
| **「畫面有車子的場景」** | YOLO Object Detection (`car`, `truck`) | ✅ 可用 | 已有 YOLO JSON 數據 |
|
||||
| **「畫面有麥克風的場景」** | YOLO Object Detection (`microphone`) | ⚠️ 依賴模型 | 小物件可能遺漏 |
|
||||
| **「畫面有文件的場景」** | YOLO (`book`, `paper`) + OCR (Text on Paper) | ⚠️ 混合技術 | 需結合 OCR 關鍵字 |
|
||||
|
||||
### 5. 🔊 AUDIO (聽覺事件)
|
||||
**挑戰點**: 區分背景音與前景音。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「聽到背景有音樂的場景」** | Audio Taxonomy (`music`) + Segmentation | ✅ 可用 | 已有 Music Segmentation 數據 |
|
||||
| **「聽到掌聲的場景」** | Audio Taxonomy (`applause`) | ✅ 可用 | AST 模型支援 |
|
||||
| **「聽到爆炸聲的場景」** | Audio Energy (High) + Taxonomy (`explosion`) | ✅ 可用 | 已有 Sound Event 偵測 |
|
||||
| **「聽到笑聲的場景」** | Audio Taxonomy (`laughter`) | ✅ 可用 | AST 模型支援 |
|
||||
|
||||
### 6. 🤝 RELATION (人物關係與互動)
|
||||
**挑戰點**: 識別特定角色組合,並分析他們之間的互動模式。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「奧黛麗赫本和 Cary Grant 對話場景」** | Face ID 匹配 (`Person_A` + `Person_B`) + **Co-occurrence** | ✅ 可用 | 已有 Face Clustering 數據 |
|
||||
| **「兩人爭論場景」** | Face Co-occurrence + Argument Detection | ✅ 可用 | 結合 Face 與 Event 表 |
|
||||
| **「主持人訪問來賓場景」** | Pose/Action (Sitting vs Standing) + Dialogue Flow | 🔴 需 LLM | 需視覺構圖分析 |
|
||||
|
||||
### 7. 📚 CONTENT (上下文與劇情連貫性)
|
||||
**挑戰點**: 這是最高難度的「推理」層面,需理解事件的前因後果。
|
||||
|
||||
| 測試問句 | 所需技術/數據來源 | 當前狀態 | 備註 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **「衝突之後第一次會面場景」** | **Timeline Logic** (Find Conflict -> Search Next Co-occurrence) | 🔴 高難度 | 需事件序列邏輯運算 |
|
||||
| **「女主角第一次開始懷疑男主角, 之後又決定信任男主角的場景」** | **Emotional Arc Analysis** (Sentiment Transition: Neutral -> Suspicion -> Trust) | 🔴 極高難度 | 需 LLM 長程語義分析 |
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 待實作功能清單 (To-Do for Full Compliance)
|
||||
|
||||
為了達成上述所有標準,我們必須完成以下開發:
|
||||
|
||||
1. [ ] **語義索引建置 (Semantic Indexing)**: 使用 Ollama (Gemma 4) 離線分析全片對話,填入 `chunk_semantics` 表。
|
||||
2. [ ] **場景聚合邏輯 (Scene Aggregation)**: 將零碎的 ASR/CUT 聚合成有意義的「場景 (Scene)」。
|
||||
3. [ ] **互動計數器 (Interaction Counter)**: 統計角色同框次數,支援「第 X 次見面」查詢。
|
||||
4. [ ] **事件時間軸 (Event Timeline)**: 將 Gunshot, Death, Fight 等事件結構化,支援「...之後」查詢。
|
||||
5. [ ] **關係圖譜 (Relationship Graph)**: 建立角色關係網,支援「主持人/來賓」等角色定義。
|
||||
|
||||
---
|
||||
|
||||
## 🔍 視覺分片搜索 API (Visual Chunk Search)
|
||||
|
||||
### 可用端點
|
||||
|
||||
| 端點 | 方法 | 描述 |
|
||||
| :--- | :--- | :--- |
|
||||
| `/api/v1/search/visual` | POST | 通用視覺搜索 |
|
||||
| `/api/v1/search/visual/class` | POST | 按物件類別搜索 |
|
||||
| `/api/v1/search/visual/density` | POST | 按空間密度搜索 |
|
||||
| `/api/v1/search/visual/stats` | POST | 獲取視覺統計 |
|
||||
| `/api/v1/search/visual/combination` | POST | 按物件組合搜索 |
|
||||
|
||||
### API 使用範例
|
||||
|
||||
#### 1. 通用視覺搜索
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/visual \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"uuid": "abc123",
|
||||
"criteria": {
|
||||
"min_avg_confidence": 0.8,
|
||||
"required_classes": ["person", "car"],
|
||||
"min_spatial_density": 0.5
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
#### 2. 按物件類別搜索
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/visual/class \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"uuid": "abc123",
|
||||
"object_class": "person",
|
||||
"min_count": 5,
|
||||
"max_count": 20
|
||||
}'
|
||||
```
|
||||
|
||||
#### 3. 按空間密度搜索
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/visual/density \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"uuid": "abc123",
|
||||
"min_density": 0.6,
|
||||
"max_density": 0.9
|
||||
}'
|
||||
```
|
||||
|
||||
#### 4. 獲取視覺統計
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/visual/stats \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"uuid": "abc123"}'
|
||||
```
|
||||
|
||||
#### 5. 按物件組合搜索
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search/visual/combination \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"uuid": "abc123",
|
||||
"combination": [
|
||||
["person", 5],
|
||||
["car", 2]
|
||||
]
|
||||
}'
|
||||
```
|
||||
|
||||
### 使用 UniversalSearch 整合
|
||||
|
||||
也可以通過 `/api/v1/search` 端點使用視覺過濾器:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/search \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"query": "",
|
||||
"uuid": "abc123",
|
||||
"filters": {
|
||||
"min_confidence": 0.8,
|
||||
"required_object_classes": ["person"]
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### 緩存說明
|
||||
|
||||
視覺搜索結果會被緩存以提高性能。緩存鍵格式:`search:visual:{uuid}:{hash}`
|
||||
|
||||
緩存過期時間:使用與普通搜索相同的 TTL(可通過 `MOMENTRY_CACHE_TTL_SEARCH` 環境變量配置)
|
||||
|
||||
---
|
||||
|
||||
**這份文檔已建立於 `docs/SEARCH_ACCEPTANCE_CRITERIA.md`,我們將以此為目標持續推進系統開發。**
|
||||
@@ -1,716 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "Momentry 服務添加規範 v2.1"
|
||||
date: "2026-03-16"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "momentry"
|
||||
- "服務添加規範"
|
||||
ai_query_hints:
|
||||
- "查詢 Momentry 服務添加規範 v2.1 的內容"
|
||||
- "Momentry 服務添加規範 v2.1 的主要目的是什麼?"
|
||||
- "如何操作或實施 Momentry 服務添加規範 v2.1?"
|
||||
---
|
||||
|
||||
# Momentry 服務添加規範 v2.1
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-16 |
|
||||
| 更新時間 | 2026-03-24 |
|
||||
| 文件版本 | V2.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-16 | 創建文件 | Warren | OpenCode / MiniMax M2.5 |
|
||||
| V2.1 | 2026-03-24 | 更新 launchctl 命令,使用 bootstrap | OpenCode | OpenCode / big-pickle |
|
||||
|
||||
---
|
||||
|
||||
## 一、概述
|
||||
|
||||
本文檔定義在 Momentry 系統中添加新服務的標準流程和規範。
|
||||
|
||||
**重要原則**:
|
||||
- 使用 `launchctl` 管理服務,勿使用 `brew services`
|
||||
- 所有服務使用 `com.momentry.*` 作為 plist Label
|
||||
- 數據存放於 `/Users/accusys/momentry/` 目錄
|
||||
- 每個服務需提供完整的監控腳本
|
||||
- 所有服務 Plist 存放於 `/Library/LaunchDaemons/`
|
||||
- 所有服務以 `accusys` 用戶運行,確保 accusys 可以管理
|
||||
|
||||
---
|
||||
|
||||
## 二、服務運行方式
|
||||
|
||||
### 2.1 運行分類
|
||||
|
||||
| 類型 | 說明 | 示例 |
|
||||
|------|------|------|
|
||||
| **開機自動運行** | 電腦開機後立即自動啟動 | PostgreSQL, Redis, n8n, Caddy 等核心服務 |
|
||||
| **登入時運行** | 用戶登入後才啟動 | 開發工具、臨時服務 |
|
||||
|
||||
**當前所有服務**:均為開機自動運行
|
||||
|
||||
### 2.2 Plist 存放位置
|
||||
|
||||
所有 Momentry 服務統一存放於:
|
||||
```
|
||||
/Library/LaunchDaemons/com.momentry.{service_name}.plist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 三、服務命名規範
|
||||
|
||||
### 3.1 Plist 文件命名
|
||||
|
||||
```
|
||||
com.momentry.{service_name}.plist
|
||||
```
|
||||
|
||||
示例:
|
||||
- `com.momentry.redis.plist`
|
||||
- `com.momentry.n8n.main.plist`
|
||||
- `com.momentry.rustdesk.hbbs.plist`
|
||||
|
||||
### 3.2 目錄命名
|
||||
|
||||
服務相關目錄統一放置於:
|
||||
```
|
||||
/Users/accusys/momentry/
|
||||
├── var/{service_name}/ # 服務數據
|
||||
├── etc/{service_name}/ # 服務配置
|
||||
├── log/{service_name}.log # 服務日誌 (stdout)
|
||||
└── log/{service_name}.error.log # 錯誤日誌 (stderr)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 四、Plist 文件模板
|
||||
|
||||
### 4.1 標準服務模板
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.{service_name}</string>
|
||||
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/momentry/var/{service_name}</string>
|
||||
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/path/to/executable</string>
|
||||
<string>--arg1</string>
|
||||
<string>value1</string>
|
||||
</array>
|
||||
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>PATH</key>
|
||||
<string>/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>
|
||||
<!-- 其他環境變數 -->
|
||||
</dict>
|
||||
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/{service_name}.log</string>
|
||||
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/{service_name}.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
```
|
||||
|
||||
### 4.2 日誌文件規範
|
||||
|
||||
每個服務必須創建兩個日誌文件:
|
||||
|
||||
| 文件 | 說明 | 路徑 |
|
||||
|------|------|------|
|
||||
| StandardOutPath | 標準輸出日誌 | `/Users/accusys/momentry/log/{service_name}.log` |
|
||||
| StandardErrorPath | 錯誤輸出日誌 | `/Users/accusys/momentry/log/{service_name}.error.log` |
|
||||
|
||||
**創建日誌文件**:
|
||||
```bash
|
||||
touch /Users/accusys/momentry/log/{service_name}.log
|
||||
touch /Users/accusys/momentry/log/{service_name}.error.log
|
||||
chmod 644 /Users/accusys/momentry/log/{service_name}.log
|
||||
chmod 644 /Users/accusys/momentry/log/{service_name}.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 五、添加服務步驟
|
||||
|
||||
### 步驟 1:創建目錄結構
|
||||
|
||||
```bash
|
||||
# 創建服務目錄
|
||||
mkdir -p /Users/accusys/momentry/var/{service_name}
|
||||
mkdir -p /Users/accusys/momentry/etc/{service_name}
|
||||
|
||||
# 創建日誌文件
|
||||
touch /Users/accusys/momentry/log/{service_name}.log
|
||||
touch /Users/accusys/momentry/log/{service_name}.error.log
|
||||
```
|
||||
|
||||
### 步驟 2:創建 Plist 文件
|
||||
|
||||
```bash
|
||||
# 複製模板並編輯
|
||||
cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/template.service.plist \
|
||||
/Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.{service_name}.plist
|
||||
|
||||
# 編輯 plist 文件
|
||||
vim /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.{service_name}.plist
|
||||
```
|
||||
|
||||
### 步驟 3:複製到系統 LaunchDaemons
|
||||
|
||||
```bash
|
||||
# 複製到 /Library/LaunchDaemons/
|
||||
sudo cp /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.{service_name}.plist \
|
||||
/Library/LaunchDaemons/
|
||||
```
|
||||
|
||||
### 步驟 4:載入服務
|
||||
|
||||
```bash
|
||||
# 載入服務
|
||||
sudo launchctl load /Library/LaunchDaemons/com.momentry.{service_name}.plist
|
||||
|
||||
# 驗證服務狀態
|
||||
launchctl list | grep momentry
|
||||
```
|
||||
|
||||
### 步驟 5:添加監控
|
||||
|
||||
在 `monitor/config/monitor_config.yaml` 中添加服務配置:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
services:
|
||||
- name: "{service_name}"
|
||||
type: "http" # 或 "process", "tcp"
|
||||
port: {port_number}
|
||||
host: "localhost"
|
||||
check_url: "http://localhost:{port}/health"
|
||||
timeout: 5
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### 步驟 6:添加文檔
|
||||
|
||||
在 `docs/INSTALL_{SERVICE_NAME}.md` 中記錄:
|
||||
- 安裝步驟
|
||||
- 配置說明
|
||||
- 健康檢查命令
|
||||
- 故障排除
|
||||
|
||||
---
|
||||
|
||||
## 六、服務分類
|
||||
|
||||
### 按功能分類
|
||||
|
||||
| 類別 | 服務 |
|
||||
|------|------|
|
||||
| 資料庫 | PostgreSQL, Redis, MariaDB, MongoDB |
|
||||
| 應用 | n8n, Gitea, SFTPGo |
|
||||
| 網頁 | Caddy, PHP-FPM |
|
||||
| AI/ML | Ollama, Qdrant |
|
||||
| 遠程 | RustDesk |
|
||||
|
||||
### 按運行方式分類
|
||||
|
||||
| 運行方式 | 數量 | 服務 |
|
||||
|----------|------|------|
|
||||
| 開機自動運行 | 15 | PostgreSQL, Redis, n8n, Caddy, Gitea, SFTPGo, Ollama, Qdrant, MariaDB, PHP-FPM, RustDesk, MongoDB, Agent |
|
||||
| 登入時運行 | 0 | (暫無) |
|
||||
|
||||
---
|
||||
|
||||
## 七、監控要求
|
||||
|
||||
每個服務必須提供:
|
||||
|
||||
### 7.1 健康檢查
|
||||
|
||||
在 `monitor/service/health_check.sh` 中添加檢查函數:
|
||||
|
||||
```bash
|
||||
check_{service_name}() {
|
||||
local start=$(date +%s%N)
|
||||
if nc -z localhost {port} > /dev/null 2>&1; then
|
||||
local end=$(date +%s%N)
|
||||
local ms=$(( (end - start) / 1000000 ))
|
||||
echo -e "${GREEN}✓${NC} {service_name} ({port}) - ${ms}ms"
|
||||
record_service "{service_name}" "up" "$ms" ""
|
||||
return 0
|
||||
else
|
||||
echo -e "${RED}✗${NC} {service_name} ({port}) - Down"
|
||||
record_service "{service_name}" "down" "0" "Connection failed"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
```
|
||||
|
||||
### 7.2 數據庫記錄
|
||||
|
||||
```sql
|
||||
-- 添加服務監控記錄函數
|
||||
record_service() {
|
||||
local service=$1
|
||||
local status=$2
|
||||
local response_time=$3
|
||||
local error_msg=$4
|
||||
|
||||
psql -U accusys -h localhost -d momentry << EOF
|
||||
INSERT INTO monitor_services (service_name, service_type, status, response_time_ms, error_message, checked_at)
|
||||
VALUES ('$service', 'service', '$status', $response_time, '$error_msg', NOW());
|
||||
EOF
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 八、服務管理命令
|
||||
|
||||
### 8.1 基本操作
|
||||
|
||||
```bash
|
||||
# 啟動服務 (使用 launchctl bootstrap)
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.{service}.plist
|
||||
|
||||
# 停止服務 (使用 launchctl bootout)
|
||||
sudo launchctl bootout system/com.momentry.{service}.plist
|
||||
|
||||
# 重新載入服務
|
||||
sudo launchctl bootout system/com.momentry.{service}.plist
|
||||
sudo launchctl bootstrap system /Library/LaunchDaemons/com.momentry.{service}.plist
|
||||
|
||||
# 查看服務狀態
|
||||
launchctl list | grep com.momentry
|
||||
|
||||
# 查看特定服務狀態
|
||||
launchctl list | grep com.momentry.{service}
|
||||
|
||||
# 查看服務日誌
|
||||
tail -f /Users/accusys/momentry/log/{service}.log
|
||||
tail -f /Users/accusys/momentry/log/{service}.error.log
|
||||
```
|
||||
|
||||
### 8.2 批量管理
|
||||
|
||||
```bash
|
||||
# 啟動所有 Momentry 服務
|
||||
for plist in /Library/LaunchDaemons/com.momentry.*.plist; do
|
||||
sudo launchctl bootstrap system "$plist"
|
||||
done
|
||||
|
||||
# 停止所有 Momentry 服務
|
||||
for svc in $(launchctl list | grep com.momentry | awk '{print $3}'); do
|
||||
sudo launchctl bootout system/$svc 2>/dev/null
|
||||
done
|
||||
|
||||
# 查看所有 Momentry 服務狀態
|
||||
launchctl list | grep com.momentry
|
||||
```
|
||||
|
||||
### 8.2 故障排除
|
||||
|
||||
```bash
|
||||
# 檢查服務是否運行
|
||||
pgrep -f "{service_process_name}"
|
||||
|
||||
# 檢查端口是否監聽
|
||||
lsof -i :{port}
|
||||
|
||||
# 檢查錯誤日誌
|
||||
tail -100 /Users/accusys/momentry/log/{service}.error.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 九、服務備份作業
|
||||
|
||||
### 9.1 備份內容
|
||||
|
||||
每個服務需要備份的內容:
|
||||
|
||||
| 類別 | 路徑 | 說明 |
|
||||
|------|------|------|
|
||||
| 數據 | `/Users/accusys/momentry/var/{service}/` | 服務運行數據 |
|
||||
| 配置 | `/Users/accusys/momentry/etc/{service}/` | 服務配置文件 |
|
||||
| Plist | `/Library/LaunchDaemons/com.momentry.{service}.plist` | 啟動配置 |
|
||||
| 日誌 | `/Users/accusys/momentry/log/{service}.log` | 運行日誌 |
|
||||
|
||||
### 9.2 備份命名規範
|
||||
|
||||
**格式**: `{service}_{type}_{YYYYMMDD}_{HHMMSS}[_{suffix}].{ext}`
|
||||
|
||||
**組成部分**:
|
||||
| 位置 | 說明 | 範例 |
|
||||
|------|------|------|
|
||||
| `{service}` | 服務名稱 (小寫) | `postgresql`, `redis`, `n8n` |
|
||||
| `{type}` | 備份類型 | `full`, `db`, `cfg`, `data` |
|
||||
| `{YYYYMMDD}` | 備份日期 | `20260315` |
|
||||
| `{HHMMSS}` | 備份時間 (24小時制) | `030000` |
|
||||
| `{suffix}` | 可選標記 | `incremental`, `verified` |
|
||||
| `{ext}` | 檔案擴展名 | `sql.gz`, `tar.gz`, `rdb`, `zip` |
|
||||
|
||||
**類型說明**:
|
||||
| 類型 | 說明 | 包含內容 |
|
||||
|------|------|---------|
|
||||
| `full` | 完整備份 | 數據 + 配置 + 日誌 |
|
||||
| `db` | 數據庫備份 | 資料庫導出 (sql, rdb) |
|
||||
| `cfg` | 配置備份 | 配置文件 |
|
||||
| `data` | 數據備份 | var 目錄 |
|
||||
|
||||
**範例**:
|
||||
```
|
||||
postgresql_db_20260315_030000.sql.gz # PostgreSQL 完整資料庫 (壓縮)
|
||||
redis_rdb_20260315_030000.rdb # Redis RDB 快照
|
||||
n8n_full_20260315_030000.tar.gz # n8n 完整備份
|
||||
mariadb_db_wordpress_20260315_030000.sql.gz # MariaDB WP 資料庫
|
||||
gitea_full_20260315_030000.zip # Gitea 完整備份
|
||||
qdrant_snapshot_20260315_030000.tar.gz # Qdrant 向量庫
|
||||
ollama_cfg_20260315_030000.tar.gz # Ollama 配置
|
||||
caddy_cfg_20260315_030000.tar.gz # Caddy 配置
|
||||
```
|
||||
|
||||
**可信斷點標記**:
|
||||
- 檔名本身即為可信時間點
|
||||
- 還原時直接使用檔名中的時間戳
|
||||
- 建議配合 `backup_registry` 資料庫記錄完整元數據
|
||||
|
||||
**校驗和命名**:
|
||||
```
|
||||
postgresql_db_20260315_030000.sql.gz.sha256
|
||||
```
|
||||
|
||||
### 9.3 備份腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# 標準化備份腳本範本
|
||||
# 遵循命名規範: {service}_{type}_{YYYYMMDD}_{HHMMSS}.{ext}
|
||||
|
||||
set -e
|
||||
|
||||
SERVICE_NAME="{service_name}"
|
||||
BACKUP_TYPE="{type}" # full, db, cfg, data
|
||||
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_DIR="/Users/accusys/momentry/backup/${SERVICE_NAME}"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# 根據類型執行備份
|
||||
case "$BACKUP_TYPE" in
|
||||
full)
|
||||
echo "[$TIMESTAMP] 執行 $SERVICE_NAME 完整備份..."
|
||||
tar -czf "$BACKUP_DIR/${SERVICE_NAME}_full_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/var/${SERVICE_NAME}/ \
|
||||
/Users/accusys/momentry/etc/${SERVICE_NAME}/ 2>/dev/null
|
||||
;;
|
||||
db)
|
||||
echo "[$TIMESTAMP] 執行 $SERVICE_NAME 資料庫備份..."
|
||||
if [ "$SERVICE_NAME" = "postgresql" ]; then
|
||||
pg_dump -U accusys ${SERVICE_NAME} | gzip > \
|
||||
"$BACKUP_DIR/${SERVICE_NAME}_db_${TIMESTAMP}.sql.gz"
|
||||
elif [ "$SERVICE_NAME" = "mariadb" ]; then
|
||||
mysqldump -u root -p --all-databases | gzip > \
|
||||
"$BACKUP_DIR/${SERVICE_NAME}_db_${TIMESTAMP}.sql.gz"
|
||||
elif [ "$SERVICE_NAME" = "redis" ]; then
|
||||
redis-cli -a accusys SAVE
|
||||
cp /opt/homebrew/var/db/redis/dump.rdb \
|
||||
"$BACKUP_DIR/${SERVICE_NAME}_rdb_${TIMESTAMP}.rdb"
|
||||
fi
|
||||
;;
|
||||
cfg)
|
||||
echo "[$TIMESTAMP] 執行 $SERVICE_NAME 配置備份..."
|
||||
tar -czf "$BACKUP_DIR/${SERVICE_NAME}_cfg_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/etc/${SERVICE_NAME}/ 2>/dev/null
|
||||
;;
|
||||
data)
|
||||
echo "[$TIMESTAMP] 執行 $SERVICE_NAME 數據備份..."
|
||||
tar -czf "$BACKUP_DIR/${SERVICE_NAME}_data_${TIMESTAMP}.tar.gz" \
|
||||
/Users/accusys/momentry/var/${SERVICE_NAME}/ 2>/dev/null
|
||||
;;
|
||||
esac
|
||||
|
||||
# 生成校驗和
|
||||
if [ -f "$BACKUP_DIR/${SERVICE_NAME}_${BACKUP_TYPE}_${TIMESTAMP}"* ]; then
|
||||
sha256sum "$BACKUP_DIR/${SERVICE_NAME}_${BACKUP_TYPE}_${TIMESTAMP}"* > \
|
||||
"$BACKUP_DIR/${SERVICE_NAME}_${BACKUP_TYPE}_${TIMESTAMP}.sha256"
|
||||
fi
|
||||
|
||||
# 清理舊備份 (保留 30 天)
|
||||
find "$BACKUP_DIR" -name "*_${TIMESTAMP%%_*}_*.tar.gz" -mtime +30 -delete 2>/dev/null
|
||||
find "$BACKUP_DIR" -name "*_${TIMESTAMP%%_*}_*.sql.gz" -mtime +30 -delete 2>/dev/null
|
||||
find "$BACKUP_DIR" -name "*_${TIMESTAMP%%_*}_*.rdb" -mtime +30 -delete 2>/dev/null
|
||||
find "$BACKUP_DIR" -name "*.sha256" -mtime +30 -delete 2>/dev/null
|
||||
|
||||
echo "備份完成: ${SERVICE_NAME}_${BACKUP_TYPE}_${TIMESTAMP}"
|
||||
```
|
||||
|
||||
### 9.4 備份排程
|
||||
|
||||
建議使用 cron 進行自動備份:
|
||||
|
||||
```bash
|
||||
# 編輯 crontab
|
||||
crontab -e
|
||||
|
||||
# 添加備份任務 (每天凌晨 3 點)
|
||||
0 3 * * * /Users/accusys/momentry/scripts/backup_{service}.sh >> /Users/accusys/momentry/log/backup.log 2>&1
|
||||
|
||||
# 每週日凌晨 3 點執行完整備份
|
||||
0 3 * * 0 /Users/accusys/momentry/scripts/backup_{service}.sh full >> /Users/accusys/momentry/log/backup.log 2>&1
|
||||
```
|
||||
|
||||
### 9.5 備份驗證
|
||||
|
||||
```bash
|
||||
# 查看備份列表 (按時間排序)
|
||||
ls -lt /Users/accusys/momentry/backup/{service}/
|
||||
|
||||
# 驗證備份完整性
|
||||
# 1. 檢查校驗和
|
||||
sha256sum -c /Users/accusys/momentry/backup/{service}/*.sha256
|
||||
|
||||
# 2. 驗證 tar 壓縮
|
||||
tar -tzf /Users/accusys/momentry/backup/{service}/{service}_full_20260315_030000.tar.gz
|
||||
|
||||
# 3. 驗證 SQL 備份
|
||||
zcat /Users/accusys/momentry/backup/{service}/{service}_db_20260315_030000.sql.gz | head -5
|
||||
|
||||
# 驗證備份完整性
|
||||
tar -tzf /Users/accusys/momentry/backup/{service}/{service}_var_20260315.tar.gz
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 十、服務完整刪除作業
|
||||
|
||||
### 10.1 刪除前確認
|
||||
|
||||
**警告**:此操作不可逆,請確保已完成備份!
|
||||
|
||||
- [ ] 確認服務已停止運行
|
||||
- [ ] 確認數據已備份
|
||||
- [ ] 確認無其他服務依賴此服務
|
||||
|
||||
### 10.2 刪除步驟
|
||||
|
||||
**步驟 1:停止服務**
|
||||
|
||||
```bash
|
||||
# 停止服務
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.{service}.plist
|
||||
|
||||
# 驗證服務已停止
|
||||
launchctl list | grep momentry.{service}
|
||||
```
|
||||
|
||||
**步驟 2:刪除 Plist**
|
||||
|
||||
```bash
|
||||
# 刪除系統 Plist
|
||||
sudo rm /Library/LaunchDaemons/com.momentry.{service}.plist
|
||||
|
||||
# 刪除專案 Plist
|
||||
rm /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.{service}.plist
|
||||
```
|
||||
|
||||
**步驟 3:刪除數據和配置**
|
||||
|
||||
```bash
|
||||
# 刪除數據目錄
|
||||
sudo rm -rf /Users/accusys/momentry/var/{service}/
|
||||
|
||||
# 刪除配置目錄
|
||||
sudo rm -rf /Users/accusys/momentry/etc/{service}/
|
||||
|
||||
# 刪除日誌
|
||||
rm -f /Users/accusys/momentry/log/{service}.log
|
||||
rm -f /Users/accusys/momentry/log/{service}.error.log
|
||||
```
|
||||
|
||||
**步驟 4:清理監控配置**
|
||||
|
||||
```bash
|
||||
# 從監控配置中移除服務
|
||||
vim /Users/accusys/momentry_core_0.1/monitor/config/monitor_config.yaml
|
||||
# 刪除該服務的監控配置
|
||||
|
||||
# 從監控腳本中移除
|
||||
vim /Users/accusys/momentry_core_0.1/monitor/service/health_check.sh
|
||||
# 移除該服務的檢查函數
|
||||
```
|
||||
|
||||
**步驟 5:清理監控數據(可選)**
|
||||
|
||||
```bash
|
||||
# 保留歷史數據還是刪除?
|
||||
# 刪除監控數據
|
||||
psql -U accusys -h localhost -d momentry -c "
|
||||
DELETE FROM monitor_services WHERE service_name = '{service}';
|
||||
"
|
||||
```
|
||||
|
||||
### 10.3 驗證刪除
|
||||
|
||||
```bash
|
||||
# 確認服務已停止
|
||||
launchctl list | grep momentry.{service}
|
||||
|
||||
# 確認目錄已刪除
|
||||
ls /Users/accusys/momentry/var/{service}/ 2>/dev/null || echo "已刪除"
|
||||
|
||||
# 確認 Plist 已刪除
|
||||
ls /Library/LaunchDaemons/com.momentry.{service}.plist 2>/dev/null || echo "已刪除"
|
||||
```
|
||||
|
||||
### 10.4 完整刪除腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
SERVICE_NAME="{service_name}"
|
||||
|
||||
echo "========== 服務完整刪除 =========="
|
||||
echo "服務: $SERVICE_NAME"
|
||||
echo "警告:此操作不可逆!"
|
||||
read -p "確認繼續 (yes/no): " confirm
|
||||
|
||||
if [ "$confirm" != "yes" ]; then
|
||||
echo "取消刪除"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# 停止服務
|
||||
echo "[1/6] 停止服務..."
|
||||
sudo launchctl unload /Library/LaunchDaemons/com.momentry.${SERVICE_NAME}.plist 2>/dev/null
|
||||
|
||||
# 刪除 Plist
|
||||
echo "[2/6] 刪除 Plist..."
|
||||
sudo rm -f /Library/LaunchDaemons/com.momentry.${SERVICE_NAME}.plist
|
||||
rm -f /Users/accusys/momentry_core_0.1/momentry_runtime/plist/com.momentry.${SERVICE_NAME}.plist
|
||||
|
||||
# 刪除數據
|
||||
echo "[3/6] 刪除數據..."
|
||||
sudo rm -rf /Users/accusys/momentry/var/${SERVICE_NAME}/
|
||||
|
||||
# 刪除配置
|
||||
echo "[4/6] 刪除配置..."
|
||||
sudo rm -rf /Users/accusys/momentry/etc/${SERVICE_NAME}/
|
||||
|
||||
# 刪除日誌
|
||||
echo "[5/6] 刪除日誌..."
|
||||
rm -f /Users/accusys/momentry/log/${SERVICE_NAME}.log
|
||||
rm -f /Users/accusys/momentry/log/${SERVICE_NAME}.error.log
|
||||
|
||||
# 清理監控數據
|
||||
echo "[6/6] 清理監控數據..."
|
||||
psql -U accusys -h localhost -d momentry -c "
|
||||
DELETE FROM monitor_services WHERE service_name = '${SERVICE_NAME}';
|
||||
" 2>/dev/null
|
||||
|
||||
echo "========== 刪除完成 =========="
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 十一、檢查清單
|
||||
|
||||
添加新服務時,請確認以下項目:
|
||||
|
||||
- [ ] 創建服務目錄 (`var/`, `etc/`)
|
||||
- [ ] 配置日誌文件 (`.log` + `.error.log`)
|
||||
- [ ] 創建 plist 文件,UserName 設為 `accusys`
|
||||
- [ ] 複製到 `/Library/LaunchDaemons/`
|
||||
- [ ] 使用 launchctl 載入服務
|
||||
- [ ] 驗證服務運行
|
||||
- [ ] 添加監控配置
|
||||
- [ ] 測試監控腳本
|
||||
- [ ] 創建安裝文檔
|
||||
- [ ] 更新 SERVICES.md 服務清單
|
||||
- [ ] 更新 MOMENTRY_INTEGRATION_GUIDE.md
|
||||
|
||||
---
|
||||
|
||||
## 十二、模板文件
|
||||
|
||||
### Plist 模板位置
|
||||
|
||||
```
|
||||
/Users/accusys/momentry_core_0.1/momentry_runtime/plist/
|
||||
├── template.service.plist # 服務模板
|
||||
├── com.momentry.redis.plist # 服務示例
|
||||
└── com.momentry.n8n.main.plist # 複雜服務示例
|
||||
```
|
||||
|
||||
### 創建模板命令
|
||||
|
||||
```bash
|
||||
# 創建服務模板
|
||||
cat > /Users/accusys/momentry_core_0.1/momentry_runtime/plist/template.service.plist << 'EOF'
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key>
|
||||
<string>com.momentry.SERVICE_NAME</string>
|
||||
<key>UserName</key>
|
||||
<string>accusys</string>
|
||||
<key>WorkingDirectory</key>
|
||||
<string>/Users/accusys/momentry/var/SERVICE_NAME</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/path/to/executable</string>
|
||||
</array>
|
||||
<key>RunAtLoad</key>
|
||||
<true/>
|
||||
<key>KeepAlive</key>
|
||||
<true/>
|
||||
<key>StandardOutPath</key>
|
||||
<string>/Users/accusys/momentry/log/SERVICE_NAME.log</string>
|
||||
<key>StandardErrorPath</key>
|
||||
<string>/Users/accusys/momentry/log/SERVICE_NAME.error.log</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 十一、版本歷史
|
||||
|
||||
| 版本 | 日期 | 內容 |
|
||||
|------|------|------|
|
||||
| 1.0 | 2026-03-15 | 初始版本 |
|
||||
| 2.0 | 2026-03-15 | 統一 Plist 位置、移除 root/用戶區分、加入運行方式分類 |
|
||||
| 2.1 | 2026-03-15 | 新增服務備份作業、服務完整刪除作業 |
|
||||
| 2.1 | 2026-03-24 | 更新 launchctl 命令,使用 `bootstrap`/`bootout` 替代 `load`/`unload` | |
|
||||
@@ -1,523 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "SFTPGo Demo 用戶指南"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "demo"
|
||||
- "sftpgo"
|
||||
- "用戶指南"
|
||||
ai_query_hints:
|
||||
- "查詢 SFTPGo Demo 用戶指南 的內容"
|
||||
- "SFTPGo Demo 用戶指南 的主要目的是什麼?"
|
||||
- "如何操作或實施 SFTPGo Demo 用戶指南?"
|
||||
---
|
||||
|
||||
# SFTPGo Demo 用戶指南
|
||||
|
||||
## Web 管理介面
|
||||
|
||||
**URL**: https://sftpgo.momentry.ddns.net
|
||||
|
||||
### 登入方式
|
||||
|
||||
| 角色 | 用戶名 | 密碼 |
|
||||
|------|--------|------|
|
||||
| **Demo 用戶** | `demo` | `demopassword123` |
|
||||
|
||||
### 可用功能
|
||||
|
||||
- 瀏覽個人目錄結構
|
||||
- 上傳、下載檔案
|
||||
- 查看上傳記錄
|
||||
|
||||
---
|
||||
|
||||
## 快速連線資訊
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| **主機** | `sftpgo.momentry.ddns.net` |
|
||||
| **SFTP 連接埠** | `2022` |
|
||||
| **用戶名** | `demo` |
|
||||
| **密碼** | `demopassword123` |
|
||||
| **主目錄** | `/demo` |
|
||||
|
||||
---
|
||||
|
||||
## 連線方式
|
||||
|
||||
### 1. 命令列 SFTP
|
||||
|
||||
```bash
|
||||
# 使用密碼連線
|
||||
sshpass -p "demopassword123" sftp -P 2022 demo@sftpgo.momentry.ddns.net
|
||||
|
||||
# 使用金鑰連線 (需先設定)
|
||||
sftp -P 2022 -i ~/.ssh/id_rsa demo@sftpgo.momentry.ddns.net
|
||||
```
|
||||
|
||||
### 2. FileZilla
|
||||
|
||||
1. **主機**: `sftp://sftpgo.momentry.ddns.net`
|
||||
2. **連接埠**: `2022`
|
||||
3. **協定**: `SFTP`
|
||||
4. **登入類型**: `一般`
|
||||
5. **用戶名**: `demo`
|
||||
6. **密碼**: `demopassword123`
|
||||
|
||||
### 3. Cyberduck (macOS)
|
||||
|
||||
1. 選擇 **連線 > 新連線**
|
||||
2. 協定選擇 **SFTP (SSH File Transfer Protocol)**
|
||||
3. 伺服器: `sftpgo.momentry.ddns.net`
|
||||
4. 連接埠: `2022`
|
||||
5. 使用者名稱: `demo`
|
||||
6. 密碼: `demopassword123`
|
||||
|
||||
### 4. curl 上傳
|
||||
|
||||
```bash
|
||||
curl -u demo:demopassword123 \
|
||||
-T /path/to/video.mp4 \
|
||||
sftp://sftpgo.momentry.ddns.net:2022/demo/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## SFTP 基本操作
|
||||
|
||||
### 連線後常用指令
|
||||
|
||||
```bash
|
||||
# 進入互動式模式
|
||||
sftp demo@sftpgo.momentry.ddns.net -P 2022
|
||||
|
||||
# 常用指令
|
||||
sftp> pwd # 顯示目前目錄
|
||||
sftp> ls # 列出檔案
|
||||
sftp> ls -la # 詳細列表
|
||||
sftp> cd uploads # 切換目錄
|
||||
sftp> mkdir videos # 建立目錄
|
||||
sftp> put local.mp4 # 上傳檔案
|
||||
sftp> get remote.mp4 # 下載檔案
|
||||
sftp> rm old.mp4 # 刪除檔案
|
||||
sftp> exit # 斷線
|
||||
```
|
||||
|
||||
### 批次上傳
|
||||
|
||||
```bash
|
||||
# 上傳多個檔案
|
||||
sshpass -p "demopassword123" sftp -P 2022 demo@sftpgo.momentry.ddns.net <<EOF
|
||||
cd uploads
|
||||
put video1.mp4
|
||||
put video2.mp4
|
||||
put video3.mp4
|
||||
bye
|
||||
EOF
|
||||
|
||||
# 使用 glob 上傳
|
||||
sshpass -p "demopassword123" sftp -P 2022 demo@sftpgo.momentry.ddns.net <<EOF
|
||||
mput /path/to/videos/*.mp4
|
||||
bye
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 自動上傳腳本
|
||||
|
||||
### Bash 腳本
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# upload.sh - 上傳視頻到 Momentry
|
||||
|
||||
HOST="sftpgo.momentry.ddns.net"
|
||||
PORT="2022"
|
||||
USER="demo"
|
||||
PASS="demopassword123"
|
||||
REMOTE_DIR="/demo/uploads"
|
||||
|
||||
# 要上傳的檔案
|
||||
FILE="$1"
|
||||
|
||||
if [ -z "$FILE" ]; then
|
||||
echo "用法: $0 <檔案路徑>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
sshpass -p "$PASS" sftp -P $PORT $USER@$HOST <<EOF
|
||||
mkdir $REMOTE_DIR
|
||||
cd $REMOTE_DIR
|
||||
put "$FILE"
|
||||
bye
|
||||
EOF
|
||||
|
||||
echo "上傳完成: $FILE"
|
||||
```
|
||||
|
||||
使用方式:
|
||||
```bash
|
||||
chmod +x upload.sh
|
||||
./upload.sh /path/to/video.mp4
|
||||
```
|
||||
|
||||
### Python 腳本
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""上傳檔案到 Momentry SFTP"""
|
||||
|
||||
import paramiko
|
||||
import sys
|
||||
import os
|
||||
|
||||
def upload_file(local_path, remote_dir="/demo/uploads"):
|
||||
host = "sftpgo.momentry.ddns.net"
|
||||
port = 2022
|
||||
username = "demo"
|
||||
password = "demopassword123"
|
||||
|
||||
transport = paramiko.Transport((host, port))
|
||||
transport.connect(username=username, password=password)
|
||||
sftp = paramiko.SFTPClient.from_transport(transport)
|
||||
|
||||
filename = os.path.basename(local_path)
|
||||
remote_path = f"{remote_dir}/{filename}"
|
||||
|
||||
sftp.put(local_path, remote_path)
|
||||
print(f"已上傳: {filename} -> {remote_path}")
|
||||
|
||||
sftp.close()
|
||||
transport.close()
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) < 2:
|
||||
print("用法: python upload_sftp.py <檔案路徑>")
|
||||
sys.exit(1)
|
||||
|
||||
upload_file(sys.argv[1])
|
||||
```
|
||||
|
||||
安裝依賴:
|
||||
```bash
|
||||
pip install paramiko
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## WebDAV 替代方案
|
||||
|
||||
如果 SFTP 連線有問題,可使用 WebDAV:
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| **URL** | `https://momentry.ddns.net/webdav/` |
|
||||
| **用戶名** | `demo` |
|
||||
| **密碼** | `demopassword123` |
|
||||
|
||||
### curl 使用 WebDAV
|
||||
|
||||
```bash
|
||||
# 上傳
|
||||
curl -u demo:demopassword123 \
|
||||
-T video.mp4 \
|
||||
"https://momentry.ddns.net/webdav/demo/uploads/"
|
||||
|
||||
# 下載
|
||||
curl -u demo:demopassword123 \
|
||||
-o video.mp4 \
|
||||
"https://momentry.ddns.net/webdav/demo/uploads/video.mp4"
|
||||
|
||||
# 列出目錄
|
||||
curl -u demo:demopassword123 \
|
||||
-X PROPFIND \
|
||||
"https://momentry.ddns.net/webdav/demo/" \
|
||||
-H "Depth: 1"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 連線被拒絕
|
||||
|
||||
```bash
|
||||
# 檢查 SFTPGo 是否運行
|
||||
curl -s http://localhost:8080/api/v2/status | jq .status
|
||||
|
||||
# 檢查連接埠
|
||||
nc -zv momentry.ddns.net 2022
|
||||
```
|
||||
|
||||
### 認證失敗
|
||||
|
||||
確認密碼是否正確:
|
||||
```bash
|
||||
# 測試認證
|
||||
curl -u demo:demopassword123 \
|
||||
"https://momentry.ddns.net/webdav/" -I
|
||||
```
|
||||
|
||||
### 權限不足
|
||||
|
||||
上傳目錄可能需要先建立:
|
||||
```bash
|
||||
sshpass -p "demopassword123" sftp -P 2022 demo@sftpgo.momentry.ddns.net <<EOF
|
||||
mkdir uploads
|
||||
mkdir videos
|
||||
bye
|
||||
EOF
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 檔案上傳後自動化
|
||||
|
||||
上傳後,SFTPGo 會自動:
|
||||
1. 觸發 Hook 腳本
|
||||
2. 記錄上傳事件到 `/Users/accusys/sftpgo_test/hook.log`
|
||||
3. 呼叫 Momentry Core API 註冊視頻
|
||||
|
||||
查看上傳日誌:
|
||||
```bash
|
||||
tail -f /Users/accusys/sftpgo_test/hook.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 管理手冊
|
||||
|
||||
### 管理員帳戶
|
||||
|
||||
| 角色 | 用戶名 | 密碼 | 說明 |
|
||||
|------|--------|------|------|
|
||||
| **WebAdmin** | `admin` | `Test3200Test3200` | SFTPGo 管理介面 |
|
||||
|
||||
**WebAdmin URL**: https://sftpgo.momentry.ddns.net
|
||||
|
||||
### Admin 創建方式
|
||||
|
||||
根據官方文檔,SFTPGo 有兩種方式創建管理員:
|
||||
|
||||
#### 方式 1: Web UI (首次設定)
|
||||
|
||||
1. 訪問 `http://localhost:8080/web/admin`
|
||||
2. 如果沒有管理員,會顯示設定畫面
|
||||
3. 輸入用戶名和密碼創建第一個管理員
|
||||
|
||||
#### 方式 2: 自動創建 (推薦)
|
||||
|
||||
需要同時滿足以下條件:
|
||||
1. 配置文件中設定 `"create_default_admin": true`
|
||||
2. 設定環境變數 `SFTPGO_DEFAULT_ADMIN_USERNAME` 和 `SFTPGO_DEFAULT_ADMIN_PASSWORD`
|
||||
|
||||
### 設定步驟
|
||||
|
||||
#### Step 1: 確保配置文件正確
|
||||
|
||||
確認 `/Users/accusys/momentry/etc/sftpgo/sftpgo.json` 中有:
|
||||
```json
|
||||
{
|
||||
"data_provider": {
|
||||
"create_default_admin": true
|
||||
},
|
||||
"httpd": {
|
||||
"setup": {
|
||||
"installation_code": "Test3200Test3200"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Step 2: 更新 plist 加入環境變數
|
||||
|
||||
編輯 `/Library/LaunchDaemons/com.momentry.sftpgo.plist`,加入:
|
||||
```xml
|
||||
<key>EnvironmentVariables</key>
|
||||
<dict>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_USERNAME</key>
|
||||
<string>admin</string>
|
||||
<key>SFTPGO_DEFAULT_ADMIN_PASSWORD</key>
|
||||
<string>Test3200Test3200</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
#### Step 3: 重啟 SFTPGo
|
||||
|
||||
```bash
|
||||
launchctl unload homebrew.mxcl.sftpgo
|
||||
launchctl load homebrew.mxcl.sftpgo
|
||||
```
|
||||
|
||||
#### Step 4: 驗證管理員
|
||||
|
||||
```bash
|
||||
curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200"
|
||||
```
|
||||
|
||||
成功回應:
|
||||
```json
|
||||
{
|
||||
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
|
||||
"token_type": "bearer",
|
||||
"expires_in": 1200
|
||||
}
|
||||
```
|
||||
|
||||
### REST API 認證流程
|
||||
|
||||
#### 1. 獲取 Token
|
||||
|
||||
```bash
|
||||
curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200"
|
||||
```
|
||||
|
||||
#### 2. 使用 Token 訪問 API
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
# 查看所有用戶
|
||||
curl -s http://localhost:8080/api/v2/users \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
|
||||
# 查看系統狀態
|
||||
curl -s http://localhost:8080/api/v2/status \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
### 常用管理操作
|
||||
|
||||
#### 查看所有用戶
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
curl -s http://localhost:8080/api/v2/users \
|
||||
-H "Authorization: Bearer $TOKEN" | jq .
|
||||
```
|
||||
|
||||
#### 建立新用戶
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
curl -s -X POST http://localhost:8080/api/v2/users \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "newuser",
|
||||
"password": "userpassword123",
|
||||
"email": "user@example.com",
|
||||
"status": 1,
|
||||
"home_dir": "/Users/accusys/momentry/var/sftpgo/data/newuser",
|
||||
"uid": 501,
|
||||
"gid": 20,
|
||||
"permissions": {
|
||||
"/": ["*"]
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
#### 建立用戶組
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
curl -s -X POST http://localhost:8080/api/v2/groups \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "editors",
|
||||
"description": "Editor group with upload permissions"
|
||||
}'
|
||||
```
|
||||
|
||||
#### 刪除用戶
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
curl -s -X DELETE http://localhost:8080/api/v2/users/username \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
#### 修改用戶密碼
|
||||
|
||||
```bash
|
||||
TOKEN=$(curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq -r '.access_token')
|
||||
|
||||
curl -s -X PUT http://localhost:8080/api/v2/users/demo \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"password": "newpassword456"
|
||||
}'
|
||||
```
|
||||
|
||||
### 重要設定
|
||||
|
||||
| 設定項目 | 值 | 說明 |
|
||||
|----------|-----|------|
|
||||
| **SFTP 連接埠** | `2022` | SSH 檔案傳輸協定 |
|
||||
| **HTTP/WebDAV 連接埠** | `8080` | 內部 HTTP 服務 |
|
||||
| **WebAdmin 連接埠** | `8080` | 管理介面 (`/web/admin`) |
|
||||
| **WebClient 連接埠** | `8080` | 用戶介面 (`/web/client`) |
|
||||
| **資料庫** | PostgreSQL | 用戶和設定儲存 |
|
||||
| **Hook 腳本** | `/Users/accusys/sftpgo_test/register_hook.sh` | 上傳後自動化處理 |
|
||||
| **安裝碼** | `Test3200Test3200` | 首次設定管理員所需 |
|
||||
| **create_default_admin** | `true` | 自動創建管理員 |
|
||||
| **Token 有效期** | 1200 秒 (20分鐘) | JWT 過期時間 |
|
||||
|
||||
### 用戶目錄結構
|
||||
|
||||
所有 SFTPGo 用戶資料統一存放在 `/Users/accusys/momentry/var/sftpgo/data/` 目錄下:
|
||||
|
||||
| 用戶 | 資料夾路徑 | 密碼 | 說明 |
|
||||
|------|------------|------|------|
|
||||
| **demo** | `/Users/accusys/momentry/var/sftpgo/data/demo` | `demopassword123` | Demo 用戶上傳目錄 |
|
||||
| **momentry** | `/Users/accusys/momentry/var/sftpgo/data/momentry` | `momentry123` | Momentry 系統用戶 |
|
||||
| **warren** | `/Users/accusys/momentry/var/sftpgo/data/warren` | `warren123` | 其他用戶 |
|
||||
|
||||
### API Token 獲取方式
|
||||
|
||||
```bash
|
||||
# 注意:使用 GET 而非 POST
|
||||
curl -s -X GET "http://localhost:8080/api/v2/token" \
|
||||
-u "admin:Test3200Test3200" | jq .access_token
|
||||
```
|
||||
|
||||
### 故障排除
|
||||
|
||||
| 問題 | 解決方案 |
|
||||
|------|----------|
|
||||
| 無法獲取 Token | 確認環境變數已正確設定並重啟 SFTPGo |
|
||||
| SFTP 連線被拒絕 | 檢查 SFTPGo 服務: `launchctl list \| grep sftpgo` |
|
||||
| 無法登入 WebAdmin | 確認 admin 用戶存在: 檢查 plist 中環境變數是否正確 |
|
||||
| 上傳失敗 | 檢查 Hook 腳本: `tail -f /Users/accusys/momentry/log/sftpgo.error.log` |
|
||||
| 權限不足 | 檢查用戶權限或更新 `permissions` 設定 |
|
||||
| API 返回 401 | Token 過期,需重新獲取: `curl -X POST .../token -u "admin:pass"` | |
|
||||
|
||||
---
|
||||
|
||||
## 安全注意事項
|
||||
|
||||
- **密碼保護**: `demopassword123` 為 demo 帳戶密碼
|
||||
- **限制存取**: Demo 用戶只能訪問 `/demo` 目錄
|
||||
- **監控**: 所有上傳都有日誌記錄
|
||||
- **生產環境**: 正式環境應使用更強的密碼和金鑰認證
|
||||
@@ -1,93 +0,0 @@
|
||||
# Stamp Search Progress
|
||||
|
||||
**UUID**: `384b0ff44aaaa1f14cb2cd63b3fea966`
|
||||
**Video**: Charade (1963) - ~115 min
|
||||
**Status**: ⏸️ Paused - User review needed
|
||||
|
||||
## Dialogue Timeline (ASR references to "stamps")
|
||||
|
||||
| Time | Dialogue |
|
||||
|------|----------|
|
||||
| 504s | "but if you went back in the road me a letter you could have the stamps I'll" |
|
||||
| 5519s | "The envelope, but the stamp's on it." |
|
||||
| 5576s | "He was so excited when he got the stamps" |
|
||||
| 5586s | "That's where Jean-Louis trades his stamps." |
|
||||
| 5683s | "I'm sorry, I don't know anything about stamps." |
|
||||
| 5730s | "It's the most valuable stamp in the world." |
|
||||
| 5860s | "It was the stamps on the letter Charles had with him on the train." |
|
||||
| 5868s | "You're not safe as long as you have these stamps." |
|
||||
| 6269s | "Just bring those stamps over here." |
|
||||
| 6275s | "If you take him those stamps, he'll kill you too." |
|
||||
| 6651s | "The truth now, was it my hide or those stamps?" |
|
||||
| 6662s | "and turn in those stamps." |
|
||||
| 6757s | "Now, come on. Give me the stamp." |
|
||||
| 6790s | "I'll give you the stamps. Come on." |
|
||||
| 6813s | "Come on, give me those stamps." |
|
||||
| 6833s | "No, don't change the subject. Just give me the stamps." |
|
||||
| 6846s | "Well, before we start that, may I have the stamps?" |
|
||||
|
||||
## Methods Tried (All returned "都不是" - none matched)
|
||||
|
||||
### 1. Color-Based Detection (Blue + Red for Inverted Jenny)
|
||||
- **Script**: `scripts/filter_stamp_colors.py`
|
||||
- **Candidates**: 21 images
|
||||
- **Location**: `output/384b0ff44aaaa1f14cb2cd63b3fea966/florence2_results/STAMP_CANDIDATE_*.jpg`
|
||||
- **Result**: ❌ Not a match
|
||||
|
||||
### 2. Balanced Blue+Red Shape Detection
|
||||
- **Script**: `scripts/filter_stamp_colors.py` (refined)
|
||||
- **Candidates**: 13 images
|
||||
- **Location**: `output/384b0ff44aaaa1f14cb2cd63b3fea966/florence2_results/BALANCED_STAMP_*.jpg`
|
||||
- **Result**: ❌ Not a match
|
||||
|
||||
### 3. Rectangle Shape + Color Detection (Full Frames)
|
||||
- **Script**: `scripts/detect_stamp_shapes.py`
|
||||
- **Candidates**: 22 crops from 8 scan frames
|
||||
- **Location**: `output/384b0ff44aaaa1f14cb2cd63b3fea966/florence2_results/STAMP_CROP_*.jpg`
|
||||
- **Result**: ❌ Not a match
|
||||
|
||||
### 4. Full Video Scan (every 60 seconds)
|
||||
- **Script**: `scripts/scan_full_video_stamps.py`
|
||||
- **Frames scanned**: 115
|
||||
- **Candidates**: 27 images
|
||||
- **Location**: `output/384b0ff44aaaa1f14cb2cd63b3fea966/stamp_candidates_full/`
|
||||
- **Result**: ❌ Not a match
|
||||
|
||||
### 5. Florence-2 AI Vision
|
||||
- **Script**: `scripts/test_florence2_stamps.py`
|
||||
- **Result**: ❌ Model loading error (`_supports_sdpa` attribute missing)
|
||||
|
||||
### 6. Paper/Envelope Detection at Dialogue Scenes
|
||||
- **Script**: `scripts/scan_charade_stamps.py`
|
||||
- **Frames scanned**: 67 (from key stamp dialogue timestamps)
|
||||
- **Candidates**: 60+ paper-like rectangular crops
|
||||
- **Location**: `output/384b0ff44aaaa1f14cb2cd63b3fea966/stamp_scenes_crops/`
|
||||
- **Result**: ❌ Not a match (or user hasn't reviewed yet)
|
||||
|
||||
## Key Timestamps for Visual Inspection
|
||||
|
||||
The most important scenes where stamps are shown/discussed:
|
||||
|
||||
| Timestamp | Context |
|
||||
|-----------|---------|
|
||||
| 5520s | "The envelope, but the stamp's on it" - likely shows the envelope with stamps |
|
||||
| 5730s | "It's the most valuable stamp in the world" - likely close-up of stamps |
|
||||
| 6270s | "Just bring those stamps over here" - likely shows stamps being exchanged |
|
||||
| 6846s | Final scene about stamps - "may I have the stamps?" |
|
||||
|
||||
## Final Conclusion (2026-04-14)
|
||||
|
||||
**The ONLY scene where stamps are visually shown in the entire movie is the magnifying glass scene at ~5730s.**
|
||||
|
||||
All other scenes where characters discuss stamps (504s, 5519s, 5576s, 5860s, 6269s, 6651s, 6757s, 6846s) do NOT show the stamps on screen. The stamps are presumably in envelopes, pockets, or off-camera. This is intentional cinematic technique - the director only reveals the stamps during the dramatic examination scene.
|
||||
|
||||
### Confirmed Stamp Location
|
||||
|
||||
| Timestamp | Description | Confidence |
|
||||
|-----------|-------------|------------|
|
||||
| **5730s** | "It's the most valuable stamp in the world." + Magnifying glass | ✅ CONFIRMED |
|
||||
| 5733-5735s | Close-up of stamp through magnifying glass | ✅ CONFIRMED |
|
||||
|
||||
### Next Steps (if needed)
|
||||
- Use the 5730s stamp image as a reference for template matching in other videos
|
||||
- Document the stamp appearance for future recognition tasks
|
||||
@@ -1,187 +0,0 @@
|
||||
# 同義詞配置指南
|
||||
|
||||
## 概述
|
||||
|
||||
Momentry Core 支持中文查詢的同義詞擴展功能,可將用戶查詢中的詞語自動擴展為其同義詞,提升搜索召回率。
|
||||
|
||||
**重要:系統不提供預設同義詞資料集**。為了避免版權問題,您需要提供自己的同義詞 JSON 檔案。系統提供擴展機制和示例檔案,但不會自動加載任何同義詞資料。
|
||||
|
||||
主要特性:
|
||||
- **繁簡體中文轉換**:自動將簡體中文查詢轉換為繁體中文(假設資料庫儲存繁體中文)
|
||||
- **同義詞擴展**:將查詢詞語擴展為多個同義詞,使用 OR 邏輯連接
|
||||
- **智能分詞**:對中文文本進行分詞處理,支援混合查詢
|
||||
- **多檔案支持**:可從多個 JSON 檔案加載同義詞映射
|
||||
|
||||
## 配置方法
|
||||
|
||||
### 1. 創建同義詞 JSON 檔案
|
||||
|
||||
同義詞檔案為標準 JSON 格式,鍵值對結構:
|
||||
```json
|
||||
{
|
||||
"原始詞語": ["同義詞1", "同義詞2", "同義詞3"],
|
||||
"電腦": ["計算機", "微机", "筆記本"],
|
||||
"工作": ["任務", "作業", "職責"],
|
||||
"檔案": ["文件", "文檔", "資料"]
|
||||
}
|
||||
```
|
||||
|
||||
**注意事項**:
|
||||
- 詞語需為**繁體中文**(系統會自動轉換簡體查詢)
|
||||
- 同義詞列表可包含多個詞語
|
||||
- 支援單一詞語或多字詞語
|
||||
|
||||
### 2. 環境變量配置
|
||||
|
||||
有兩種方式配置同義詞檔案:
|
||||
|
||||
#### 方式一:單一檔案(推薦)
|
||||
```bash
|
||||
export MOMENTRY_SYNONYM_FILE=/path/to/your/synonyms.json
|
||||
```
|
||||
|
||||
#### 方式二:多個檔案(後面的檔案會覆蓋前面的)
|
||||
```bash
|
||||
export MOMENTRY_SYNONYM_FILES=/path/to/base.json,/path/to/domain.json
|
||||
```
|
||||
|
||||
### 3. 開發環境設置
|
||||
|
||||
在 `.env.development` 或 `.env` 檔案中添加:
|
||||
```bash
|
||||
# 同義詞配置文件(可選)
|
||||
# 取消註釋並設置為您的同義詞JSON檔案路徑以啟用同義詞擴展
|
||||
MOMENTRY_SYNONYM_FILE=/Users/accusys/momentry_core_0.1/data/synonyms.json
|
||||
|
||||
# 多個同義詞檔案(逗號分隔),會覆蓋 MOMENTRY_SYNONYM_FILE
|
||||
# MOMENTRY_SYNONYM_FILES=/path/to/first.json,/path/to/second.json
|
||||
```
|
||||
|
||||
## 使用示例
|
||||
|
||||
### 示例同義詞檔案 (`docs/examples/custom_synonyms.json`)
|
||||
```json
|
||||
{
|
||||
"電腦": ["計算機", "微机"],
|
||||
"視頻": ["影片", "錄像"],
|
||||
"分析": ["解析", "剖析"],
|
||||
"系統": ["體系", "架構"],
|
||||
"用戶": ["使用者", "客戶"],
|
||||
"數據": ["資料", "資訊"],
|
||||
"網絡": ["網路", "互聯網"],
|
||||
"檔案": ["文件", "文檔"],
|
||||
"團體": ["組織", "團隊"],
|
||||
"工作": ["任務", "作業"]
|
||||
}
|
||||
```
|
||||
|
||||
### 查詢擴展示例
|
||||
|
||||
| 原始查詢 | 擴展後查詢 | 說明 |
|
||||
|---------|-----------|------|
|
||||
| `電腦` | `(電腦 | 計算機 | 微机 | 筆記本)` | 單一詞語擴展 |
|
||||
| `電腦 工作` | `(電腦 | 計算機 | 微机) & (工作 | 任務 | 作業)` | 多詞語擴展 |
|
||||
| `視頻分析` | `(視頻 | 影片 | 錄像) & (分析 | 解析 | 剖析)` | 連續詞語擴展 |
|
||||
| `檔案系統` | `(檔案 | 文件 | 文檔) & (系統 | 體系 | 架構)` | 複合詞擴展 |
|
||||
|
||||
### API 使用
|
||||
|
||||
**BM25 搜索端點**:
|
||||
```bash
|
||||
curl -X POST http://localhost:3003/api/v1/search/bm25 \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "電腦工作", "limit": 10}'
|
||||
```
|
||||
|
||||
**n8n 搜索端點**:
|
||||
```bash
|
||||
curl -X POST http://localhost:3003/api/v1/n8n/search/bm25 \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"query": "視頻檔案", "limit": 5}'
|
||||
```
|
||||
|
||||
## 技術細節
|
||||
|
||||
### 擴展邏輯
|
||||
1. **繁簡轉換**:使用 OpenCC 將簡體中文轉換為繁體
|
||||
2. **同義詞查找**:在加載的映射中查找匹配詞語
|
||||
3. **查詢重構**:將原始詞語替換為 `(原始詞語 OR 同義詞1 OR 同義詞2 ...)`
|
||||
4. **分詞處理**:對未匹配部分進行中文分詞
|
||||
5. **TSQUERY 生成**:生成 PostgreSQL 全文搜索查詢語法
|
||||
|
||||
### 分詞處理
|
||||
- 使用 Jieba 分詞器進行中文分詞
|
||||
- 分詞結果用空格分隔,例如:"電腦工作" → "電 腦 工作"
|
||||
- 分詞後每個部分都會加上前綴搜索符號 (`:*`)
|
||||
|
||||
### 性能考慮
|
||||
- 同義詞映射在應用啟動時加載並緩存
|
||||
- 擴展操作在內存中進行,性能影響最小
|
||||
- 支援大量同義詞映射(數千條)
|
||||
|
||||
## 除錯與測試
|
||||
|
||||
### 檢查同義詞加載
|
||||
查看應用日誌中是否有以下訊息:
|
||||
```
|
||||
Loaded synonym expander from /path/to/synonyms.json
|
||||
```
|
||||
|
||||
### 測試擴展功能
|
||||
使用內建測試工具:
|
||||
```bash
|
||||
cargo run --bin test_synonym_expansion
|
||||
```
|
||||
|
||||
### 手動測試
|
||||
創建測試程式檢查擴展結果:
|
||||
```rust
|
||||
use momentry_core::core::text::global_synonym_expander;
|
||||
|
||||
let expander = global_synonym_expander();
|
||||
println!("擴展 '電腦': {}", expander.expand_word("電腦"));
|
||||
println!("擴展 '電腦 工作': {}", expander.expand_query("電腦 工作"));
|
||||
```
|
||||
|
||||
## 注意事項
|
||||
|
||||
1. **詞語格式**:確保同義詞檔案中的詞語為繁體中文
|
||||
2. **檔案編碼**:使用 UTF-8 編碼保存 JSON 檔案
|
||||
3. **重啟需求**:修改同義詞檔案後需要重啟應用才能生效
|
||||
4. **版本兼容**:同義詞功能需 Momentry Core 0.1.0 以上版本
|
||||
5. **版權注意**:請使用自創或已獲授權的同義詞資料,避免使用受版權保護的詞庫
|
||||
|
||||
## 進階配置
|
||||
|
||||
### 領域特定同義詞
|
||||
為不同領域創建專用同義詞檔案:
|
||||
- `technical_terms.json` - 技術術語
|
||||
- `business_terms.json` - 商業術語
|
||||
- `industry_terms.json` - 行業術語
|
||||
|
||||
通過 `MOMENTRY_SYNONYM_FILES` 加載多個檔案。
|
||||
|
||||
### 動態更新(計劃中)
|
||||
未來版本將支援:
|
||||
- 熱重載同義詞檔案
|
||||
- API 端點管理同義詞
|
||||
- 用戶自定義同義詞
|
||||
|
||||
---
|
||||
|
||||
## 附錄
|
||||
|
||||
### 示例同義詞檔案
|
||||
- 基礎示例:`docs/examples/custom_synonyms.json`
|
||||
- 舊示例(僅供參考):`data/synonyms.json`
|
||||
- 領域示例(僅供參考):`data/domain_synonyms.json`
|
||||
|
||||
**注意**:這些檔案僅作為格式示例,系統不會自動加載。您需要設置 `MOMENTRY_SYNONYM_FILE` 環境變量指向您自己的同義詞檔案。
|
||||
|
||||
### 相關程式檔案
|
||||
- 同義詞擴展器:`src/core/text/synonym_expander.rs`
|
||||
- 繁簡轉換:`src/core/text/synonym.rs`
|
||||
- 分詞器:`src/core/text/tokenizer.rs`
|
||||
- PostgreSQL 整合:`src/core/db/postgres_db.rs`
|
||||
@@ -1,209 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "MOMENTRY_CORE"
|
||||
title: "同義詞林安裝與多語系支援"
|
||||
date: "2026-04-25"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "同義詞林安裝與多語系支援"
|
||||
ai_query_hints:
|
||||
- "查詢 同義詞林安裝與多語系支援 的內容"
|
||||
- "同義詞林安裝與多語系支援 的主要目的是什麼?"
|
||||
- "如何操作或實施 同義詞林安裝與多語系支援?"
|
||||
---
|
||||
|
||||
# 同義詞林安裝與多語系支援
|
||||
|
||||
## 概述
|
||||
|
||||
本文檔總結 Momentry Core 系統的同義詞林安裝指南和多語系支援功能。系統提供完整的同義詞擴展功能,支援多種語言,但**不提供預設同義詞資料**,客戶需自行準備合法資源。
|
||||
|
||||
## 主要文件
|
||||
|
||||
### 1. 安裝指南
|
||||
- **[INSTALL_SYNONYM_FOREST.md](INSTALL_SYNONYM_FOREST.md)** - 完整的同義詞林安裝指南,包含:
|
||||
- 尋找合法同義詞資源
|
||||
- 格式轉換和配置
|
||||
- 自定義同義詞編輯方法
|
||||
- 多語系解決方案
|
||||
- 測試和故障排除
|
||||
|
||||
### 2. 多語系示例文件
|
||||
|
||||
#### 跨語言同義詞庫
|
||||
- **`docs_v1.0/examples/multilingual/multilingual_synonyms.json`**
|
||||
- 中英對照同義詞示例
|
||||
- 包含科技相關術語
|
||||
- 支援繁簡體中文轉換
|
||||
|
||||
#### 統一格式多語系同義詞庫
|
||||
- **`docs_v1.0/examples/multilingual/unified_multilingual_synonyms.json`**
|
||||
- 統一格式的多語系同義詞庫
|
||||
- 支援中、英、日、韓四種語言
|
||||
- 包含翻譯映射和同義詞組
|
||||
|
||||
#### 語言路由配置
|
||||
- **`docs_v1.0/examples/multilingual/language_routing.json`**
|
||||
- 語言路由配置示例
|
||||
- 支援多種語言檢測方法
|
||||
- 包含跨語言回退策略
|
||||
|
||||
### 3. 工具腳本
|
||||
|
||||
#### 語言檢測工具
|
||||
- **`scripts/detect_language.py`**
|
||||
- 檢測文本語言
|
||||
- 支援中、英、日、韓等語言
|
||||
- 輸出置信度和詳細分數
|
||||
|
||||
#### 語言路由工具
|
||||
- **`scripts/language_router.py`**
|
||||
- 根據語言路由到相應同義詞庫
|
||||
- 支援語言變體和回退
|
||||
- 可配置路由策略
|
||||
|
||||
#### 統一格式處理器
|
||||
- **`scripts/unified_synonym_processor.py`**
|
||||
- 處理統一格式多語系同義詞庫
|
||||
- 提取特定語言同義詞
|
||||
- 創建跨語言映射
|
||||
- 搜索術語和導出標準格式
|
||||
|
||||
#### 測試腳本
|
||||
- **`scripts/test_multilingual.sh`**
|
||||
- 測試多語系功能
|
||||
- 驗證工具運作
|
||||
- 生成測試輸出
|
||||
|
||||
## 多語系支援方案
|
||||
|
||||
### 方案 1: 跨語言同義詞庫
|
||||
- 單一檔案包含多種語言
|
||||
- 適合簡單的多語系需求
|
||||
- 配置簡單,維護方便
|
||||
|
||||
### 方案 2: 語言專用同義詞庫
|
||||
- 每個語言獨立檔案
|
||||
- 適合複雜的多語系需求
|
||||
- 支援語言檢測和路由
|
||||
|
||||
### 方案 3: 統一格式多語系同義詞庫
|
||||
- 統一格式包含所有語言
|
||||
- 支援翻譯映射
|
||||
- 可動態提取特定語言
|
||||
|
||||
## 版權政策
|
||||
|
||||
**重要**: Momentry Core 系統**不提供**任何預設同義詞資料。客戶必須:
|
||||
|
||||
1. **自行尋找合法資源** - 使用開源或合法授權的同義詞林
|
||||
2. **遵守版權規定** - 確保使用的資源符合版權法
|
||||
3. **自行轉換格式** - 將資源轉換為系統支援的 JSON 格式
|
||||
4. **自行維護更新** - 定期更新同義詞庫
|
||||
|
||||
系統僅提供:
|
||||
- 格式規範和配置方法
|
||||
- 工具腳本和示例文件
|
||||
- 安裝和測試指南
|
||||
|
||||
## 快速開始
|
||||
|
||||
### 步驟 1: 準備同義詞資源
|
||||
```bash
|
||||
# 1. 尋找合法同義詞資源
|
||||
# 2. 轉換為 JSON 格式
|
||||
# 3. 保存到 config/synonyms/ 目錄
|
||||
```
|
||||
|
||||
### 步驟 2: 配置系統
|
||||
```bash
|
||||
# 編輯配置文件
|
||||
vim config/momentry.toml
|
||||
|
||||
# 添加同義詞配置
|
||||
[synonym]
|
||||
enabled = true
|
||||
files = [
|
||||
"config/synonyms/custom_synonyms.json",
|
||||
"config/synonyms/tech_synonyms.json"
|
||||
]
|
||||
```
|
||||
|
||||
### 步驟 3: 測試功能
|
||||
```bash
|
||||
# 運行測試腳本
|
||||
./scripts/test_multilingual.sh
|
||||
|
||||
# 測試同義詞擴展
|
||||
cargo run --bin test_synonym_expansion -- --text "測試文本"
|
||||
```
|
||||
|
||||
### 步驟 4: 多語系配置(可選)
|
||||
```bash
|
||||
# 配置多語系支援
|
||||
cp docs_v1.0/examples/multilingual/language_routing.json config/
|
||||
|
||||
# 編輯路由配置
|
||||
vim config/language_routing.json
|
||||
```
|
||||
|
||||
## 進階功能
|
||||
|
||||
### 自定義同義詞編輯
|
||||
- 直接編輯 JSON 檔案
|
||||
- 使用 Python 腳本編輯
|
||||
- 建立領域專用同義詞庫
|
||||
- 合併多個同義詞檔案
|
||||
|
||||
### 質量檢查
|
||||
- 檢查重複項
|
||||
- 驗證格式
|
||||
- 測試同義詞擴展
|
||||
- 性能測試
|
||||
|
||||
### 版本控制
|
||||
- 使用 Git 管理變更
|
||||
- 建立版本歷史
|
||||
- 備份同義詞庫
|
||||
- 回滾錯誤修改
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 常見問題
|
||||
1. **同義詞未生效** - 檢查配置檔案路徑和格式
|
||||
2. **性能問題** - 減少同義詞數量或優化結構
|
||||
3. **記憶體不足** - 分割大型同義詞庫
|
||||
4. **語言檢測錯誤** - 調整檢測規則或使用明確語言標記
|
||||
|
||||
### 調試工具
|
||||
```bash
|
||||
# 檢查同義詞加載
|
||||
cargo run --bin test_synonym_expansion -- --debug
|
||||
|
||||
# 測試語言檢測
|
||||
python3 scripts/detect_language.py -v "測試文本"
|
||||
|
||||
# 驗證 JSON 格式
|
||||
python3 -m json.tool config/synonyms/custom_synonyms.json
|
||||
```
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [SYNONYM_CONFIGURATION.md](../SYNONYM_CONFIGURATION.md) - 同義詞配置指南
|
||||
- [PROJECT_DOCS_V1_INTEGRATION_PLAN.md](../PROJECT_DOCS_V1_INTEGRATION_PLAN.md) - 文件整合計劃
|
||||
- [API_SYNONYM.md](../API/API_SYNONYM.md) - 同義詞 API 文檔
|
||||
|
||||
## 支援與反饋
|
||||
|
||||
如有問題或建議,請:
|
||||
1. 查閱相關文件
|
||||
2. 使用測試腳本驗證功能
|
||||
3. 檢查系統日誌
|
||||
4. 提交問題報告
|
||||
|
||||
---
|
||||
|
||||
**注意**: 本系統僅提供技術框架和工具,客戶需自行負責同義詞資源的合法性、準確性和維護工作。
|
||||
@@ -1,425 +0,0 @@
|
||||
# 統一會員系統 + 影片歸屬追蹤實作計畫
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-24 |
|
||||
| 文件版本 | V1.0 |
|
||||
| 狀態 | 待確認 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 |
|
||||
|------|------|------|--------|
|
||||
| V1.0 | 2026-03-24 | 創建實作計畫 | OpenCode |
|
||||
|
||||
---
|
||||
|
||||
## 1. 背景與目標
|
||||
|
||||
### 1.1 現有問題
|
||||
|
||||
目前 Momentry 生態系統中,各服務有獨立的用戶管理:
|
||||
|
||||
| 服務 | 用戶系統 | 問題 |
|
||||
|------|----------|------|
|
||||
| WordPress | wp_users (2 admin) | 無會員系統,無 API 認證 |
|
||||
| SFTPGo | users 表 (3 users) | 獨立管理 |
|
||||
| n8n | users 表 | 獨立管理 |
|
||||
| Gitea | `user` 表 | 獨立管理 |
|
||||
| Momentry Core | api_keys (未啟用) | 無 user 關聯 |
|
||||
|
||||
**問題**:
|
||||
1. 無法追蹤影片歸屬(誰上傳的影片)
|
||||
2. 無法實作 per-user 配額管理
|
||||
3. API 端點全部公開,無認證
|
||||
4. 用戶創建需要多處操作
|
||||
|
||||
### 1.2 目標
|
||||
|
||||
建立統一的會員系統,讓 WordPress 成為唯一登入入口:
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 目標架構 │
|
||||
├─────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ WordPress (會員系統) │
|
||||
│ │ │
|
||||
│ ├─► SFTPGo (檔案上傳) │
|
||||
│ ├─► Momentry Core (影片處理) │
|
||||
│ └─► n8n (自動化流程) │
|
||||
│ │
|
||||
│ 統一的 user_id 追蹤 │
|
||||
│ │ │
|
||||
│ └─► videos 表關聯 user_id │
|
||||
│ └─► monitor_jobs 表關聯 user_id │
|
||||
│ └─► per-user 配額管理 │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. 現有系統分析
|
||||
|
||||
### 2.1 WordPress
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| 安裝插件 | Elementor, Akismet, Code Snippets, All-in-One WP Migration |
|
||||
| 用戶表 | wp_users (2 users: wp_user, sc_demo) |
|
||||
| 會員插件 | 無 |
|
||||
| REST API | 標準端點 (`/wp-json/wp/v2/users`) |
|
||||
| 認證方式 | Cookie / Application Passwords |
|
||||
| JWT | 無 |
|
||||
|
||||
### 2.2 SFTPGo
|
||||
|
||||
| 項目 | 值 |
|
||||
|------|-----|
|
||||
| 用戶數 | 3 (demo, warren, momentry) |
|
||||
| API | REST API v2 (`/api/v2/users`) |
|
||||
| Admin | admin:Test3200Test3200 |
|
||||
| Hook | `/Users/accusys/sftpgo_test/register_hook.sh` |
|
||||
|
||||
### 2.3 Momentry Core
|
||||
|
||||
| 項目 | 狀態 |
|
||||
|------|------|
|
||||
| api_keys 表 | 已存在 |
|
||||
| users 表 | 不存在 |
|
||||
| videos.user_id | 不存在 |
|
||||
| API 認證 | 未啟用(所有端點公開) |
|
||||
|
||||
---
|
||||
|
||||
## 3. 實作計畫
|
||||
|
||||
### Phase 1: WordPress 認證機制啟用
|
||||
|
||||
#### 1.1 啟用 Application Passwords
|
||||
|
||||
**WordPress 5.6+ 內建功能**,無需額外插件。
|
||||
|
||||
```php
|
||||
// wp-config.php (如需自訂設定)
|
||||
define('WP APPLICATION_PASSWORDS_ENABLED', true);
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```bash
|
||||
# Basic Auth 格式
|
||||
curl -X POST "https://wp.momentry.ddns.net/wp-json/wp/v2/users" \
|
||||
-u "username:application_password" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"username": "newuser", "email": "user@example.com", "password": "password"}'
|
||||
```
|
||||
|
||||
#### 1.2 測試 WordPress REST API
|
||||
|
||||
```bash
|
||||
# 取得用戶列表(需要 admin 權限)
|
||||
curl -s -u "wp_user:xxxx xxxx xxxx xxxx xxxx xxxx" \
|
||||
"https://wp.momentry.ddns.net/wp-json/wp/v2/users"
|
||||
|
||||
# 創建新用戶
|
||||
curl -X POST "https://wp.momentry.ddns.net/wp-json/wp/v2/users" \
|
||||
-u "wp_user:xxxx xxxx xxxx xxxx xxxx xxxx" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "testuser",
|
||||
"email": "test@example.com",
|
||||
"password": "TestPass123!",
|
||||
"roles": ["subscriber"]
|
||||
}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Phase 2: 資料庫結構調整
|
||||
|
||||
#### 2.1 新增 users 表(Momentry Core)
|
||||
|
||||
```sql
|
||||
-- migrations/002_user_management.sql
|
||||
|
||||
CREATE TABLE users (
|
||||
id BIGSERIAL PRIMARY KEY,
|
||||
wordpress_id BIGINT UNIQUE NOT NULL,
|
||||
username VARCHAR(60) NOT NULL,
|
||||
email VARCHAR(100) NOT NULL,
|
||||
api_key_hash VARCHAR(64),
|
||||
quota_size BIGINT DEFAULT 10737418240, -- 10GB
|
||||
quota_used BIGINT DEFAULT 0,
|
||||
sftpgo_username VARCHAR(60),
|
||||
status VARCHAR(20) DEFAULT 'active', -- active, suspended, deleted
|
||||
created_at TIMESTAMPTZ DEFAULT NOW(),
|
||||
updated_at TIMESTAMPTZ DEFAULT NOW()
|
||||
);
|
||||
|
||||
CREATE INDEX idx_users_wordpress_id ON users(wordpress_id);
|
||||
CREATE INDEX idx_users_username ON users(username);
|
||||
|
||||
-- videos 表新增 user_id
|
||||
ALTER TABLE videos ADD COLUMN user_id BIGINT REFERENCES users(id);
|
||||
CREATE INDEX idx_videos_user_id ON videos(user_id);
|
||||
|
||||
-- monitor_jobs 表新增 user_id
|
||||
ALTER TABLE monitor_jobs ADD COLUMN user_id BIGINT REFERENCES users(id);
|
||||
CREATE INDEX idx_monitor_jobs_user_id ON monitor_jobs(user_id);
|
||||
|
||||
-- api_keys 表新增 user_id
|
||||
ALTER TABLE api_keys ADD COLUMN user_id BIGINT REFERENCES users(id);
|
||||
```
|
||||
|
||||
#### 2.2 更新 api_keys 表結構
|
||||
|
||||
```sql
|
||||
-- 新增欄位
|
||||
ALTER TABLE api_keys ADD COLUMN user_id BIGINT REFERENCES users(id);
|
||||
ALTER TABLE api_keys ADD COLUMN wordpress_id BIGINT;
|
||||
ALTER TABLE api_keys ADD COLUMN sftpgo_username VARCHAR(60);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Phase 3: API 認證中介層
|
||||
|
||||
#### 3.1 中介層設計
|
||||
|
||||
```rust
|
||||
// src/api/middleware/auth.rs
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct AuthState {
|
||||
pub db: Arc<PostgresDb>,
|
||||
pub cache: Arc<RedisCache>,
|
||||
}
|
||||
|
||||
pub async fn auth_middleware(
|
||||
req: Request,
|
||||
next: Next,
|
||||
state: AuthState,
|
||||
) -> Result<Response, StatusCode> {
|
||||
// 1. 從 Header 提取 API Key
|
||||
// Header: X-API-Key: muser_xxx
|
||||
// 或: Authorization: Bearer muser_xxx
|
||||
|
||||
// 2. 驗證並取得 user_id
|
||||
let user_id = validate_api_key(&req, &state).await?;
|
||||
|
||||
// 3. 附加到 request extensions
|
||||
req.extensions_mut().insert(UserContext { user_id });
|
||||
|
||||
// 4. 執行 handler
|
||||
next.call(req).await
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct UserContext {
|
||||
pub user_id: i64,
|
||||
}
|
||||
```
|
||||
|
||||
#### 3.2 API Key 格式更新
|
||||
|
||||
```
|
||||
新格式: muser_{uuid}_{timestamp}_{random}_{user_id_hash}
|
||||
```
|
||||
|
||||
| 欄位 | 說明 |
|
||||
|------|------|
|
||||
| 前綴 | `muser_` = User 類型 |
|
||||
| uuid | 唯一識別碼 |
|
||||
| timestamp | 創建時間戳 |
|
||||
| random | 隨機字串 |
|
||||
| user_id_hash | 壓縮的 user_id |
|
||||
|
||||
---
|
||||
|
||||
### Phase 4: 更新 Register API
|
||||
|
||||
#### 4.1 修改 register 端點
|
||||
|
||||
```rust
|
||||
// POST /api/v1/register
|
||||
pub async fn register(
|
||||
State(state): State<ApiState>,
|
||||
Json(req): Json<RegisterRequest>,
|
||||
Extension(ctx): Extension<UserContext>, // 新增
|
||||
) -> Result<Json<RegisterResponse>, StatusCode> {
|
||||
// ... 現有邏輯 ...
|
||||
|
||||
// 驗證用戶配額
|
||||
let user = state.db.get_user(ctx.user_id).await?;
|
||||
if user.quota_used + file_size > user.quota_size {
|
||||
return Err(StatusCode::FORBIDDEN);
|
||||
}
|
||||
|
||||
// 關聯 user_id 到影片
|
||||
let file_uuid = state.db.create_video(req, Some(ctx.user_id)).await?;
|
||||
|
||||
// 建立 processing job(帶 user_id)
|
||||
state.db.create_monitor_job(
|
||||
job_type: "auto_ingestion",
|
||||
file_uuid,
|
||||
user_id: Some(ctx.user_id),
|
||||
processors: vec!["asr", "cut", "yolo", "ocr", "face", "pose"],
|
||||
).await?;
|
||||
|
||||
Ok(Json(RegisterResponse { uuid: file_uuid }))
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Phase 5: n8n 自動化流程
|
||||
|
||||
#### 5.1 用戶註冊 Workflow
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ WordPress 用戶註冊自動化流程 │
|
||||
├─────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ Trigger: Webhook (或 WordPress Plugin) │
|
||||
│ │
|
||||
│ Step 1: 驗證管理員權限 │
|
||||
│ └─► 檢查 WordPress REST API 憑證 │
|
||||
│ │
|
||||
│ Step 2: 在 Momentry Core 建立用戶記錄 │
|
||||
│ └─► POST /api/v1/admin/users │
|
||||
│ └─► 產生 API Key │
|
||||
│ │
|
||||
│ Step 3: 在 SFTPGo 建立用戶 │
|
||||
│ └─► POST /api/v2/users (SFTPGo API) │
|
||||
│ └─► 設定 home_dir: /data/{username} │
|
||||
│ │
|
||||
│ Step 4: 更新用戶記錄 │
|
||||
│ └─► 關聯 sftpgo_username │
|
||||
│ │
|
||||
│ Step 5: 發送歡迎 email │
|
||||
│ └─► 包含 SFTP 登入資訊 │
|
||||
│ └─► 包含 API Key │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
#### 5.2 SFTPGo Hook 更新
|
||||
|
||||
```bash
|
||||
# /Users/accusys/sftpgo_test/register_hook.sh
|
||||
|
||||
# 修改為傳遞 user_id
|
||||
curl -X POST "http://localhost:3002/api/v1/register" \
|
||||
-H "X-API-Key: ${SFTPGO_USER_API_KEY}" \
|
||||
-H "X-SFTPGo-User: ${SFTPGO_USERNAME}" \
|
||||
-d "{\"path\": \"${SFTPGO_FILE_PATH}\"}"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 實作優先順序
|
||||
|
||||
| Phase | 任務 | 複雜度 | 優先級 | 預估工時 |
|
||||
|-------|------|--------|--------|----------|
|
||||
| 1.1 | 測試 WordPress Application Passwords | 低 | P0 | 1h |
|
||||
| 1.2 | 為 WordPress 產生 Application Password | 低 | P0 | 0.5h |
|
||||
| 2.1 | 建立 users 表 migration | 中 | P0 | 2h |
|
||||
| 2.2 | 更新 videos, monitor_jobs 表 | 低 | P0 | 1h |
|
||||
| 3.1 | 實作 API auth middleware | 中 | P0 | 4h |
|
||||
| 3.2 | 更新 register API 接受 user_id | 低 | P0 | 2h |
|
||||
| 4 | 建立 admin users API | 中 | P1 | 4h |
|
||||
| 5.1 | 建立 n8n 用戶註冊 workflow | 中 | P1 | 6h |
|
||||
| 5.2 | 更新 SFTPGo hook | 低 | P1 | 2h |
|
||||
| 6 | 實作配額管理 | 中 | P2 | 4h |
|
||||
| 7 | 測試與驗證 | 中 | P2 | 4h |
|
||||
|
||||
**總預估工時**: ~30.5h
|
||||
|
||||
---
|
||||
|
||||
## 5. 待確認事項
|
||||
|
||||
### 5.1 WordPress 用戶建立方式
|
||||
|
||||
- [ ] 手動在 wp-admin 建立?還是透過 Elementor 表單?
|
||||
- [ ] 是否需要 email 驗證?
|
||||
- [ ] 初始角色設定(subscriber / contributor)?
|
||||
|
||||
### 5.2 API Key 格式
|
||||
|
||||
- [ ] 維持現有 `muser_` 前綴格式?
|
||||
- [ ] 還是建立新的用戶專用 key 格式?
|
||||
- [ ] 是否需要 JWT token?
|
||||
|
||||
### 5.3 SFTPGo 整合
|
||||
|
||||
- [ ] 每個 WordPress 用戶對應一個 SFTPGo 用戶?
|
||||
- [ ] home_dir 命名規則?(如 `data/{wordpress_username}`)
|
||||
- [ ] SFTPGo 配額是否同步?
|
||||
|
||||
### 5.4 配額管理
|
||||
|
||||
- [ ] 每人預設 10GB 空間?
|
||||
- [ ] 超出配額如何處理?(阻止上傳 / 警告)
|
||||
- [ ] 配額用完後是否暫停 SFTPGo 用戶?
|
||||
|
||||
### 5.5 資料同步
|
||||
|
||||
- [ ] WordPress 用戶刪除時是否同步刪除其他系統?
|
||||
- [ ] 用戶停權時的處理流程?
|
||||
|
||||
---
|
||||
|
||||
## 6. 參考文件
|
||||
|
||||
### 內部文件
|
||||
|
||||
| 文件 | 用途 |
|
||||
|------|------|
|
||||
| `docs/PENDING_ISSUES.md` | 待解決問題追蹤 |
|
||||
| `docs/API_KEY_MANAGEMENT.md` | API Key 管理系統 |
|
||||
| `docs/API_REFERENCE.md` | API 端點參考 |
|
||||
| `docs/SFTPGO_DEMO_USER.md` | SFTPGo 用戶設定 |
|
||||
| `docs/N8N_INTEGRATION_GUIDE.md` | n8n 整合指南 |
|
||||
| `docs/INSTALL_WORDPRESS.md` | WordPress 安裝指南 |
|
||||
|
||||
### 外部資源
|
||||
|
||||
| 資源 | URL |
|
||||
|------|-----|
|
||||
| WordPress REST API | https://developer.wordpress.org/rest-api/ |
|
||||
| WordPress Application Passwords | https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/#authentication-plugins |
|
||||
| SFTPGo REST API | https://docs.sftpgo.com/latest/rest-api/ |
|
||||
|
||||
---
|
||||
|
||||
## 7. 附錄
|
||||
|
||||
### A. 現有使用者資料
|
||||
|
||||
#### WordPress (wp_users)
|
||||
| ID | user_login | user_email | display_name |
|
||||
|----|------------|------------|--------------|
|
||||
| 1 | wp_user | marketing@accusys.com.tw | wp_user |
|
||||
| 2 | sc_demo | susan.cheng@accusys.com.tw | Susan Cheng |
|
||||
|
||||
#### SFTPGo (users)
|
||||
| username | email | home_dir | status |
|
||||
|----------|-------|----------|--------|
|
||||
| demo | demo@momentry.local | /Users/accusys/momentry/var/sftpgo/data/demo | Active |
|
||||
| warren | warren@momentry.local | /Users/accusys/momentry/var/sftpgo/data/warren | Active |
|
||||
| momentry | system@momentry.local | /Users/accusys/momentry/var/sftpgo/data/momentry | Active |
|
||||
|
||||
### B. 服務端口
|
||||
|
||||
| 服務 | Port | URL |
|
||||
|------|------|-----|
|
||||
| WordPress | 9000 (PHP-FPM) | https://wp.momentry.ddns.net |
|
||||
| SFTPGo | 8080 | http://localhost:8080 |
|
||||
| Momentry API | 3002 | http://localhost:3002 |
|
||||
| n8n | 5678 | http://localhost:5678 |
|
||||
@@ -1,246 +0,0 @@
|
||||
# Video Registration
|
||||
|
||||
| 項目 | 內容 |
|
||||
|------|------|
|
||||
| 建立者 | Warren |
|
||||
| 建立時間 | 2026-03-25 |
|
||||
| 文件版本 | V1.1 |
|
||||
|
||||
---
|
||||
|
||||
## 版本歷史
|
||||
|
||||
| 版本 | 日期 | 目的 | 操作人 | 工具/模型 |
|
||||
|------|------|------|--------|-----------|
|
||||
| V1.0 | 2026-03-25 | 創建文件 | Warren | OpenCode |
|
||||
| V1.1 | 2026-03-26 | 修正 curl 範例,新增 API Key 驗證標頭 | OpenCode | deepseek-reasoner |
|
||||
|
||||
---
|
||||
|
||||
## 概述
|
||||
|
||||
影片註冊 API (`POST /api/v1/register`) 用於將影片加入 Momentry Core 系統進行處理。
|
||||
|
||||
## 路徑格式
|
||||
|
||||
### 支援的路徑格式
|
||||
|
||||
| 格式 | 範例 | 說明 |
|
||||
|------|------|------|
|
||||
| 相對路徑 | `./demo/video.mp4` | 推薦格式 |
|
||||
| 相對路徑(無 ./) | `demo/video.mp4` | 自動加上 `./` |
|
||||
| 絕對路徑 | `/Users/.../sftpgo/data/demo/video.mp4` | 支援但不推薦 |
|
||||
|
||||
### 路徑結構
|
||||
|
||||
```
|
||||
./username/filepath
|
||||
│ │ │
|
||||
│ │ └── 檔案路徑(可以是多層目錄)
|
||||
│ └── 使用者名稱(SFTPgo 用戶目錄名稱)
|
||||
└── 相對路徑前綴
|
||||
```
|
||||
|
||||
**範例**:
|
||||
- `./demo/video.mp4` → username=`demo`, filepath=`video.mp4`
|
||||
- `./demo/movies/2024/video.mp4` → username=`demo`, filepath=`movies/2024/video.mp4`
|
||||
- `./warren/project1/interview.mp4` → username=`warren`, filepath=`project1/interview.mp4`
|
||||
|
||||
## UUID 計算
|
||||
|
||||
### 計算規則
|
||||
|
||||
```
|
||||
UUID = SHA256(username/filepath)[0:16]
|
||||
```
|
||||
|
||||
**範例**:
|
||||
```rust
|
||||
// 路徑: ./demo/video.mp4
|
||||
// username: "demo"
|
||||
// filepath: "video.mp4"
|
||||
// key: "demo/video.mp4"
|
||||
// UUID: SHA256("demo/video.mp4")[0:16]
|
||||
```
|
||||
|
||||
### 特性
|
||||
|
||||
| 特性 | 說明 |
|
||||
|------|------|
|
||||
| 用戶隔離 | 不同用戶的相同檔名會產生不同 UUID |
|
||||
| 一致性 | 相同相對路徑一定產生相同 UUID |
|
||||
| 遷移安全 | SFTPgo 資料路徑變更後 UUID 保持一致 |
|
||||
|
||||
### 範例
|
||||
|
||||
```rust
|
||||
// 用戶 demo 的影片
|
||||
compute_uuid_from_relative_path("./demo/video.mp4")
|
||||
// → "9760d0820f0cf9a7"
|
||||
|
||||
// 用戶 warren 的相同檔名影片
|
||||
compute_uuid_from_relative_path("./warren/video.mp4")
|
||||
// → "a1b2c3d4e5f6g7h8" (不同的 UUID)
|
||||
```
|
||||
|
||||
## 重複註冊檢查
|
||||
|
||||
### 行為
|
||||
|
||||
1. 系統檢查 UUID 是否已存在於資料庫
|
||||
2. 如果存在,返回 `already_exists: true` 和現有影片資訊
|
||||
3. 如果不存在,創建新的影片記錄
|
||||
|
||||
### API 回應
|
||||
|
||||
**新註冊**:
|
||||
```json
|
||||
{
|
||||
"uuid": "9760d0820f0cf9a7",
|
||||
"video_id": 18,
|
||||
"job_id": 2,
|
||||
"file_name": "video.mp4",
|
||||
"duration": 159.637188,
|
||||
"width": 640,
|
||||
"height": 360,
|
||||
"already_exists": false
|
||||
}
|
||||
```
|
||||
|
||||
**重複註冊**:
|
||||
```json
|
||||
{
|
||||
"uuid": "9760d0820f0cf9a7",
|
||||
"video_id": 18,
|
||||
"job_id": 2,
|
||||
"file_name": "video.mp4",
|
||||
"duration": 159.637188,
|
||||
"width": 640,
|
||||
"height": 360,
|
||||
"already_exists": true
|
||||
}
|
||||
```
|
||||
|
||||
## SFTPgo 整合
|
||||
|
||||
### 目錄結構
|
||||
|
||||
SFTPgo 的用戶目錄結構:
|
||||
|
||||
```
|
||||
/Users/accusys/momentry/var/sftpgo/data/
|
||||
├── demo/ ← 用戶目錄
|
||||
│ ├── video.mp4
|
||||
│ └── movies/
|
||||
│ └── movie1.mp4
|
||||
├── warren/ ← 用戶目錄
|
||||
│ └── project1/
|
||||
│ └── interview.mp4
|
||||
└── momentry/ ← 用戶目錄
|
||||
└── presentation.mp4
|
||||
```
|
||||
|
||||
### 註冊流程
|
||||
|
||||
1. SFTPgo 用戶上傳檔案到各自的目錄
|
||||
2. n8n 或其他服務調用註冊 API
|
||||
3. 使用相對路徑格式:`./username/filepath`
|
||||
4. 系統計算 UUID 並檢查重複
|
||||
5. 創建處理任務
|
||||
|
||||
## 程式碼範例
|
||||
|
||||
### 註冊影片
|
||||
|
||||
```bash
|
||||
# 使用相對路徑註冊
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "./demo/video.mp4"}'
|
||||
|
||||
# 或使用多層目錄
|
||||
curl -X POST http://localhost:3002/api/v1/register \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "./demo/movies/2024/video.mp4"}'
|
||||
```
|
||||
|
||||
### UUID 計算函數
|
||||
|
||||
```rust
|
||||
// 使用相對路徑計算 UUID
|
||||
pub fn compute_uuid_from_relative_path(relative_path: &str) -> String {
|
||||
let (username, filepath) = extract_user_from_relative_path(relative_path);
|
||||
compute_uuid(&username, &filepath)
|
||||
}
|
||||
|
||||
// 從相對路徑提取用戶名和檔案路徑
|
||||
pub fn extract_user_from_relative_path(relative_path: &str) -> (String, String) {
|
||||
let path = relative_path.strip_prefix("./").unwrap_or(relative_path);
|
||||
let path_buf = PathBuf::from(path);
|
||||
|
||||
let mut components = path_buf.components();
|
||||
let username = components
|
||||
.next()
|
||||
.map(|c| c.as_os_str().to_string_lossy().to_string())
|
||||
.unwrap_or_default();
|
||||
|
||||
let filepath: String = components
|
||||
.map(|c| c.as_os_str().to_string_lossy().to_string())
|
||||
.collect::<Vec<_>>()
|
||||
.join("/");
|
||||
|
||||
(username, filepath)
|
||||
}
|
||||
```
|
||||
|
||||
## 相關 API
|
||||
|
||||
### Probe API(僅探測,不註冊)
|
||||
|
||||
如果只需要取得影片資訊而不註冊,可以使用 Probe API:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3002/api/v1/probe \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: YOUR_API_KEY" \
|
||||
-d '{"path": "./demo/video.mp4"}'
|
||||
```
|
||||
|
||||
**回應範例**:
|
||||
```json
|
||||
{
|
||||
"uuid": "a1b10138a6bbb0cd",
|
||||
"file_name": "video.mp4",
|
||||
"duration": 120.5,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"fps": 30.0,
|
||||
"cached": false,
|
||||
"format": {...},
|
||||
"streams": [...]
|
||||
}
|
||||
```
|
||||
|
||||
**與 Register API 的差異**:
|
||||
|
||||
| 功能 | Probe API | Register API |
|
||||
|------|-----------|---------------|
|
||||
| 計算 UUID | ✓ | ✓ |
|
||||
| 執行 ffprobe | ✓ | ✓ |
|
||||
| 儲存 probe.json | ✓ | ✓ |
|
||||
| 寫入 videos 表 | ✗ | ✓ |
|
||||
| 建立 monitor_job | ✗ | ✓ |
|
||||
| 返回 job_id | ✗ | ✓ |
|
||||
| 適用場景 | 預覽影片資訊 | 註冊並處理影片 |
|
||||
|
||||
## 相關檔案
|
||||
|
||||
| 檔案 | 說明 |
|
||||
|------|------|
|
||||
| `src/core/storage/uuid.rs` | UUID 計算邏輯 |
|
||||
| `src/api/server.rs` | 註冊與 Probe API 實現 |
|
||||
| `src/core/probe/ffprobe.rs` | ffprobe 整合 |
|
||||
| `docs/SFTPGO_DEMO_USER.md` | SFTPgo 用戶設置 |
|
||||
| `docs/API_ENDPOINTS.md` | API 端點總覽 |
|
||||
@@ -1,122 +0,0 @@
|
||||
---
|
||||
document_type: "implementation_guide"
|
||||
service: "YOLO"
|
||||
title: "YOLO Resume 功能整合規劃"
|
||||
date: "2026-03-28"
|
||||
version: "V1.0"
|
||||
status: "active"
|
||||
owner: "Warren"
|
||||
created_by: "OpenCode"
|
||||
tags:
|
||||
- "yolo"
|
||||
- "resume"
|
||||
- "object-detection"
|
||||
- "integration"
|
||||
ai_query_hints:
|
||||
- "YOLO 處理中斷後如何續傳?"
|
||||
- "如何整合 video_yolo_player 的 resume 功能?"
|
||||
- "YOLO 處理進度如何保存和恢復?"
|
||||
---
|
||||
|
||||
# YOLO Resume 功能整合規劃
|
||||
|
||||
## 現有資源
|
||||
|
||||
### 1. video_yolo_player 專案
|
||||
**位置**: `/Users/accusys/video_yolo_player/video_yolo_object_prescan.py`
|
||||
|
||||
**功能**:
|
||||
- ✅ Ctrl+C 暫停並保存進度
|
||||
- ✅ 自動從上一次繼續 (自動偵測 last_processed_frame)
|
||||
- ✅ 可配置自動保存間隔 (預設 30 秒)
|
||||
- ✅ 完整 metadata 追蹤 (處理時間、檢測數量等)
|
||||
- ✅ 互動式詢問是否繼續
|
||||
|
||||
### 2. momentry_core_0.1 專案
|
||||
**位置**: `/Users/accusys/momentry_core_0.1/scripts/yolo_processor.py`
|
||||
|
||||
## 整合狀態
|
||||
|
||||
| 項目 | 狀態 | 完成日期 |
|
||||
|------|------|----------|
|
||||
| Python script 整合 | ✅ 已完成 | 2026-03-22 |
|
||||
| Rust JSON 格式支援 | ✅ 已完成 | 2026-03-22 |
|
||||
| Auto-save 功能 (時間) | ✅ 已完成 | 2026-03-22 |
|
||||
| Auto-save 功能 (frame) | ✅ 已完成 | 2026-03-22 |
|
||||
| Ctrl+C 信號處理 | ✅ 已完成 | 2026-03-22 |
|
||||
| --force 參數 | ✅ 已完成 | 2026-03-22 |
|
||||
| --auto-save-frames 參數 | ✅ 已完成 | 2026-03-22 |
|
||||
|
||||
## 已實作功能
|
||||
|
||||
### momentry_core_0.1/scripts/yolo_processor.py
|
||||
|
||||
```python
|
||||
# 新增功能:
|
||||
def load_existing_data(output_file) # 載入現有資料
|
||||
def save_detection_data(output_file) # 保存進度
|
||||
def signal_handler(signum, frame) # Ctrl+C 處理
|
||||
|
||||
# 新增參數:
|
||||
--auto-save 30 # 自動保存間隔 (秒)
|
||||
--auto-save-frames 300 # 每 N frames 保存一次 (先到為準)
|
||||
--force # 強制從頭開始
|
||||
```
|
||||
|
||||
### 輸出格式
|
||||
|
||||
```json
|
||||
{
|
||||
"metadata": {
|
||||
"video_path": "...",
|
||||
"fps": 24.0,
|
||||
"total_frames": 1000,
|
||||
"status": "in_progress" | "completed" | "interrupted",
|
||||
"total_detections": 5000,
|
||||
"processing_time": 120.5,
|
||||
"auto_save_count": 4,
|
||||
"auto_save_interval": 30,
|
||||
"auto_save_frames": 300,
|
||||
"last_saved_frame": 12500,
|
||||
"last_saved_at": "ISO timestamp"
|
||||
},
|
||||
"frames": {
|
||||
"1": { "frame_number": 1, "time_seconds": 0.0, "detections": [...] },
|
||||
"2": { "frame_number": 2, "time_seconds": 0.042, "detections": [...] }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Auto-save 觸發條件
|
||||
|
||||
**滿足以下任一條件就會寫入磁碟:**
|
||||
1. 距離上次儲存已超過 `--auto-save` 秒數
|
||||
2. 距離上次儲存已處理超過 `--auto-save-frames` 個 frames
|
||||
|
||||
### 使用方式
|
||||
|
||||
```bash
|
||||
# 第一次執行 (預設: 30秒 或 300 frames)
|
||||
python yolo_processor.py video.mp4 output.json --uuid "abc123"
|
||||
|
||||
# 中斷後繼續 (自動偵測)
|
||||
python yolo_processor.py video.mp4 output.json --uuid "abc123"
|
||||
|
||||
# 強制從頭開始
|
||||
python yolo_processor.py video.mp4 output.json --force
|
||||
|
||||
# 自訂自動保存間隔
|
||||
python yolo_processor.py video.mp4 output.json --auto-save 10 --auto-save-frames 100
|
||||
```
|
||||
|
||||
### Rust 端支援
|
||||
|
||||
`check_json_completeness()` 已更新以支援新格式:
|
||||
- 讀取 `frames` dict 的最後一個 key 作為 `last_processed_frame`
|
||||
- 檢查 `metadata.status` 判斷是否完成
|
||||
|
||||
## 待測試項目
|
||||
|
||||
- [ ] 實際執行中斷後繼續
|
||||
- [ ] 驗證 large video (如 Old_Time_Movie_Show) 繼續處理
|
||||
- [ ] 驗證 Rust --resume 參數正確傳遞
|
||||
Reference in New Issue
Block a user