# lanp-docs

**Repository Path**: fengfei/lanp-docs

## Basic Information

- **Project Name**: lanp-docs
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-14
- **Last Updated**: 2023-11-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 系统文档
### 服务端
Lanproxy是一个将局域网个人电脑、服务器映射到公网的内网穿透工具，支持tcp流量转发，可支持任何tcp上层协议（访问内网网站、本地支付接口调试、微信小程序调试、ssh访问、远程桌面...）
Lanproxy个人升级版在开源版本上增加了部分高级功能，穿透核心功能无变化。
开源版代码库 https://github.com/ffay/lanproxy
升级版体验地址 https://lanp.nioee.com/ 测试账号密码 test/123456，也可自己注册试用账号。

核心功能如下：

- 穿透基础功能，同开源版本，高性能，可同时支持数万穿透连接
- 全新界面UI，操作简单，部署简单（java+mysql）
- 自定义域名绑定，为你穿透端口绑定域名，不再是IP+端口裸奔访问
- 自定义域名ssl证书，也可为你绑定的域名开启ssl证书自动申请与续期，无需人工干涉
- 自定义客户端离线展示页面，可以利用该功能展示一些html单页
- 支持http/https/socks5多种模式使用客户端网络代理上网，家里轻松访问公司网络
- 多用户支持，同时满足多人日常穿透需求

#### 版本价格
![plan](plan.png)

#### 系统安装
> 购买后，提供软件安装包

1.安装java环境（1.8或以上版本）以及mysql（5.7以上版本，建议8.0及以上版本），网上搜索安装教程，有很多详细文档。
2.在mysql中创建lanproxy数据库，在数据库中执行安装包中的lanproxy.sql脚本。
3.修改配置文件config.properties

```properties
#以下三个配置项中数据库、用户名、密码更换成你自己的即可
jdbc.url=
jdbc.username=
jdbc.password=

#登录cookie信息加密密钥，建议修改
jwt.secretKey=123456

#lanproxy客户端连接端口
server.ssl.port=4993

#反向代理服务器端口配置
http.server.bind=0.0.0.0
http.server.port=80

https.server.bind=0.0.0.0
https.server.port=443
```

4.启动服务，执行./bin/startup.sh（windows执行./bin/startup.bat）

#### 后台配置
经过上面的安装运行后，通过默认用户名密码admin/123456登录进行系统配置。
![web-config](web-config.png)

- **是否开启注册**，填1为开启，0关闭
- **穿透服务端口段**，用于在配置映射时自动分配对外访问端口
- **根域名**，在穿透配置时用于分配可访问的子域名，需要将“*.根域名”解析到你的服务器IP，例如我这填写的根域名是 al.cdjxt.net，需要将 *.al.cdjxt.net 解析到我的服务器IP 47.108.53.99，这样在配置穿透映射时将自动分配域名，例如 m10001.al.cdjxt.net
- **域名SSL证书配置**，这里需要配置的是“*.根域名”的泛域名证书（目前泛域名证书没有做自动申请），配置好后，在配置穿透映射时自动分配的域名即可使用https访问，例如 https://m10001.al.cdjxt.net

#### 功能手册

##### 终端管理

1.登录后，点击左侧菜单“终端管理”，点击“创建客户端”会生成一个客户端配置
![img](add-client.png)

2.下载客户端 [【Windows 64位】 ](client_windows_amd64.zip)[【Mac OS 64位】 ](client_darwin_amd64.zip)[【Linux 64位】 ](client_linux_amd64.zip)

3.在第一步中生成了客户端配置，点击“连接命令”，复制对应的客户端执行命令
![img](client-cmd.png)

4.windows打开cmd窗口执行，linux和mac os请在终端命令行中执行
![img](run-client.png)

5.执行完成上面的命令后可以在“终端管理”中查看客户端状态是否为“上线”
![img](client-online.png)

##### 穿透配置
1.点击左侧菜单“映射配置”，将看到上面创建的客户端信息，点击“添加配置”
   ![img](client-config.png)
- **后端服务映射信息**，该配置项填写运行的客户端所处网络环境能访问的地址+端口，例如把自己电脑上的web服务映射出去，这里填写 127.0.0.0:80

- **后端服务协议**，需要映射出去的局域网服务协议，例如你电脑上的网站选择http，vnc远程桌面选择tcp，ssh选择tcp等

- **发送给后端的host**，这个配置项可以修改发送给你后端应用接收的域名，一些特殊场景可能有用

- **域名绑定**，支持绑定域名，需要将绑定的域名解析到你的服务器IP，支持泛域名解析，例如*.baidu.com，需要将你的泛域名解析到你的服务器IP

- **自动申请SSL证书**，不支持泛域名证书申请，只对自定义绑定的非泛域名有效，系统自动分配的域名证书请到系统配置中设置

- **强制跳转https**，这个配置项可以将你访问的域名自动跳转到https进行访问

- **域名证书配置**，如果配置的自动申请SSL证书，这里不需要手动配置，当然也可以把你已有的证书手动配置到这里

- **离线展示内容**，这里配置的客户端离线后的提示信息，支持html标签，可以利用该功能展示一些html单页，该配置项有一个隐藏功能，如果配置的是http开头的网络地址，当客户端离线后会自动反向代理到该地址，类似nginx的反向代理功能



2.上面配置的域名没有解析正确，所以ssl证书自动申请失败，页面上会有相应的提示
![img](ssl-error.png)
域名配置与解析正确后，配置列表上域名将会以https打头
![img](ssl-success.png)

3.通过域名访问上面完成的配置，即访问了我电脑上的网站
![img](local-web.png)

4.离线配置，当客户端离线时访问域名将展示这里配置的内容
![img](offline-notice.png)

5.客户端离线后访问
![img](client-offline.png)

### 客户端


#### 源码地址

https://github.com/ffay/lanproxy-go-client



#### 基础使用

> 如何使用在上面的功能介绍中已有示例



```
./client_darwin_amd64 -s SERVER_IP -p SERVER_PORT -k CLIENT_KEY -ssl true
```

> eg: nohup ./client_darwin_amd64 -s 47.108.53.99 -p 4993 -k b59f52fc1dff41a4b5e8c68c0de5e466 -ssl true &



```
GLOBAL OPTIONS:
   -k value       client key
   -s value       proxy server host
   -p value       proxy server port (default: 4900)
   --ssl value    enable ssl (default: "false", -p value should be server ssl port)
   --help, -h     show help
   --version, -v  print the version
```