/ip/cloud/back-to-home-user
back-to-home-user
Back To Home 用户。每个用户都是
back-to-home-vpn接口的 WireGuard 客户端，拥有自己的密钥和地址，路由器会为其添加动态对等点。Back To Home 应用会为它建立的每个隧道创建一个用户：name是手机的型号标识符，例如iPhone18,1，注释是应用中显示的隧道名称。多个用户可以具有相同的名称。show-client-config会打印用户的客户端配置。仅在 Back To Home 运行（vpn-status: running）时才能添加用户；否则add会失败并显示back-to-home vpn not enabled。撤销 Back To Home（/ip/cloud中的back-to-home-vpn=revoked-and-disabled）会删除所有用户。概述请参阅 Back To Home。
ip/cloud/back-to-home-user
Syscap: cloud-vpn Type: Directory
Back To Home 用户。每个用户都是 back-to-home-vpn 接口的 WireGuard 客户端，拥有自己的密钥和地址，路由器会为其添加动态对等点。Back To Home 应用会为它建立的每个隧道创建一个用户：name 是手机的型号标识符，例如 iPhone18,1，注释是应用中显示的隧道名称。多个用户可以具有相同的名称。show-client-config 会打印用户的客户端配置。仅在 Back To Home 运行（vpn-status: running）时才能添加用户；否则 add 会失败并显示 back-to-home vpn not enabled。撤销 Back To Home（/ip/cloud 中的 back-to-home-vpn=revoked-and-disabled）会删除所有用户。概述请参阅 Back To Home。
| 标志 | 名称 | 描述 |
|---|---|---|
X | disabled | 用户已禁用。 |
A | active | 用户处于活动状态。 |
| 参数 | 类型 | 描述 |
|---|---|---|
name | string | 用户名称。名称不必唯一；Back To Home 应用使用手机的型号标识符。客户端配置在 # Name 注释行中携带用户的注释，如果没有注释则使用名称，Back To Home 应用将其用作隧道名称。 |
expires | alt { expires: enum (never) { never:0xFFFFFFFF } , interval: time , date-time: date } | 用户停止工作的时间：never（默认）、日期和时间（例如 "2026-10-01 00:00:00"）或时间间隔（例如 1d）。路由器会将间隔转换为日期。用户创建后无法更改该值：set 会接受该值但保留旧日期。要更改它，请重新创建用户。 |
client-dns | address (flags=46/) | 写入用户客户端配置（DNS =）的 DNS 服务器。没有此设置时，配置中不会有 DNS 行，客户端会保留自己的 DNS 服务器。 |
client-allowed-address | multi { client-allowed-address: address (flags=46/) } | 客户端通过隧道发送的地址，写入客户端配置作为路由器对等点的 AllowedIPs，例如 192.168.88.0/24 表示仅访问本地网络。默认值：空（0.0.0.0/0, ::/0，所有流量）。 |
allow-lan | bool | 用户是否可以访问本地网络。设置为 no 时，路由器会将用户地址放入动态地址列表 back-to-home-lan-restricted-peers，并且动态转发规则会丢弃其发往 LAN 接口列表的流量，因此用户只能通过路由器使用互联网。默认值：no。 |
private-key | string | 用户客户端配置的私钥。未设置时由路由器生成。 |
public-key | string | 用户的公钥。未设置时，路由器会从生成的密钥派生。 |
file-access | enum (disabled | read-only | full) | 用户通过文件共享服务访问 file-access-path 中文件的权限。添加具有文件访问权限的用户会使路由器请求文件共享证书。 - disabled（默认）- 无文件访问权限。 - read-only - 读取文件。 - full - 读取和更改文件。 |
file-access-path | string | 用户可通过 file-access 访问的目录，如 /file/print 所示。当 file-access 不为 disabled 时必填；否则添加用户会失败并显示 invalid files path。 |
| 只读参数 | 类型 | 描述 |
|---|---|---|
client-address | multi { address: address (flags=46/) } | 用户在隧道中的 IPv4 和 IPv6 地址，即 192.168.216.0/24 和 fc00:0:0:216::/64 中接下来可用的地址。由路由器分配；无法设置。 |
file-access-token | string | 路由器为用户文件访问生成的令牌。当 file-access 不为 disabled 时，客户端配置会在 # FilesToken 行中包含该令牌。 |