自己部署

用 Docker 起一个自己的服务端,团队的数据只经过你自己的机器。

Yihee 的客户端默认连接我们运行的服务器。不想让数据经过它,可以自己起一个。服务端是开源的,一个 Go 程序加一个数据库,一台小机器就够。

先弄清楚服务端到底管什么。它是队友之间传消息的中转站,不跑 agent,不碰代码,不做 Git 操作。这些都发生在每个人自己的电脑上。

经过服务器 只在各人电脑上
团队的项目清单和 Skill 源仓库地址 代码和 Git 操作
成员列表、邀请码 agent 的执行
队友和你的 Pal 之间的对话 你自己的会话记录
团队定时任务的状态和每轮简报 agent 的登录凭据
交接包(过期后删除) 仓库凭据

部署

需要一台装了 Docker 的机器。

git clone https://github.com/liao-techs/yihee.git && cd yihee
cp .env.example .env
docker compose up -d --build --wait
curl -fsS http://127.0.0.1:8787/healthz

最后一条返回 {"ok":true} 就是起来了。

默认用 SQLite,数据都在一个名为 yihee-data 的 Docker 卷里。小团队这样就够。

让客户端连过来

服务只监听本机的 8787 端口,不直接对外。要在前面放一个反向代理提供 HTTPS。

代理要满足三点:

  • 支持 WebSocket(队友之间的实时通知靠它)。
  • 不缓冲响应(对话是流式的)。
  • 允许大请求体:交接包单个最大 95 MB。

下面两段是常见写法的示例,按你自己的环境调整。

Caddy:

yihee.example.com {
    request_body {
        max_size 100MB
    }
    reverse_proxy 127.0.0.1:8787 {
        flush_interval -1
    }
}

Nginx:

server {
    server_name yihee.example.com;
    client_max_body_size 100m;

    location / {
        proxy_pass http://127.0.0.1:8787;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_buffering off;
        proxy_read_timeout 1h;
    }
}

然后在客户端:

  • 桌面应用:新建或加入团队的页面上,点「修改」,把服务地址换成 https://yihee.example.com。
  • 命令行:yihee onboard --code <邀请码> --server https://yihee.example.com。

之后管理员复制的邀请里会自带这个地址,新成员整段粘贴就行,不用再手填。

放在代理或 CDN 后面时,一定要设 CLIENT_IP_HEADER(见下表)。否则在服务端看来所有人都来自同一个地址,会一起撞上「每小时新建 5 个团队」的限制。

配置

改 .env,然后重新运行 docker compose up -d --wait。只 restart 不会重读配置。

变量 默认 意思
YIHEE_PORT 8787 本机上监听的端口
DB_DRIVER sqlite sqlite、mysql 或 postgres
DB_DSN 空 数据库连接串。SQLite 留空
CLIENT_IP_HEADER 空 代理传来的真实来源地址放在哪个请求头里。Cloudflare 填 CF-Connecting-IP
WORKSPACE_CREATE_LIMIT 5 每个来源地址每小时能建几个团队。0 为不限
JOIN_LIMIT 30 每个来源地址每小时能试几次邀请码。0 为不限
CLEANUP_INTERVAL 1h 多久清理一次过期的交接包
YIHEE_TAG latest 用哪个版本的镜像

用 MySQL 或 PostgreSQL

仓库里有现成的 compose 文件,会一起起一个数据库:

# MySQL:先在 .env 里填 MYSQL_PASSWORD 和 MYSQL_ROOT_PASSWORD
docker compose -f compose.yaml -f compose.mysql.yaml up -d --build --wait

# PostgreSQL:先在 .env 里填 POSTGRES_PASSWORD 和 POSTGRES_DSN_PASSWORD
docker compose -f compose.yaml -f compose.postgres.yaml up -d --build --wait

两件事要注意:

  • 之后每一条 docker compose 命令都要带上同一组 -f。漏了的话会悄悄回到 SQLite,看起来像数据全没了。
  • 换数据库不会搬数据。从 SQLite 换过去等于从头开始。

备份

要备份两样东西,缺一不可:

  1. 数据库。 SQLite 的话就在 yihee-data 卷里;MySQL / PostgreSQL 用它们各自的导出工具。
  2. yihee-data 卷里的文件。 交接包存在这里。

升级

git pull
docker compose up -d --build --wait

带上你部署时用的那组 -f。启动时会自动补上新版本需要的表。

不要用 docker compose down -v。 -v 会把数据卷一起删掉。

数据保留多久

数据 保留
没人接手的交接包 14 天
已接手的交接包 接手后 7 天
撤回的交接包 立即清理
其他(成员、对话、任务记录) 一直保留

清理的是包文件本身,「谁在什么时候交给了谁」这条记录会留着。

成员的登录令牌在数据库里只存哈希。数据库本身没有额外加密,机器的磁盘加密和访问控制由你负责。

限制

  • 只能运行一个实例。 实时通知的状态存在进程内存里,起两个会互相看不到。
  • 桌面应用的自动更新仍然从我们的服务器下载。 更新地址是打包时写进应用里的,运行时改不了。想完全不连我们的服务器,需要自己从源码打包应用。
  • 目前没有删除整个团队的功能。

检查服务是否正常

curl -fsS http://127.0.0.1:8787/healthz
docker compose logs -f yihee

/healthz 会顺便检查数据库连不连得上。日志是 JSON 格式。