返回首页

配置说明

tgent 现在统一使用:

  1. 命令行参数
  2. 环境变量

不再读取 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-authfalse关闭本地密码认证,仅建议用于可信网络或调试环境
--jwt-secret自动生成本地服务 JWT 签名密钥;未指定时会自动生成并持久化
--pipe-dir/tmp/tgent/pipestmux pipe-pane 使用的 Unix socket 目录
--web-dir覆盖内置前端资源目录,通常只在开发或自定义打包时使用
--data-dir~/.tgent数据目录,用于存放持久化密码、JWT secret 和本地数据
--modelocal运行模式,可选 localhubboth
--connect-addr自动探测指定客户端可见的连接地址;可多次传入;hub 模式下会忽略
--name主机名节点展示名称
--token$TGENT_TOKENHub / Both 模式使用的访问令牌
--no-tuifalse关闭 TUI,改为纯文本日志输出
--snapshot-scrollback1000终端首帧快照包含的 scrollback 最大行数,0 表示不限制

环境变量

变量说明
TGENT_TOKENhub / both 模式下的访问令牌
TGENT_API_URL控制平面 API 地址;默认是官方服务
TGENT_HUB_ADDR指定 Hub 地址;设置后会优先使用它,而不是通过 API 做发现

普通用户通常只需要关心 TGENT_TOKENTGENT_API_URLTGENT_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 配置文件。