Skip to content

Desktop.md

Latest commit

 

History

History
181 lines (143 loc) · 4.06 KB

Desktop.md

File metadata and controls

181 lines (143 loc) · 4.06 KB
Raw

Windows & Linux 环境使用教程 (版本 v2.0.1-r1)

Warning

更新 v2 版本后此教程仅提供 v2 版本的教程

如若需要 v1 版本的教程, 可自行前往 v1 分支查看

v2 版本的使用十分简单, 跟着一步一步即可

一、使用前准备

1. 从 Release 中下载相应的程序

2. 将程序放在自己想要的位置

Note

macOS 的权限和隐私管理比较严格

Desktop 等目录不允许程序随意读取文件

建议是把程序放进 /usr/local/bin 里面去使用

二、各个系统的执行方式 (前台运行)

1. Windows 双击直接运行, 或者在终端执行如下指令

# Windows PowerShell or CMD (无特别权限要求)
.\ESurfingClient-*-windows-*.exe

2. Linux 在终端执行

# Linux Bash (需要 root 权限)
sudo ./ESurfingClient-*-linux-*

3. macOS 在终端执行

# macOS Zsh (需要 root 权限)
sudo ./ESurfingClient-*-darwin-*

Note

运行之后会在用户所在目录生成一个 ESurfingClient.json 配置文件

何为用户所在目录, 如下所示

或者使用 pwd 指令查看

# Windows CMD
C:\Users\bad_g>
# Windows PowerShell
PS C:\Users\bad_g>
# Linux Bash
badghost@BadGhost:~$
# macOS Zsh
badghost@badghostdeMac ~ %

Note

所以 Windows 用双击执行是最方便的

三、各个系统的执行方式 (以自启服务的形式运行)

1. Windows 在终端执行

# Windows PowerShell or CMD
# 安装服务 (需要管理员权限)
.\ESurfingClient-*-windows-*.exe -i
# 卸载服务 (需要管理员权限)
.\ESurfingClient-*-windows-*.exe -u
# 帮助 (无权限要求)
.\ESurfingClient-*-windows-*.exe -h

2. Linux 在终端执行

# Linux Bash
# 安装服务 (需要 root 权限)
sudo ./ESurfingClient-*-linux-* -i
# 卸载服务 (需要 root 权限)
sudo ./ESurfingClient-*-linux-* -u
# 帮助 (无权限要求)
sudo ./ESurfingClient-*-linux-* -h

3. macOS 在终端执行

# macOS Zsh
# 安装服务 (需要 root 权限)
sudo ./ESurfingClient-*-darwin-* -i
# 卸载服务 (需要 root 权限)
sudo ./ESurfingClient-*-darwin-* -u
# 帮助 (无权限要求)
sudo ./ESurfingClient-*-darwin-* -h

四、修改生成的 ESurfingClient.json

在程序所在目录能找到这个配置文件, 按照如下示例填写

{
  "enabled": true,
  "log_lv": 4,
  "accounts": [
    {
      "username": "在这填账号",
      "password": "在这填密码",
      "channel": "phone",
      "time_windows": []
    }
  ]
}

Note

别忘了改 enabled 参数

JSON 参数详解

  • enabled: 程序是否启动
  • log_lv: 日志等级, 1-6级, 等级越高日志显示内容越多
  • accounts: 账号数组
  • username: 账号
  • password: 密码
  • channel: 认证通道 (暂时没找到具体作用)
  • mark: 标记值 (高级功能, 非 OpenWrt 系统无效)
  • time_windows: 时间控制, 可选, 数组; 每项格式 { "start": "mon 08:13", "end": "mon 23:57" }, 支持跨天/跨周, 留空表示不限; 按系统本地时间判断

五、重启程序 / 服务

Note

重启程序按照 步骤二 执行就可以

如果是安装了服务就需要往下看

1. Windows 可以在服务管理程序重启 ESurfingClient Auth Service 服务, 或者在终端执行如下指令

# Windows PowerShell
Restart-Service ESurfingClient
# Windows CMD
sc stop ESurfingClient
sc start ESurfingClient
# 查看状态
sc query ESurfingClient

2. Linux 在终端执行

# Linux Bash (需要 root 权限)
sudo systemctl restart esurfingclient
# 查看状态
sudo systemctl status esurfingclient

3. macOS 在终端执行

# macOS Zsh (需要 root 权限)
sudo launchctl bootout system /Library/LaunchDaemons/com.esurfingclient.auth.plist
sudo launchctl bootstrap system /Library/LaunchDaemons/com.esurfingclient.auth.plist
# 查看状态
sudo launchctl list | grep main

Tip

建议查看日志以确定程序运行情况