跳到主要内容

NatureTunnel Linux 命令行客户端操作文档

介绍​

  • 本文档将逐步向您介绍如何在 Linux 平台上部署 NatureTunnel 内网穿透服务命令行客户端，并配置开机自启与后台运行。

操作步骤​

准备工作​

  1. 在 NatureTunnel 控制台 软件下载 页面，使用 wget 或其他工具下载适合您系统架构的最新版 NrtunCli 命令行客户端（例如 nrtun_cli_linux_amd64），并放入您的工作目录。

  2. 下载完成后，为客户端二进制文件添加执行权限：

chmod +x ./nrtun_cli_linux_amd64

  1. 在控制台 隧道列表（隧道管理） 页面，选择您创建的隧道，点击右侧操作下拉框中的 生成客户端配置，将配置内容复制到剪贴板。

  2. 在您的工作目录下创建 config.toml 文件，将复制的配置内容写入该文件。

您获得的客户端配置应形如下面的格式：

[client]
server_addr =
control_port =
data_port =
dial_timeout_secs = 5
heartbeat_interval_secs = 15
log_level = "info"
max_reconnect_backoff_secs = 30
reconnect_backoff_secs = 2
udp_idle_secs = 60

[nrtun_config]
center_addr = "https://api.console.nrtun.com"
user_id = "..."
user_secret = "..."

[[tunnels]]
local_addr = ""
name = "" #这里是隧道id，不是隧道名称
remote_port = ""
type = ""
cert_path = "/path/to/your/cert" #仅当隧道类型为HTTPS时需要手动填写
key_path = "/path/to/your/key" #仅当隧道类型为HTTPS时需要手动填写

启动客户端​

在您的工作目录中执行以下命令启动客户端：

./nrtun_cli_linux_amd64 -config ./config.toml
备注

以上方式在前台运行，关闭终端或断开 SSH 后客户端将停止。如需长期运行，请参考下文配置开机自启与后台运行。

配置开机自启与后台运行​

Linux 下可使用 systemd、OpenRC 或 Supervisor 三种方式管理客户端。请根据您的系统选择其中一种即可。

Systemd​

适用于大多数主流 Linux 发行版（Debian、Ubuntu、CentOS、Fedora 等）。

  1. 新建服务文件，将以下内容写入 /etc/systemd/system/nrtun.service：
[Unit]
Description=Nrtun_Cli
After=network.target

[Service]
User=root
Restart=on-failure
RestartSec=5s
WorkingDirectory=/path/to/your/working/dir
ExecStart=/path/to/your/nrtun_cli_linux_amd64 -config /path/to/your/dir/config.toml
LimitNOFILE=1048576

[Install]
WantedBy=multi-user.target
备注

请将 WorkingDirectory 和 ExecStart 中的路径替换为您实际的工作目录与客户端路径。

  1. （可选）如需限制日志大小，编辑 /etc/systemd/journald.conf，加入以下内容：
[Journal]
SystemMaxUse=1G
RuntimeMaxUse=256M
SystemMaxFileSize=128M
MaxRetentionSec=7day
  1. 重新加载配置并启用开机自启：
systemctl daemon-reload
systemctl enable --now nrtun
  1. 检查程序运行状态：
systemctl status nrtun
  1. 查看日志：
journalctl -u nrtun -f

OpenRC​

适用于 Alpine、Gentoo 等使用 OpenRC 的发行版。

  1. 创建服务文件 /etc/init.d/nrtun，内容如下：
#!/sbin/openrc-run

name="nrtun"
description="NatureTunnel Client"

command="/path/to/your/dir/nrtun_cli_linux_amd64"
command_args="-config /path/to/your/config.toml"
command_background=true
pidfile="/run/${RC_SVCNAME}.pid"

directory="/path/to/your/working/dir"

respawn_delay=5
respawn_max=0

output_log="/var/log/nrtun.log"
error_log="/var/log/nrtun.log"
备注

请将 command、command_args 和 directory 中的路径替换为您实际的文件路径。

  1. 赋予执行权限：
chmod +x /etc/init.d/nrtun
  1. 添加开机自启并启动服务：
rc-update add nrtun default
rc-service nrtun start
  1. 检查运行状态：
rc-service nrtun status
  1. 查看日志：
tail -f /var/log/nrtun.log

Supervisor​

适用于已安装 Supervisor 进程管理器的系统。

  1. 安装 Supervisor：
apt install supervisor -y
  1. 创建配置文件 /etc/supervisor/conf.d/nrtun.conf，内容如下：
[program:nrtun]
command=/path/to/your/dir/nrtun_cli_linux_amd64 -config /path/to/your/config.toml
directory=/path/to/your/working/dir
autostart=true
autorestart=true
startretries=999
startsecs=5
user=root
stdout_logfile=/var/log/nrtun.log
stderr_logfile=/var/log/nrtun.log
stdout_logfile_maxbytes=128MB
stdout_logfile_backups=7
提示

如果您不希望开机自启，可以将 autostart 的值改为 false，之后手动启动服务即可。

  1. 重新加载配置并启动：
supervisorctl reread
supervisorctl update
supervisorctl start nrtun
  1. 检查运行状态：
supervisorctl status nrtun
  1. 查看日志：
tail -f /var/log/nrtun.log

管理自启动服务​

Systemd​

  • 修改配置：编辑工作目录下的 config.toml 后，执行以下命令使新配置生效：
systemctl restart nrtun
  • 停止服务：
systemctl stop nrtun
  • 卸载服务（如仅需关闭开机自启，执行第一条命令即可）：
systemctl disable nrtun # 仅需关闭自启时，执行这一条即可
rm /etc/systemd/system/nrtun.service
systemctl daemon-reload

OpenRC​

  • 修改配置：编辑工作目录下的 config.toml 后，执行以下命令使新配置生效：
rc-service nrtun restart
  • 停止服务：
rc-service nrtun stop
  • 卸载服务（如仅需关闭开机自启，执行第一条命令即可）：
rc-update del nrtun default # 仅需关闭自启时，执行这一条即可
rm /etc/init.d/nrtun

Supervisor​

  • 修改配置：编辑工作目录下的 config.toml 后，执行以下命令使新配置生效：
supervisorctl restart nrtun
  • 停止服务：
supervisorctl stop nrtun
  • 卸载服务：
rm /etc/supervisor/conf.d/nrtun.conf
supervisorctl reread
supervisorctl update

遇到问题如何求助​

如果遇到问题，请添加 控制台-帮助中心 内的用户交流群，发送隧道的脱敏日志友善寻求帮助。请注意，群内成员没有为您解决问题的义务，所以您需要注意您提问的方式。但在大部分情况下，群友都是很乐于助人的。