# lanzhou-through

**Repository Path**: wowniu/lanzhou-through

## Basic Information

- **Project Name**: lanzhou-through
- **Description**: 基于公网工具的ngrock穿透封装, 做一些配置后, 可以生产公网使用地址的SDK

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-05-01
- **Last Updated**: 2022-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lanzhou-through

#### 介绍
基于公网工具的ngrock穿透封装, 只需做一些配置后, 就可以生产公网使用地址的SDK

目前仅支持`windows` 系统的开发运行调试, 用于生产时的穿透, 稳定性未测试, 若是需要内网穿透的非常推荐用来调试

#### 软件架构
1. 基于钉钉的ngrock穿透内核封装的穿透实现
2. 基于natappp的穿透内核实现
3. 基于springboot的封装
4. 主要采用技术为: springboot, common-io, java执行bat脚本, 多线程等

#### 安装教程
##### 开始使用时需要注意两点:
> 1. 有网! 有网!! 有网!!(重要的事情说三遍), 可以访问公网地址
> 2. 基于钉钉实现不需要做任何配置, 但需要对冲突域名进行更改; 基于natapp实现需要向网址注册`https://natapp.cn/` 账号, 将信息填写到对应的配置即可



1.  基于DingDing的实现
> 基于钉钉的实现比较简单, 只需要配置以下属性即可开启穿透功能

```yaml
through:
  enable: true
  # 填写值固定为ding, 不可更改
  adopt: ding
  # 填写你的域名名称, 可以自定义, 但不可冲突
  sub-domain: lanzhou
```

2.  基于NatApp的实现
> 需要想官网注册账号`https://natapp.cn/`, 以及一些实名操作(除此之外需要配置你的映射端口)
```yaml
through:
  enable: true
  # 填写值固定为nat, 不可更改
  adopt: nat
  # 填写你的natapp账户的auth-token(免费隧道那个)
  auth-token: xxxxxx
```

#### 使用说明

1.  maven导入当前SDK坐标
2.  选择填写以上两种配置方式之一即可开启映射
3.  启动时会弹出弹框给你提示你的域名是否穿透可用

#### 参与贡献

1.  官方 DingDing
2.  NatApp 隧道服务
3.  SpringBoot 官方, Apache开源基金会
4.  Lanzhou 本人


#### 特技

[完]