SakuraFrp 启动器 3.0 用户手册 |
您所在的位置：网站首页 › sakura当英文名 › SakuraFrp 启动器 3.0 用户手册 |
|
SakuraFrp 启动器 3.0 用户手册 提示 这是面向高级用户的手册，通常情况下您只需查看 启动器安装、使用指南 组件说明用户界面平台SakuraLauncher.exeWindows (WPF 启动器，提供最新功能)LegacyLauncher.exeWindows (传统启动器，提供基础功能)SakuraLauncher.appmacOSSakuraLauncher.apkAndroid配置 Web UI 通过 PWA在新窗口打开 进行管理所有平台高级用户完全可以选择不安装用户界面、手动修改 config.json 启用远程管理 V2 在管理面板进行控制。不过这样做使用体验比较差。 核心服务平台SakuraFrpService.exeWindowsnatfrp-service.appmacOSnatfrp-serviceLinux / FreeBSD由于 Apple 的签名要求，核心服务在 macOS 平台下只能通过 SakuraLauncer.app 使用，故不适用于 命令行开关 与 环境变量 章节。虽然您可以将 natfrp-service.app 甚至里面的二进制文件单独提取出来使用，但我们不推荐这么做。 Android 平台的启动器也不适用于这两节，并且您可能需要 ADB 或 Root 权限来编辑配置文件。 用户界面本身不提供高级配置选项，下方的说明都是针对核心服务的。 命令行开关提示 不同版本的启动器可能会有不同的开关，您可以通过 natfrp-service help 子命令检查 文档中的内容总是基于最新版本的启动器编写 适用平台开关说明所有-h / --help显示帮助信息并退出-v / --version显示版本号并退出-V / --version-full显示完整版本信息并退出-c / --config指定配置文件路径，默认为 ${工作目录}/config.json--daemon运行守护进程，不带此开关启动时会显示提示信息并退出Windows--install安装系统服务--uninstall卸载系统服务Unix--force-root强制以 root 用户身份运行 (请确认您知道自己在做什么)子命令# 初始化 Web UI 并打开安装 URL natfrp-service webui --init # 打开带凭据的 Web UI 连接 URL，必须安装 PWA natfrp-service webui # 生成经过 KDF、Base64 编码的密钥，用于远程管理 V2 密钥配置。 natfrp-service remote-kdf 环境变量目前仅在 Linux / FreeBSD 下会读取以下环境变量： 变量说明NATFRP_SERVICE_WD指定 工作目录NATFRP_SERVICE_LOCK指定互斥锁兼 PID 文件路径，默认为 ${工作目录}/lock.pidNATFRP_SERVICE_SOCK指定控制连接的 Unix Socket 路径，默认禁用NATFRP_FRPC_PATH指定 frpc 可执行文件路径，默认为 核心服务可执行文件/frpc(.exe)工作目录核心服务的所有文件都是相对于 工作目录 创建的。下面是工作目录的默认值： Windows：%PROGRAMDATA%\SakuraFrpServicemacOS：~/Library/Containers/com.natfrp.launcher/Data/Library/Application Support/natfrp-serviceLinux / FreeBSD 下遵循 FreeDesktop 规范： 优先使用 $XDG_CONFIG_HOME/.config/natfrp-service如果 $XDG_CONFIG_HOME 未设置，则使用 ~/.config/natfrp-serviceAndroid 启动器：/data/data/com.natfrp.launcher/service/OpenWrt LuCI 插件：/etc/natfrp群晖 DSM 套件包：/var/packages/natfrp/var启动器将使用以下路径： 路径说明config.json核心配置文件Logs/日志路径Logs/SakuraFrpService.log 或 Logs/natfrp-service.log本次运行日志Logs/SakuraFrpService.last.log 或 Logs/natfrp-service.last.log前次运行日志Logs/Update.log最后一次自动更新日志FrpcWorkingDirectory/frpc 工作目录Update/更新文件临时目录Temp/WPF 启动器临时目录 (仅 Windows)lock.pid互斥锁兼 PID 文件 (仅 Linux / FreeBSD)配置文件配置文件 config.json 默认以 660 权限创建。在 Unix 平台您可以建立单独的用户以确保配置文件不被泄露。 核心功能配置项类型默认值说明tokenString空用户访问密钥，用于自动登录auto_start_tunnelsInt[]空自动登录后启动的隧道 ID 列表update_intervalInt86400自动更新检查间隔，单位为秒，设置为 -1 禁用自动更新update_channelStringcurrent更新通道，可选值为 lts，current，beta，edgefrpc_log_levelStringinfo配置 frpc 日志等级，可选值为 trace，debug，info，warn，errorfrpc_force_tlsBooleanfalse强制启用 frpc TLS 连接frpc_standard_tlsBooleanfalse强制启用 frpc 标准 TLS 连接frpc_enable_statsBooleantrue将 frpc 统计信息回报到启动器，用于 Web UI 展示API 连接性保障配置项类型默认值说明api_proxyString空配置 API 使用的代理api_timeoutInt30API 请求超时时间，单位为秒api_ca_modeStringembeddedAPI 根证书验证模式api_dns_overrideString[]null用于解析 API 地址的 DNS 服务器地址列表api_dns_system_onlyBooleanfalse仅使用系统 DNS 解析 API 地址api_dns_encrypted_onlyBooleanfalse使用内置 DNS 服务器列表时，仅启用加密服务器关于 api_proxy该选项接受一个代理 URI，如 socks5h://user:pass@host:port。 填写 system 则使用系统代理，留空则不使用代理。 该选项设置了自定义代理 URI 时，用户界面的 绕过系统代理 选项将总是显示为打开且不可修改。 关于 api_ca_mode模式说明embedded使用内置的根证书，确保最佳连接性system使用系统根证书，以兼容需要流量审查的特殊环境no-verify不验证 SSL 证书，可能造成严重安全问题关于 api_dns_* 相关选项若指定了 api_dns_override，则总是会使用指定的 DNS 服务器列表进行解析。 该选项接受一个 URI 数组，支持的协议有： 协议说明udp, tcp普通 DNS 请求tls, dotDNS-over-TLShttps, dohDNS-over-HTTPSURL 示例：udp://223.5.5.5:53，无效的 URI 将被忽略。 否则，若指定了 api_dns_system_only，则只使用系统 DNS 进行解析。 若上述两个选项均未指定，则会使用内置的 DNS 服务器列表，并根据 api_dns_encrypted_only 决定是否启用未加密的 DNS 服务器。 除 api_dns_override 外的两个选项会被传递给 frpc。 在任何情况下，都会以系统 DNS 作为最后的备选解析服务器。 日志记录配置项类型默认值说明log_buffer_sizeInt4096日志 Ring 缓冲区大小（条数），请勿随意调节log_stdoutBooleanfalse将日志写到标准输出，Docker 中默认为 truelog_fileStringauto日志文件路径，auto 则写入默认路径远程管理关于配置项的详细信息，请参阅 远程管理 V2 / 进阶配置。 配置项类型默认值说明remote_managementBooleanfalse启用远程管理remote_management_keyString空远程管理密钥，KDF 后的 32 字节 Base64remote_management_auth_modeStringnonce远程管理 Challenge-Response 认证模式remote_management_auth_confString空远程管理 Challenge-Response 认证配置Web UI警告 在任何情况下您都 不应该 将 Web UI 暴露在公网上，尤其不应该 用 frp 将其穿透至节点 如果需要带外管理请考虑配置 远程管理 V2 通过 SakuraFrp 进行管理，而非对外暴露 Web UI 您可以访问由我们托管的 PWA在新窗口打开 应用来连接启动器的 Web UI 管理接口，我们推荐您总是使用 PWA 以获取最佳体验。 您也可以直接访问启动器的 Web UI 监听地址使用内置的 Web UI，但您将无法使用 PWA 以及最新功能。 配置项类型默认值说明webui_hostStringlocalhostWeb UI 监听地址，不为 localhost 时必须配置 TLS 证书webui_portInt-1Web UI 监听端口，-1 禁用在 Unix 平台默认为 4101webui_passString空Web UI 访问密码webui_certString空Web UI TLS 证书路径webui_cert_keyString空Web UI TLS 证书密钥路径webui_origin_modeStringnatfrpWeb UI Origin 检查模式关于 webui_host考虑到 Web UI 强制在监听非 localhost 地址时强制使用 TLS 的行为可能会影响一部分 Geek，如果您真的确定您知道自己在做什么，可以在地址前加 this-breaks-webui-i-dont-care: 前缀强制绕过这一限制： 例如 this-breaks-webui-i-dont-care:192.168.1.100 会使启动器在 192.168.1.100 监听 HTTP 协议但这会造成 Web UI 工作异常，最常见的表现为卡在 连接中...我们知道这是由于非安全上下文中无法使用部分 API 造成的，但我们不会修复这个问题同时满足下列三个条件时，启动器会自动生成并使用自签名证书 webui.{key,crt}： webui_host 不为 localhost未使用绕过前缀webui_cert、webui_cert_key 均为空关于 webui_pass出于安全考虑，Web UI 必须配置长度不低于 8 字符的访问密码，服务首次运行时会生成 24 字符的随机密码。 PWA 会自动在 localStorage 保存连接信息，因此您无需记住它，我们推荐直接使用随机生成的值。 密码长度要求是硬性限制，无法绕过。 关于 webui_origin_mode模式说明strict仅允许同源请求，即 WebSocket 请求的 Origin 头必须与 Host 头匹配natfrp仅允许同源请求或来自 https://launcher.natfrp.com 的请求any不检查 Origin 头（可能造成严重安全隐患，不推荐使用）统计信息配置项类型默认值installation_idString随机生成关于 installation_id该选项适用于 3.0.8 及以上版本启动器。若该值为空则随机生成一个 UUID 并储存。 该值会被附加在每个 API 请求的 X-Installation-Id 头中，您可以将其设置为 opt-out 来关闭此请求头的发送。 我们将存储一对以 UID-安装ID 为键的值，用于统计启动器的使用情况。 当对应的安装 ID 停止发送 API 请求 24 小时后，对应的键值将被删除。 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |