# 鹊桥

**Repository Path**: quickthinking/magpiebridge

## Basic Information

- **Project Name**: 鹊桥
- **Description**: 鹊桥（内网穿透），使用java基于aio/nio实现的内网穿透工具，致力于帮助开发者内网开发供外部调试使用
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://blog.jiucheng.org
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 196
- **Created**: 2019-09-05
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 鹊桥（内网穿透）

#### 介绍
[使用java基于aio/nio实现的内网穿透工具，致力于帮助开发者内网开发供外部调试使用。](http://blog.jiucheng.org/article/10097)

#### 软件架构
![软件架构图](https://images.gitee.com/uploads/images/2019/0616/165254_c3715fbf_120615.png "build-0.0.1.png")

#### 源码打包正式包

```
mvn clean install -Dmaven.test.skip -Denv=release
```

#### 安装教程

1. 准备公网（假设公网ip=10.1.1.22）服务器，安装openjdk1.7+
   下载发行版本（magpiebridge-server-0.0.1.tar.gz）服务端
   解压magpiebridge-server-0.0.1.tar.gz到指定目录
  （tar -zxvf magpiebridge-server-0.0.1.tar.gz -C /usr/local/magpiebridge-server）
   解压后目录及文件结构如下：
   ```
   \_bin
       |_startup.sh
       |_stop.sh
   \_conf
       |_cfg.properties
   \_lib
       |_magpiebridge-common-0.0.1.jar
       |_magpiebridge-server-0.0.1.jar
   \_logs
   ```
   配置服务端端口（供客户端连接使用）、代理端端口（对外服务端口）（vim /usr/local/magpiebridge-server/conf/cfg.properties）
   ```
   # server
   # 服务端IP及端口
   server.ip=0.0.0.0
   server.port=9799
   
   # 根据域名自动分发转向
   server.mappings=0.0.0.0:80

   # 代理端端口映射内网具体端口
   server.10001.mappings=0.0.0.0:13389/192.168.1.102:3389,0.0.0.0:13306/127.0.0.1:3306,onlyfordev.jiucheng.org/127.0.0.1:8080
   ```
   如上d563d057c1bc45f781459faf8bf5b32b（客户端的密钥）供客户端配置使用，来确认打开具体代理端口
   用户访问公网服务器的13389端口会被转发请求到内网IP（192.168.1.102）3389端口
   同样用户访问公网服务器的13306端口会被转发请求到内网IP（127.0.0.1即客户端允许机器）3306端口
   启动服务端及代理端
   ```
   /usr/local/magpiebridge-server/bin/startup.sh
   ```
   关闭服务端及代理端
   ```
   /usr/local/magpiebridge-server/bin/stop.sh
   ```
2. 准备内网服务器，安装openjdk1.7+
   下载发行版本（magpiebridge-client-0.0.1.tar.gz）服务端
   解压magpiebridge-client-0.0.1.tar.gz到指定目录
  （tar -zxvf magpiebridge-client-0.0.1.tar.gz -C /usr/local/magpiebridge-client）
   解压后目录及文件结构如下：
   ```
   \_bin
       |_startup.sh
       |_stop.sh
   \_conf
       |_cfg.properties
   \_lib
       |_magpiebridge-common-0.0.1.jar
       |_magpiebridge-client-0.0.1.jar
   \_logs
   ```
   配置客户端的服务端IP及端口（vim /usr/local/magpiebridge-client/conf/cfg.properties）
   ```
   # server info
   # 配置公网服务器的服务端IP及端口
   server.ip=10.1.1.22
   server.port=9799

   # 配置（服务端对应客户端的密钥）
   client.key=10001
   ```
   启动客户端
   ```
   /usr/local/magpiebridge-client/bin/startup.sh
   ```
   关闭客户端
   ```
   /usr/local/magpiebridge-client/bin/stop.sh
   ```

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


#### 开源许可协议

1. GNU General Public License v2.0