把 Localtonet 作为服务运行
把 Localtonet 客户端安装为后台服务,使它随设备启动、在你注销后继续运行,并且不需要保持终端打开。一条命令即可把它注册到 Windows 服务、macOS 的 launchd 或 Linux 的 systemd。
开始之前 #
- 设备上已安装控制台客户端:Windows、macOS 或 Linux。
- 来自我的令牌、用于这台设备的 AuthToken。
- 管理员权限:在 Windows 上用以管理员身份运行打开的终端,在 macOS 和 Linux 上用
sudo。 - 在 Linux 上,需要使用 systemd 的发行版。不支持 Termux;请改用 Android 应用。
是通过 DEB 或 RPM 软件包、在 OpenWrt 上或在 Docker 中安装的吗?它们自带开机启动的方式。请参阅 DEB 和 RPM 软件包、OpenWrt 和 Docker,而不是本页。
安装服务 #
带上你的令牌,用 --install-service 运行一次客户端。把 <YOUR_TOKEN> 替换为你的 AuthToken。这条命令中务必带上 --authtoken:服务使用你安装它时所用的令牌来连接。
Windows #
以管理员身份打开命令提示符或 PowerShell,进入包含 localtonet 的文件夹,然后运行:
localtonet --install-service --authtoken <YOUR_TOKEN>客户端会创建一个自动启动的 Windows 服务并启动它。该服务可在 services.msc 中看到,描述为 Localtonet Service。如果服务失败,Windows 会在一分钟后重新启动它。
macOS
sudo localtonet --install-service --authtoken <YOUR_TOKEN>客户端会把一个 launchd 任务写入 /Library/LaunchDaemons/<SERVICE_NAME>.plist,加载并启动它。该任务在开机时启动,如果因错误退出,launchd 会再次启动它。
Linux
sudo localtonet --install-service --authtoken <YOUR_TOKEN>客户端会把一个 systemd 单元写入 /etc/systemd/system/<SERVICE_NAME>.service,启用并启动它。该单元在开机时启动,失败五秒后 systemd 会重新启动它。
如果 sudo 找不到 localtonet,请带上它的路径运行,例如在包含它的文件夹中运行 sudo ./localtonet。
成功时,客户端会输出服务的名称:
[CLI] Installed service 'Localtonet_AbCdEfGhI'安装的同时也会启动服务,因此不需要单独的启动命令。现在你可以在控制台中为这个令牌创建并启动隧道。
服务名称 #
服务名称是 Localtonet_ 加上令牌的前九个字符,例如 Localtonet_AbCdEfGhI。本页用 <SERVICE_NAME> 表示它。由于名称来自令牌,同一台设备上可以为每个令牌安装一个服务,而且每条管理命令都需要同一个令牌才能找到它的服务。
服务运行的内容 #
服务会从同一位置启动同一个 localtonet 文件,并使用你在安装命令中给出的选项。由此带来两点:
- 不要移动或删除该文件。服务定义中包含它的完整路径。在 Linux 上,如果该文件位于
/root内,安装程序会把它复制到/usr/local/lib/<SERVICE_NAME>/,服务运行的是这份副本。 - 其他选项会被保留。安装命令中的
--net和--ip或--proxy env等选项会存入服务,并在每次启动时使用。参见 CLI 参考。
管理服务 #
请用同一个令牌配合以下选项之一。在 macOS 和 Linux 上,请在前面加上 sudo。在 Windows 上,除查看状态外,所有操作都请使用管理员终端。
| 命令 | 作用 | 成功时的输出 |
|---|---|---|
localtonet --status-service --authtoken <YOUR_TOKEN> | 显示服务的状态。 | [CLI] Service '<SERVICE_NAME>' status: Running |
localtonet --stop-service --authtoken <YOUR_TOKEN> | 停止服务。它的隧道会离线。它会在下次开机时再次启动。 | [CLI] Stopped service '<SERVICE_NAME>'. |
localtonet --start-service --authtoken <YOUR_TOKEN> | 启动已停止的服务。 | [CLI] Started service '<SERVICE_NAME>'. |
localtonet --remove-service --authtoken <YOUR_TOKEN> | 停止服务并移除其注册。localtonet 文件本身会保留。 | [CLI] Removed service '<SERVICE_NAME>'. |
状态是以下值之一:
| 状态 | 含义 |
|---|---|
Running | 服务正在运行。 |
Stopped | 服务已安装但未运行。 |
Installing | 服务正在启动。 |
NotFound | 没有为此令牌安装服务。 |
Paused | 仅限 Windows:服务已暂停。 |
Error | 服务失败,或无法读取其状态。 |
Unknown | 服务管理器返回了客户端无法识别的状态。 |
你也可以用操作系统的工具配合服务名称来管理:
Windows #
打开 services.msc 并找到 <SERVICE_NAME>,或者在管理员终端中使用 sc:
sc query <SERVICE_NAME>
sc stop <SERVICE_NAME>
sc start <SERVICE_NAME>macOS
sudo launchctl print system/<SERVICE_NAME>Linux
systemctl status <SERVICE_NAME>
sudo systemctl restart <SERVICE_NAME>服务注册在哪里,日志在哪里 #
| 系统 | 注册位置 | 日志 |
|---|---|---|
| Windows | 一个名为 <SERVICE_NAME> 的 Windows 服务,启动类型为自动,以 LocalSystem 账户运行。 | 该服务没有控制台窗口,安装程序也不会设置日志文件。请查看服务状态,以及控制台中的设备及其隧道。 |
| macOS | /Library/LaunchDaemons/<SERVICE_NAME>.plist,一个系统级的 launchd 任务。 | /var/log/<SERVICE_NAME>.out.log 和 /var/log/<SERVICE_NAME>.err.log |
| Linux | /etc/systemd/system/<SERVICE_NAME>.service,已为 multi-user.target 启用。 | systemd 日志:journalctl -u <SERVICE_NAME> -f |
服务不会输出客户端在终端中显示的隧道表。要查看设备及其隧道的状态,请使用控制台。
更换令牌 #
要更换设备的令牌,请用旧令牌移除服务,再用新令牌重新安装:
sudo localtonet --remove-service --authtoken <OLD_TOKEN>
sudo localtonet --install-service --authtoken <NEW_TOKEN>需要了解的事项 #
- 每个令牌一个客户端。服务运行期间,请不要在这台设备或另一台设备上用同一个令牌启动另一个 Localtonet 客户端。用同一令牌连接的第二个客户端会把第一个断开。
- 更新客户端。服务会继续运行其定义所指向的文件。请先停止服务,用新版本替换该文件,然后再次启动服务。
- 代理密码不会被保存。安装命令会拒绝包含密码的代理 URL 和
--proxy-user选项。请使用--proxy env安装,并在服务的环境中设置代理变量。 - 设备终端。如果设备把 Localtonet 作为服务运行,请在管理员终端中或使用
sudo运行localtonet --terminal enable,这样服务才能使用其结果。参见设备终端。
故障排除 #
| 消息 | 原因和解决方法 |
|---|---|
[CLI] Install failed: '…' requires elevated (admin/root) privileges. | 该命令是在没有管理员权限的情况下运行的。在 Windows 上请以管理员身份打开终端,在 macOS 和 Linux 上请使用 sudo。在 Windows 和 Linux 上,启动、停止和移除也会出现同样的消息。 |
[CLI] Install failed: 后面跟着 Service '<SERVICE_NAME>' already exists.(Windows)、Systemd unit already exists for …(Linux)或 Plist already exists for …(macOS) | 已经为这个令牌安装了服务。请用 --start-service 启动它,或者如果想重新安装,请先使用 --remove-service。 |
Service installation cannot persist proxy passwords. Use --proxy env and supply credentials in the service's runtime environment. | 安装命令中包含 --proxy-user 或带密码的代理 URL。请改用 --proxy env。 |
在 Windows 上刚安装完就出现 [CLI] Start failed: … | 服务已经在运行,因为安装时就会启动它。请用 --status-service 检查。 |
状态为 NotFound | 你传入的令牌没有对应的服务。请检查它是否是你安装服务时所用的令牌。 |
状态为 Running,但设备在控制台中显示离线 | 请检查令牌:从我的令牌再次复制它,移除服务并重新安装。同时请确认没有其他客户端使用同一个令牌。 |