配置说明
tgent 现在统一使用:
- 命令行参数
- 环境变量
不再读取 config.yaml。
最常见的启动方式
本地模式
tgent --listen :8080纯远程 Hub 模式
tgent --mode hub --token <your_token>混合模式
tgent --mode both --listen :8080 --token <your_token>参数说明
| 参数 | 默认值 | 说明 |
|---|---|---|
--listen | :8080 | 本地 HTTP 服务监听地址,仅 local / both 模式生效 |
--password | 自动生成 | 本地模式访问密码;未指定时会自动生成并持久化到数据目录 |
--no-auth | false | 关闭本地密码认证,仅建议用于可信网络或调试环境 |
--jwt-secret | 自动生成 | 本地服务 JWT 签名密钥;未指定时会自动生成并持久化 |
--pipe-dir | /tmp/tgent/pipes | tmux pipe-pane 使用的 Unix socket 目录 |
--web-dir | 空 | 覆盖内置前端资源目录,通常只在开发或自定义打包时使用 |
--data-dir | ~/.tgent | 数据目录,用于存放持久化密码、JWT secret 和本地数据 |
--mode | local | 运行模式,可选 local、hub、both |
--connect-addr | 自动探测 | 指定客户端可见的连接地址;可多次传入;hub 模式下会忽略 |
--name | 主机名 | 节点展示名称 |
--token | $TGENT_TOKEN | Hub / Both 模式使用的访问令牌 |
--no-tui | false | 关闭 TUI,改为纯文本日志输出 |
--snapshot-scrollback | 1000 | 终端首帧快照包含的 scrollback 最大行数,0 表示不限制 |
环境变量
| 变量 | 说明 |
|---|---|
TGENT_TOKEN | hub / both 模式下的访问令牌 |
TGENT_API_URL | 控制平面 API 地址;默认是官方服务 |
TGENT_HUB_ADDR | 指定 Hub 地址;设置后会优先使用它,而不是通过 API 做发现 |
普通用户通常只需要关心 TGENT_TOKEN。TGENT_API_URL 和 TGENT_HUB_ADDR 更多用于私有部署或高级接入场景。
常见组合示例
给节点指定名称
tgent --mode both --name prod-api-01 --listen :8080 --token <your_token>明确告诉客户端该连哪些地址
tgent --listen :8080 \
--connect-addr 192.168.1.10:8080 \
--connect-addr 10.10.0.8:8080在非交互环境关闭 TUI
tgent --no-tui --mode both --token <your_token>用环境变量提供令牌
TGENT_TOKEN=<your_token> tgent --mode both --listen :8080守护运行建议
tmux
tmux new-session -d -s tgent 'tgent --mode both --listen :8080 --token <your_token>'nohup
nohup tgent --mode both --listen :8080 --token <your_token> > ~/.tgent.log 2>&1 &systemd / LaunchAgent
长期常驻时,建议把完整命令行参数写进服务管理器配置中,例如:
- Linux:
systemd --user - macOS:
LaunchAgent
核心原则是:把最终启动命令完整写进 ExecStart / ProgramArguments,而不是依赖外部 YAML 配置文件。