SyncTunnel 教程

1 软件下载与安装

想要下载软件,你可以访问 SyncTunnel的官网 进行下载。

2 软件操作

2.1 熟悉软件

本软件的最新版本是 beta 1.2.7 版本。
Beta 1.2.5版本的界面如下 :(beta 1.2.7版本的界面在下方更新区域)
beta 1.2.5界面

以下有对界面部分的介绍

更新
beta 1.2.7开始,界面变更为
beta 1.2.7界面

2.2 快速配置

本段讲述了安装应用程序后如何进行配置。
本应用程序以配置简单著称,配置过程十分精简。

2.2.1 必要配置

此段是使用软件必要的配置,配置完成后可以使用基础功能。

想要使用本软件,你需要先设置用户名/加密密码。

  1. 点击软件左侧页面栏的“设置”按钮,切换到设置页面。设置页面的界面如图所示:设置页面
  2. 自己想一个用户名填写在 用户名 字段,填写密码到 密码字段。本软件无需注册,填写好后就生效。如果是刚刚下载本软件的用户,请只填写用户名和密码字段,不知用途,不要修改通信设置里面的内容。
  3. 填写完用户名密码核对无误后请点击 保存设置 按钮。应用程序自动重启,完成设置。
重要安全提示

请务必修改默认的用户名和密码。使用默认的用户名密码会让您的数据非常危险,极易被盗取。

请务必记住您的密码。若密码遗忘会导致数据无法解密。

本软件没有密码验证系统,这会导致两个人用一样的用户名时,软件自动将其视为同一个用户。请将用户名设为不容易重名的名字。请勿将用户名设为"666""1234"等重名率高的名字。建议用户名5字符以上。

如果是刚刚下载本软件的用户,请点击这里继续学习使用方法。

2.2.2 其他配置

2.2.2.1 配置MQTT
重要安全提示

用户信息使用范围


本软件收集的通过MQTT传输的信息列表:

声明:
本软件所有传输的数据都使用用户的密码进行AES-256加密,但使用的服务器是测试服务器broker.emqx.io:1883不保证联接的安全性。如果介意,请自行更换!
开发者保证MQTT服务只传输上述列出的数据,不传输用户发送的文件内容,即使数据泄露,不会直接威胁到文件的安全。

软件提供更换MQTT服务器地址的功能。
输入服务器的地址和端口,点击 保存设置按钮,应用程序自动重启,完成设置。
如果服务器突然无法使用,可以尝试更换服务器。
下表列出了常见的服务器。注意:他们大多数是测试服务器,若需其他服务器可自行查找。主要的服务器提供商有EMQ(现在称为EMQX)Mosquitto

免费MQTT服务器资源
名称 地址(对应输入到MQTT服务器地址字段) 端口地址(对应输入到MQTT服务器端口字段) 备注
EMQ broker.emqx.io 1883 默认服务器
EMQ broker-cn.emqx.io 1883 EMQ的中国服务器,未经测试
EMQ broker.emqx.io 8883 EMQ的中国服务器,有TLS加密,保证数据安全,未经测试,大概率不兼容
Mosquitto test.mosquitto.org 1883 未经测试


2.2.2.2 配置文件挂起

前言:基础功能只能实现在两个客户端同时在线时才可以进行互传文件。当其中一方离线时,另一方无法得到文件。因此为了满足大部分的需要,SyncTunnel软件提供文件挂起服务.
文件挂起需要在最后一个客户端离线之前手动操作。后续会增加自动挂起功能。手动挂起后数据会保存在Github服务器上,等到第一个客户端上线后手动下载文件,自动删除Github上面的文件。

重要安全提示

用户信息使用范围

我们保证,只要用户正确设置了密码,文件一定会被加密。


