入门

入门

InRoots 是一个容器,它监听团队已在使用的聊天工具,每人每天解析一行文字,并将其转化为工时、目标、辅导和一份可解释的评分。本页带您从零开始,直到第一条日报。

您需要准备什么

  • 一台 Linux 主机:安装程序面向 Debian 12 或更新版本,以及 Ubuntu 22.04 或更新版本。产品以单个 Docker 镜像运行。
  • 一个聊天渠道:一台 Matrix 服务器(K9 Chat 是一款 Matrix 客户端),配一个专用机器人账户及其访问令牌;或者一个 Slack 工作区;或者一个带 Azure 机器人注册的 Microsoft Teams 租户。
  • 一个数据库:SQLite 是默认选项,无需任何准备;多主机部署请将产品指向 Postgres。
  • 一个 AI 提供商密钥,或用于物理隔离部署(需关闭语音回复)的本地 Ollama。评分从不需要 AI;助手、总结和辅导需要。
  • 一个在容器前终结 TLS 的反向代理(Nginx 或 Caddy)。

安装

将发布包复制到主机,以 root 身份运行安装程序,编辑它生成的环境文件,然后启动整个栈。

  • 一次正常启动会在日志中列出机器人正在监听的日报房间和休假房间,并确认前端构建已就绪。
  • 第一位管理员是 BOOTSTRAP_ADMIN_MATRIX_ID 中指定的账户;它会在启动时自动提升权限。
  • 数据库结构变更只增不改,并在每次启动时运行,因此升级就是拉取代码加重启。
sudo bash install.sh
sudo nano /opt/inroots/.env
cd /opt/inroots && sudo docker compose up -d
sudo docker compose logs -f

连接您的聊天工具

在 Matrix 上,机器人会加入您分配给它的房间:每个团队一个日报房间,可选一个休假房间、一个紧急房间和一个管理房间。机器人与每个人之间的私信是端到端加密的,启动时的审计会为任何尚未加密的旧私信房间开启加密。

  • Slack 工作区通过 OAuth 安装添加;每个工作区保存自己的机器人令牌,静态加密。
  • Teams 租户注册自己的 Azure 机器人并粘贴凭据;系统会为您生成一个清单包供上传。
  • 之后可以创建额外的机器人身份(人设)并逐个分配到房间;每个身份都保有自己的加密密钥。
MATRIX_HOMESERVER=https://chat.example.com
MATRIX_USER_ID=@inroots:example.com
MATRIX_ACCESS_TOKEN=...
MATRIX_STANDUP_ROOM_ID=!room:example.com

登录仪表板

默认没有密码。在登录页输入您的聊天 ID,机器人通过私信发送一个六位验证码,您输入即可。验证码五分钟后过期,三次输错会锁定账户十五分钟,受信设备选项可以让您在常用设备上跳过验证码。

配置团队

  • 工作日:每个团队一个七天选择器(完全支持周日至周四的工作周)。未设置则每天都计入。
  • 签到截止时间与宽限,或者“灵活签到”开关,仅按工时评定。
  • 每日应有工时,以及针对兼职人员的每人每周工时。
  • 每个团队的节假日日历,按国家和地区离线生成,另有一份全组织通用的列表。
  • 用于升级事项的管理者房间,以及(如果您需要)在岗询问。

选择 AI 提供商

打开“提供商”页面,为十六家受支持的提供商中的任意一家粘贴密钥,并选定当前使用的一家。如果日报文本绝不能离开您的网络,则改为设置 Ollama 端点。故障转移链和每日调用预算在同一页面配置;详情请参阅“AI 提供商”和“AI 成本与隐私”。

第一条日报

请某位成员在日报房间中发布以下内容。机器人会在房间内确认,记录签到时间,提取任务和阻碍,并开始这一天。

  • 一天结束时,本人发布 sign off。工时即两者之差,并根据当天的实际情况校正。
  • 任何人从第一周起都可以在聊天中输入 /pulse me 查看自己的记分卡。
Yesterday:
- shipped the export fix
Today:
- invoice PDF rendering
Issues: NPs