Skip to content

Latest commit

 

History

History
139 lines (101 loc) · 2.88 KB

03-deployment.md

File metadata and controls

139 lines (101 loc) · 2.88 KB

服务端部署

OpenViking 可以作为独立的 HTTP 服务器运行，允许多个客户端通过网络连接。

快速开始

# 配置文件在默认路径 ~/.openviking/ov.conf 时，直接启动
python -m openviking serve

# 配置文件在其他位置时，通过 --config 指定
python -m openviking serve --config /path/to/ov.conf

# 验证服务器是否运行
curl http://localhost:1933/health
# {"status": "ok"}

命令行选项

选项 描述 默认值
--config 配置文件路径 ~/.openviking/ov.conf
--host 绑定的主机地址 0.0.0.0
--port 绑定的端口 1933

示例

# 使用默认配置
python -m openviking serve

# 使用自定义端口
python -m openviking serve --port 8000

# 指定配置文件、主机地址和端口
python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 8000

配置

服务端从 ov.conf 读取所有配置。配置文件各段详情见 配置指南。

ov.conf 中的 server 段控制服务端行为：

{
  "server": {
    "host": "0.0.0.0",
    "port": 1933,
    "root_api_key": "your-secret-root-key",
    "cors_origins": ["*"]
  },
  "storage": {
    "agfs": { "backend": "local", "path": "/data/openviking" },
    "vectordb": { "backend": "local", "path": "/data/openviking" }
  }
}

部署模式

独立模式（嵌入存储）

服务器管理本地 AGFS 和 VectorDB。在 ov.conf 中配置本地存储路径：

{
  "storage": {
    "agfs": { "backend": "local", "path": "./data" },
    "vectordb": { "backend": "local", "path": "./data" }
  }
}
python -m openviking serve

混合模式（远程存储）

服务器连接到远程 AGFS 和 VectorDB 服务。在 ov.conf 中配置远程地址：

{
  "storage": {
    "agfs": { "backend": "remote", "url": "http://agfs:1833" },
    "vectordb": { "backend": "remote", "url": "http://vectordb:8000" }
  }
}
python -m openviking serve

连接客户端

Python SDK

import openviking as ov

client = ov.SyncHTTPClient(url="http://localhost:1933", api_key="your-key", agent_id="my-agent")
client.initialize()

results = client.find("how to use openviking")
client.close()

CLI

CLI 从 ovcli.conf 读取连接配置。在 ~/.openviking/ovcli.conf 中配置：

{
  "url": "http://localhost:1933",
  "api_key": "your-key"
}

也可通过 OPENVIKING_CLI_CONFIG_FILE 环境变量指定配置文件路径：

export OPENVIKING_CLI_CONFIG_FILE=/path/to/ovcli.conf

curl

curl http://localhost:1933/api/v1/fs/ls?uri=viking:// \
  -H "X-API-Key: your-key"

相关文档