花生壳PHTunnel嵌入文档

一、概述

PHTunnel是新一代花生壳核心应用，纯c实现，速度较上一代有显著性能提升，并减小了文件大小。 本文档帮助用户在设备上运行PHTunnel，并完成理解PHTunnel的运行方式。

二、安装

1、成为开发者并创建花生壳应用

登录贝锐开放平台申请成为开发者。创建花生壳应用同时获得AppID和AppKey。

2、下载

在贝锐开放平台下载对应平台的二进制可执行程序。

三、使用

1、启动PHTunnel

1.1、直接运行PHTunnel --appid 9056 --appkey 3xxxxxxxx5 -l /tmp/PHTunnel.log 其中appid和appkey参数为开发者平台获取的参数，-l为日志输出路径 1.2、使用微信扫一扫登录花生壳账号 1.3、登录b.oray.com、添加映射 1.4、访问映射地址

2、关闭PHTunnel

可通过-p --pid参数指定的文件中拿到PHTunnel的进程pid，然后调用kill命令终止PHTunnel。 如kill $(cat /tmp/PHTunnel.pid 2> /dev/null | grep 'pid=' | cut -d'=' -f2 2> /dev/null)

3、PHTunnel参数列表

-h, --help 帮助

-s, --server 服务器地址

-l, --log 日志文件路径

-v, --verbose 打印详细日志到标准输出

-q, --qrcode print login qrcode

-r, --rpc 是否开启rpc监听

-c, --config 配置文件加载路径

-p, --pid 输出的状态文件，里面包括进程的pid，方便关闭时杀掉进程

-f, --forward Remote admin forward, default: 127.0.0.1:80

-d,--daemon 后台运行(linux)

-S,--service 作为windows服务运行(windows)

-i,--appid App ID

-k,--appkey App Key

-e,--deviceinfo 设备自定义数据

4、后台运行方式

由于在前台运行不方便，更多的需求是后台运行，但后台运行无法直观的拿到二维码登录信息。以下将说明后台运行的方法。

1. 1)运行PHTunnel， 注意添加-r或--rpc参数和-d或--daemon参数
2. 2)通过getsn接口(参阅下表)拿到sn和随机密码
3. 3)使用接口返回的sn和密码访问https://hsk-embed.oray.com/devices/qrcode并获取二维码(参阅下表)
4. 4)组织逻辑将二维码显示在用户界面上
5. 5)通过手机扫描二维码并登录花生壳
6. 6)通过getmgrurl接口(参阅下表)得到用户云管理入口，引导用户进入后台管理界面

获取SN和密码接口

二维码刷新接口

获取二维码的图片地址以及二维码有效期

映射管理接口

映射管理接口返回管理url，自动登录b.oray.com进行映射管理。

设备账号解绑接口

四、实例

参阅 OpenWrt嵌入实例 文档，为openwrt系统嵌入实例。