无极开物Docs
从这里开始

新手引导

选择托管或自托管,选定你的中继,然后使用 App 让设备准备就绪。

Kaiwu 的核心使用流程始终保持一致:

  1. 选择中继(默认使用 Kaiwu Cloud,也可选择自托管)。
  2. 在该中继上登录或注册账号。
  3. 将桌面客户端作为主控制台(推荐方案;Web 端更适合查看状态与日常管理)。
  4. 就绪目标设备:
    • 本机:直接在客户端中配置本地后台服务。
    • 远程设备:在客户端中通过 SSH 完成初始化配置。
  5. 按需开启私有网络访问(例如使用 Tailscale),以便其他设备访问自托管或本地中继。

选择适合你的部署方案

方案 A — 云端托管(新手推荐)

直接使用 Kaiwu Cloud 作为中继。

  1. 打开桌面客户端(推荐)或 Web 端(仅用于查看状态与管理)。
  2. 当客户端询问使用哪个中继时,选择 Kaiwu Cloud。
  3. 登录账号。
  4. 在桌面客户端中打开 /setup,并选择 Set up this computer。
    • 此操作会面向刚选定的中继配置本地后台服务。
    • 后续若客户端检测到中继配置漂移,会主动提示修复操作,避免守护进程在不知情的情况下仍连接到其他中继。

可选的 CLI 流程:

# Node-free (recommended): install the CLI binary via the official installer
curl -fsSL https://kaiwu.wujilabs.cn/install | bash
kaiwu setup

kaiwu setup 会在认证前先选择中继,随后完成登录、注册本机并协调配置开机自启。当中继配置文件与设备生命周期已配置就绪时,仍可直接使用更底层的 kaiwu auth login 命令。

说明:

  • 桌面客户端以及通过安装包安装的 CLI 均为独立运行环境,系统无需预装 Node 或 Yarn。
  • 若更倾向于使用 npm 工作流,请参阅 CLI 安装(需具备 Node 环境)。

方案 B — 仅自托管中继(后台服务运行在笔记本电脑上)

自行运行中继(可部署在远程设备、局域网主机甚至本机上),而后台服务保留在另一台设备上。

  1. 安装中继(参考示例):

    • Proxmox:参阅 Proxmox 部署。
    • 任意设备(托管服务):安装 CLI 后运行 kaiwu relay host install --mode system(远程执行则运行:kaiwu relay host install --ssh user@host --mode system)
    • Docker:参阅 部署 → Docker。
  2. 打开桌面客户端(推荐)或 Web 端(仅用于查看状态与管理),并选择该中继。

    • 部分安装程序会输出一键链接或二维码,可直接预填中继 URL。
    • 亦可打开客户端,在 Relay settings 中手动添加或选择。
  3. 在该中继上注册账号或登录。

  4. 在桌面客户端中,指定由哪台设备运行后台服务:

    • 本机:依次点击 /setup → Set up this computer。
    • 其他设备:在设备设置页面中选择 Add machine over SSH。

若守护进程所在主机需要备用的高级 CLI 方案:

# Recommended remote-machine setup:
kaiwu machine setup --ssh user@host --install-relay-runtime

仅供排错使用(在远程主机上手动配置守护进程):

kaiwu server add --name company --server-url https://YOUR_SERVER_URL --webapp-url https://YOUR_WEBAPP_URL --use
kaiwu auth login
kaiwu daemon service install

--use 会为该 CLI 安装指定默认中继配置文件;但依然推荐优先使用客户端流程,以便直观掌控中继与账号的选择状态。

方案 C — Devbox(同一设备同时运行服务器与守护进程)

在单台主机上同时部署中继与后台服务。

  1. 安装栈(例如通过 hstack setup-from-source --profile=selfhost 或 Proxmox 的“devbox”选项)。
  2. 打开桌面客户端(推荐)或 Web 端(仅用于查看状态与管理)并选择该中继(若终端打印了服务器配置链接或二维码,可直接使用)。
  3. 登录或注册账号。
  4. 在客户端中操作:若直接在该主机上操作,进入 /setup → Set up this computer;若为远程操作,则通过 SSH 完成该主机的配置。
  5. 若中继部署在本地或内网自托管,可按需开启私有网络访问,使手机等其他设备无需公网暴露即可顺畅连接。

初次配置建议:

  • 关联更多设备之前,请确保所有设备均连接至同一个中继。
  • 建议将桌面客户端作为主控制台,统一处理守护进程配置、中继运行时控制以及修复操作。

多个中继(个人 + 公司)

  • 客户端与 CLI 均支持保存多个中继配置文件。
  • 凭据与状态均在中继级别实现作用域隔离,切换中继不会覆盖其他账号的数据。
  • 账号归属于各自的中继。即便在两个中继上使用同一个登录提供商,服务端依然会创建两个相互独立的账号上下文。
  • Web 端:可以仅针对当前标签页切换中继,也可以将其设为本设备的全局默认中继。

CLI:单次执行指定目标服务器

kaiwu --server company auth login
kaiwu --server company daemon start

CLI:在单台设备上运行多个守护进程(每个中继各运行一个)

kaiwu --server personal daemon service install
kaiwu --server company daemon service install

随后进行验证(跨平台通用):

kaiwu daemon status --all
kaiwu --server personal daemon service status
kaiwu --server company daemon service status

如需了解完整的配置文件机制、切换逻辑及 CLI 参考手册,请参阅 功能特性 → 多服务器。

© 乾元执中(南京)科技有限公司 · WUJI-Labs

On this page