2.2.2.2.1 配置Github
  1. 打开Github官网,点击右上角的Sign up按钮进入注册页面,或点击链接直接进入注册页面,按照提示填写邮箱、密码、用户名(请记牢)和密码,验证账号后,进入主页
  2. 点击右上角的+,在弹出的菜单中选择new repository新建仓库
  3. 填写字段:将Repository name字段填写为synctunnel-filehangup,建议把Choose visibility填写为Private
  4. 点击右下角的绿色按钮,创建仓库。
  5. 创建PAT:在主页点击右上角用户头像,选择弹出来的列表中的Settings按钮,在左侧的菜单中滚动到最底下,选择Developer settings。接着在新出现的页面中点击左侧的Personal Access Tokens,选择第一个Fine-Grained tokens,点击Generate new token,输入账户的密码。
  6. 在页面中填写名称、描述等信息,滚动到底部,设置Repository accessAll repositories
  7. 在页面底部的Permissions字段下面的方框的右上角点击Add permissions,选择Contents(温馨提示:不要用搜索工具,搜不出来)把新出现的两行的右边的下拉框都改成Read and write
    最终效果如图所示
  8. 点击绿色按钮后尽快复制页面上的token。此token只显示一次,请务必妥善保存
2.2.2.2.2 配置应用程序


打开SyncTunnel,转到“设置”页面,将注册Github时用的账号名称(不是邮件)填入Github账号字段,将刚刚复制的token填入Github PAT中,点击“保存设置”,应用程序自动重启,设置完成。




2.3 功能介绍与使用

功能介绍

本软件是数据同步软件,可以在不同设备之间同步数据。默认情况采用STUN打洞进行文件同步。当路由器设备不支持STUN时可以自动切换到IPv6直连传输。
在使用之前,需要先点击左侧页面栏的用户协议认真阅读并同意。

更新
自beta 1.2.7开始,支持在设置页面手动切换到IPv6模式

2.3.1 打开软件

打开软件时,新用户默认自动切换到用户协议页面,之后打开默认切换到文件视图页面。
打开软件后,请不要立即使用。请关注右下角的提示。

2.3.2 同步文件

在同步文件前,请确保

您可以通过按下快键键Ctrl+U或者点击菜单栏中的文件,点击同步文件来同步文件

下面是一份表格,标识了文件同步过程中右下角可能出现的文字

发送端
出现的文字 含义
正在加载文件 正在对文件进行加载、加密、分片等操作
正在发送文件,包1/1234 时间:3秒 速度1586kb/s 文件正在发送,标识了速度、已用时间和发送进度
发送文件完毕 文件的发送操作完成。注意,文件没有真正发送完成,还有重传步骤未进行!
正在回复重传请求 正在回复其他客户端发来的重传请求
文件释放完成 真正意义上的文件发送完成
接收端
出现的文字 含义
正在接收文件,包1/1234 文件正在接收
文件操作完成 文件的操作完成。注意,文件没有真正接收完成,还有重传步骤未进行!
正在请求重传 正在回复其他客户端发来的重传请求
文件释放完成 真正意义上的文件发送完成

注意:接收端最后可能不会显示文件释放完成,这是由于网络波动导致的bug,如果发送端显示了文件释放完成或者接收端10秒内没有接收到任何包,则也算完成。

2.3.3 挂起文件

请确保已经按照上文所述设置了Github 账号和PAT。
在离线前,点击菜单栏的文件,点击挂起文件,开始挂起。
注意,请勿在已经有文件挂起的时候再次进行文件挂起操作,否则会挂起失败!
在上线后点击文件->下载同步的文件下载。

如果是刚刚下载本软件的用户请点击这里继续学习文件挂起配置


3 常见问题

还没有常见问题。遇到问题请发送邮件到nnpyro2@outlook.com

问题描述 解决办法 版本 备注
在进入应用程序的时候弹出对话框显示“无法联接到MQTT服务器” 默认服务器broker.emqx.io因未知原因无法提供服务,请手动切换到 test.mosquitto.org 所有版本
在挂起文件时挂起失败 参见下文 所有版本

3.1 文件挂起问题排查

首先你需要按照以下步骤先排查问题。在下文的行末会有像这样的字体,标识了问题的原因,其代表的具体信息和解决办法请到后面解决问题部分进行查阅。


解决问题

服务器问题

表示Github服务器出现问题。Github是国外服务器,国内特定地区联接不稳定。
解决办法:

API限制

Github限制API有每小时5000次访问限制。如果超出限制会禁止访问
解决办法:

偶然性问题

互联网环境复杂,容易出现网络波动等偶然性问题
解决办法:

配置错误

配置Github时出错
解决办法: