CLI
环境变量
面向无头、服务器与多 profile 部署的运营开关。
绝大多数用户用不到这些 —— 桌面应用和 --profile 参数已经覆盖常见场景。
它们主要用于无头服务器、容器,以及在同一台机器上跑多个实例。这些值在启动时读取一次,
所以要在启动 uniclip(或 GUI)之前设置。
| 变量 | 作用 |
|---|
UC_PROFILE | 以命名 profile 运行,隔离数据目录、日志目录、keychain 条目与 iroh 身份。等价于 --profile 参数。例如 UC_PROFILE=dev 会存到 app.uniclipboard.desktop-dev。 |
| 变量 | 作用 |
|---|
UC_DISABLE_SYSTEM_CLIPBOARD | 设置后守护进程不再读写系统剪贴板,但仍作为普通成员经 iroh 同步。无显示会话的 Linux 主机(DISPLAY 与 WAYLAND_DISPLAY 均未设置)会自动禁用并照常启动,无需手动设置;此变量用于在桌面环境强制禁用。 |
UC_DAEMON_RUN_MODE | 后台守护进程的 spawn 契约:取 server 时选择无头 server 节点模式(同时关闭系统剪贴板)。终端侧请优先用 uniclip start --server,它会替你设置。 |
UC_HOST_ROLE | 本进程的诊断角色标签 —— gui-host、daemon 或 cli —— 用于错误/遥测归类。通常自动设置,仅在需要改变事件归类时覆盖。 |
| 变量 | 作用 |
|---|
UC_IROH_BIND_PORT | 固定本地 iroh UDP 端口,而不是让系统随机分配 —— 需要一个稳定端口来做防火墙 / NAT 端口转发时很有用。 |
UC_IROH_PUBLIC_ADDR | 为本节点广告一个指定的公网地址,适用于位于静态 NAT 之后、或拥有已知公网 IP 的主机。通常与 UC_IROH_BIND_PORT 搭配使用。 |
UC_CONGESTION_CONTROLLER | 覆盖 QUIC 拥塞控制算法,无需打开设置界面。接受 cubic(默认)或 bbr3。适合在无头节点上快速做 A/B 测试。需要重启 daemon 生效。 |
| 变量 | 作用 |
|---|
RUST_LOG | 标准 tracing 过滤器,设置后 覆盖 UC_LOG_PROFILE。可以是级别(RUST_LOG=debug)或按模块指定(RUST_LOG=uniclip=debug,iroh=info)。 |
UC_LOG_PROFILE | 选择日志预设 —— dev、prod、debug_clipboard 或 cli。debug 构建默认 dev,release 构建默认 prod。 |
UC_LOG_FILE | 诊断专用:把 JSON 日志写入这一个指定文件,不按日滚动、不做保留期清理。仅限 daemon —— 取值必须是绝对路径,且 UC_HOST_ROLE 必须为 daemon,否则进程直接启动失败,以免多个角色同时追加同一文件。留空则沿用按角色、按日滚动的正常日志。 |
日常配置见安装与自建中继。
可接受的取值与默认值,以二进制的 --help 和源码为准。