Compare commits

..
29 Commits
Author SHA1 Message Date
songyinyin 455638c4cf test github action v26 兼容更多类型的cpu 2023-10-25 18:09:18 +08:00
songyinyin 09b200455d test github action v25 2023-10-25 17:37:16 +08:00
songyinyin 245bd274e2 test github action v24 web url 2023-10-25 17:34:27 +08:00
songyinyin 028f114c5f Merge remote-tracking branch 'origin/dev' into dev 2023-10-25 17:15:02 +08:00
songyinyin 6cb98cd2bd test github action v23 2023-10-25 17:07:27 +08:00
songyinyin b718c048ea test github action v22 2023-10-25 16:31:14 +08:00
songyinyin d202caa499 test github action v21 2023-10-25 16:16:26 +08:00
songyinyin 8591e224dc test github action v20 windows xcopy 2023-10-25 16:15:32 +08:00
songyinyin 5953256c11 test github action v19 2023-10-25 16:02:55 +08:00
songyinyin 8d5b7edf12 test github action v18 add sql 2023-10-25 16:01:55 +08:00
songyinyin e74dc64a9a test github action v17 2023-10-25 14:10:31 +08:00
songyinyin 47b6a24a42 test github action v16 2023-10-25 13:10:31 +08:00
songyinyin 0095ffc65c test github action v15 name 2023-10-25 12:06:36 +08:00
songyinyin 299d75957b test github action v15 2023-10-25 11:57:57 +08:00
songyinyin db13fb49b1 test github action v14 2023-10-25 11:42:02 +08:00
songyinyin 94cac52ad2 test github action v13 all os 2023-10-25 11:33:17 +08:00
songyinyin 32780f34a4 test github action v13 2023-10-25 11:14:44 +08:00
songyinyin 8dd58035a6 test github action v12 2023-10-25 10:58:21 +08:00
songyinyin ee55a4104a test github action v11 2023-10-25 10:53:55 +08:00
songyinyin 1651f2ca1c test github action v10 2023-10-25 10:50:38 +08:00
songyinyin ba93dcbeac test github action v09 2023-10-25 10:36:20 +08:00
songyinyin cbc7ea7d25 test github action v08 2023-10-25 10:33:24 +08:00
songyinyin e0c6885b03 test github action v07 2023-10-25 10:30:58 +08:00
songyinyin c6694b7dc8 test github action v06 2023-10-25 10:27:48 +08:00
songyinyin a2a5beaf5b test github action v05 2023-10-24 19:13:39 +08:00
songyinyin 418a44a7c2 test github action v04 2023-10-24 19:09:55 +08:00
songyinyin d78a1d7d9b test github action v03 2023-10-24 19:04:30 +08:00
songyinyin bd4f4a056d test github action v02 2023-10-24 18:48:10 +08:00
songyinyin 364d77f38f test github action 2023-10-24 18:38:24 +08:00
42 changed files with 339 additions and 472 deletions
+3 -2
View File
@@ -1,4 +1,4 @@
name: Build linux and mac native image
name: jar release
on:
workflow_dispatch:
@@ -12,7 +12,8 @@ jobs:
fail-fast: false
matrix:
# see: https://docs.github.com/zh/actions/using-jobs/choosing-the-runner-for-a-job
os: ['ubuntu-20.04', 'macos-12']
# os: ['ubuntu-20.04', 'macos-12']
os: ['ubuntu-20.04']
name: build - ${{ matrix.os }}
runs-on: ${{ matrix.os }}
# https://github.com/softprops/action-gh-release/issues/236#issuecomment-1150530128
+5 -6
View File
@@ -1,10 +1,10 @@
name: Build windows native image
name: jar release
on:
workflow_dispatch:
push:
tags:
- 'v*'
- 'win*'
jobs:
build:
@@ -12,6 +12,7 @@ jobs:
fail-fast: false
matrix:
# see: https://docs.github.com/zh/actions/using-jobs/choosing-the-runner-for-a-job
# os: ['ubuntu-20.04', 'windows-latest', 'macos-latest']
os: ['windows-2022']
name: build - ${{ matrix.os }}
runs-on: ${{ matrix.os }}
@@ -46,11 +47,10 @@ jobs:
${{ runner.os }}-maven-
- name: Build with Maven (neutrino-proxy-server)
run: |
set MAVEN_OPTS=-Duser.language=UTF-8 -Dfile.encoding=UTF-8
mvn clean install -pl neutrino-proxy-core -am -DskipTests --no-transfer-progress
cd neutrino-proxy-server
mvn clean native:compile -P native --file pom.xml --no-transfer-progress
cp target/neutrino-proxy-server.exe ./../neutrino-proxy-server.exe
cp target/neutrino-proxy-server.exe ./neutrino-proxy-server.exe
- name: Archive zip (neutrino-proxy-server)
uses: thedoctor0/zip-release@master
with:
@@ -59,11 +59,10 @@ jobs:
filename: neutrino-proxy-server-${{ matrix.os }}-${{ github.ref_name }}.zip
- name: Build with Maven (neutrino-proxy-client)
run: |
set MAVEN_OPTS=-Duser.language=UTF-8 -Dfile.encoding=UTF-8
cd neutrino-proxy-client
mvn clean package --file pom.xml --no-transfer-progress
mvn clean native:compile -P native --file pom.xml --no-transfer-progress
cp target/neutrino-proxy-client.exe ./../neutrino-proxy-client.exe
cp target/neutrino-proxy-client.exe ./neutrino-proxy-client.exe
- name: Archive zip (neutrino-proxy-client)
uses: thedoctor0/zip-release@master
with:
+1 -1
View File
@@ -5,7 +5,7 @@
- [x] 启动参数
- [x] 外部配置文件
- [x] 环境变量
- [x] 日志
- [ ] 日志
- [x] 控制台输出
- [x] debug启动有netty错误日志
- [x] 文件输出
Binary file not shown.

Before

Width:  |  Height:  |  Size: 262 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 502 KiB

-57
View File
@@ -1,57 +0,0 @@
# 中微子代理(NeutrinoProxy)2.0.0重磅发布
## 项目简介
- [中微子代理(neutrino-proxy)](https://gitee.com/asgc/neutrino-proxy) 是一款基于netty的内网穿透神器。该项目采用最为宽松的MIT协议,因此您可以对它进行复制、修改、传播并用于任何个人或商业行为。
- 市面上基于内网穿透的常见产品有:花生壳、TeamView、cpolar等。
- 常见的使用场景:
- 本地开发调试第三方回调
- 本地开发异地接口连调
- 远程登录内网windows机器
- 将本地服务映射到外网,用于演示
- Gitee仓库:https://gitee.com/dromara/neutrino-proxy
- Github仓库:https://github.com/dromara/neutrino-proxy
- 官网地址1: https://neutrino-proxy.dromara.org
- 官网地址2: https://dromara.gitee.io/neutrino-proxy
## 主要特点:
- 1、流量监控:首页图表、报表管理多维度流量监控。全方位掌握实时、历史代理数据。
- 2、用户/License:支持多用户、多客户端使用。后台禁用实时生效。
- 3、端口池:对外端口统一管理,支持用户、License独占端口。
- 4、端口映射:新增、编辑、删除、禁用实时生效。
- 5、Docker:服务端/客户端支持Docker一键部署。
- 6、SSL证书:隧道通信支持SSL加密,保护您的数据安全。
- 7、域名映射:支持绑定子域名,方便本地调试三方回调
- 8、多种协议:支持代理TCP、HTTP、HTTPS、UDP协议
- 9、原生部署:支持编译为原生可执行文件,更低部署门槛、更少内存占用
- 10、采用最为宽松的MIT协议,免去你的后顾之忧
## 更新内容
- solon版本升级为`2.5.11`
- jdk版本升级为17
- 支持原生编译改造
- 默认支持的数据库由sqlite改为h2
- 官方默认使用的docker镜像仓库从阿里云改为dockerhub
## 安装使用说明
- 快速上手:[点击这里](https://neutrino-proxy.dromara.org/neutrino-proxy/pages/793dcb/)
- 升级须知:
- jdk版本升级为了jdk17,jar部署时请注意
- 去掉了默认的sqlite数据库,改为了h2。如果之前使用sqlite,请自行处理数据迁移
- 配置文件做了较大调整,请参照官网使用须知中的`服务端配置``客户端配置`进行更新
## 运行示例
#### 管理后台首页
<img src="./home.png" width="100%"/>
#### 端口映射
<img src="./port-mapping2.png" width="100%"/>
## 联系我们
笔者时间、能力有限,且开源项目非一朝一夕之事,存在众多问题亦在所难免。使用、学习过程中有任何问题欢迎大家与我联系。
对项目有什么想法或者建议,可以加我微信拉交流群,或者创建[issues](https://gitee.com/dromara/neutrino-proxy/issues),一起完善项目
- 微信号:yuyunshize
- Email: aoshiguchen@dromara.org
- 微信二维码(添加时请备注"中微子进群"):
<img src="MyWeChatQRCode.jpeg" width="100%"/>
Binary file not shown.

Before

Width:  |  Height:  |  Size: 262 KiB

@@ -1,12 +1,9 @@
solon:
config:
add: ./app.yml
# 日志级别
solon.logging.appender:
console:
pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta(${PID:-}) --- %-15([%15.15thread]) %-56(%cyan(%-40.40logger{39}%L)) : %msg%n"
file:
enable: true
enable: false
pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- %-15([%15.15thread]) %-56(%-40.40logger{39}%L) : %msg%n"
name: "logs/${neutrino.application.name}"
rolling: "logs/${neutrino.application.name}_%d{yyyy-MM-dd}_%i.log.gz"
@@ -5,8 +5,6 @@ server:
solon:
app:
name: neutrino-proxy-server
config:
add: ./app.yml
# aot:
# jvmArguments: --add-opens java.base/java.lang=ALL-UNNAMED
# 日志级别
@@ -14,14 +12,14 @@ solon.logging.appender:
console:
pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %magenta(${PID:-}) --- %-15([%15.15thread]) %-56(%cyan(%-40.40logger{39}%L)) : %msg%n"
file:
enable: true
enable: false
pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level ${PID:-} --- %-15([%15.15thread]) %-56(%-40.40logger{39}%L) : %msg%n"
name: "logs/${solon.app.name}"
rolling: "logs/${solon.app.name}_%d{yyyy-MM-dd}_%i.log"
solon.logging.logger:
"root":
level: ${LOG_LEVEL:info}
# level: info
# level: ${LOG_LEVEL:info}
level: info
neutrino:
@@ -30,8 +30,7 @@ module.exports = {
{text: '后台操作指南', link: '/pages/793dcc/'},
]
},
{text: '支持', link: '/pages/a3f096/'},
{text: '更新记录', link: '/pages/ff3519/'},
{text: '演示', link: '/pages/db78e2/'},
{text: 'Gitee', link: 'https://gitee.com/dromara/neutrino-proxy'},
],
sidebarDepth: 2, // 侧边栏显示深度,默认1,最大2(显示到h3标题)
@@ -1,40 +0,0 @@
---
title: 快速上手
date: 2023-03-28 20:30:00
permalink: /pages/793dcb
article: false
---
::: tip
当前最新版本为2.0.0,如果从之前的版本升级而来,请注意以下变更
1、jdk版本升级为了jdk17,jar部署时请注意
2、去掉了默认的sqlite数据库,改为了h2。如果之前使用sqlite,请自行处理数据迁移
3、配置文件做了较大调整,请参照使用须知中的`服务端配置``客户端配置`进行更新
:::
## 1、快速上手须知
- 所谓快速上手,就是针对从来没用过的新手编写的、快速完成从安装部署到首次使用的最简化流程
- 该流程中请严格按照说明步骤执行,不要靠猜测自作聪明的修改配置
- 如果的确需要修改,请先把安装部署、使用须知、常见问题全部仔细读一遍
- 快速上手中涉及到的配置,仅仅是快速体验所必须的配置,完整的配置请参照使用须知中的`服务端配置``客户端配置`
## 2、部署服务
- 根据需要自行选择jar、docker、原生部署任意一种完成部署
- 三种方式分别参见对应的文档
- 任何一种部署方式,不要求客户端与服务端一致。如:服务端采用docker部署,客户端可以用docker部署、也可以用jar、原生部署
- 管理后台说明
- 服务端部署成功后,访问http://{服务端IP}:8888打开后台管理页面。使用默认的管理员帐号登录:admin/123456
- 打开代理配置>License管理页面,可以看到系统已经自动为管理员初始化了一条License记录,复制该LicenseKey备用,后续客户端配置需要。
- 客户端说明
- 客户端启动后,查看服务端License管理,刷新页面,对应的License在线状态为`在线`,则表明客户端已正常连接。
## 3、代理验证
- 本地启动被代理服务,如:redis、本地web项目、本地mysql等等,假设被代理服务端口为:8080
- 先确保本地能正常访问被代理服务,如果本地都不能访问,不用想代理更不可能!!!
- 服务端管理后台端口映射管理,使用默认的licesne创建一条端口映射,如:9101 -> 127.0.0.1:8080
- 通过服务端IP+9101(上面License配置的端口映射重的服务端端口)访问本地被代理服务
访问成功,至此首次完整的内网穿透体验完成。开源不易,请速至[Gitee仓库](https://gitee.com/dromara/neutrino-proxy)一键三连🤝
@@ -1,55 +0,0 @@
---
title: 使用jar部署
date: 2023-10-26 13:50:45
permalink: /pages/eebea1/
---
## 1、环境准备
- 首先确保已安装Java17运行环境
- 打开[发行版页面](https://gitee.com/dromara/neutrino-proxy/releases),下载最新的release包:`neutrino-proxy-server.jar``neutrino-proxy-client.jar`
## 2、部署服务端
- 在服务器上新建部署目录:`/work/projects/neutrino-proxy-server`
-` neutrino-proxy-server.jar`上传至服务器部署目录。
- 执行命令`java -Dfile.encoding=utf-8 -jar neutrino-proxy-server.jar`启动服务端完成部署,默认使用h2数据库。
- 若需要指定自己的mysql数据库,同样的需要在当前目录下新建`app.yml`文件,配置内容如下。执行命令`java -Dfile.encoding=utf-8 -jar neutrino-proxy-server.jar config=app.yml`启动服务端完成部署
```yml
neutrino:
data:
db:
type: mysql
# 自己的数据库实例,创建一个空的名为'neutrino-proxy'的数据库即可,首次启动服务端会自动初始化
url: jdbc:mysql://xxxx:3306/neutrino-proxy?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true&useAffectedRows=true&useSSL=false
driver-class: com.mysql.jdbc.Driver
# 数据库帐号
username: xxx
# 数据库密码
password: xxx
```
- 可参照 https://gitee.com/dromara/neutrino-proxy/blob/master/scripts/unix/server_start.sh 使用shell脚本启动服务端。
## 3、部署客户端
- 客户端采用docker部署,使用代理时会存在更多的坑点,因此官方并不推荐
- 在本地`neutrino-proxy-client.jar`同级别目录下新建`app.yml`文件,并配置如下内容:
```yml
neutrino:
proxy:
tunnel:
# ssl证书密钥(使用jjar包内自带的证书,则此处无需修改)
key-store-password: 123456
# ssl证书管理密钥(使用jjar包内自带的证书,则此处无需修改。自定义证书,则此处配置对应的路径)
jks-path: classpath:/test.jks
# 代理服务端IP
server-ip: xxxx
# 代理服务端IP, 若是非ssl端口,则ssl-enable需要配置为false
server-port: 9002
# 是否启用ssl
ssl-enable: true
# licenseKey,客户端凭证。此处需要配置刚刚从管理后台复制的LicenseKey
license-key: xxxx
```
- 执行命令`java -jar neutrino-proxy-client.jar config=app.yml`启动客户端
@@ -1,42 +0,0 @@
---
title: 使用docker容器化部署
date: 2023-10-26 13:51:29
permalink: /pages/5b9bef/
---
## 1、 部署服务端
### 使用默认h2数据库一键部署
```shell
docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 \
-d --restart=always --name neutrino-proxy \
-v /root/neutrino-proxy-server/config:/root/neutrino-proxy/config \
-v /root/neutrino-proxy-server/data:/root/neutrino-proxy/data \
-v /root/neutrino-proxy-server/logs:/root/neutrino-proxy/logs \
registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy:latest
```
### 指定自己的mysql数据库
- 在服务器上创建目录:/root/neutrino-proxy/config
- 在该目录下创建`app.yml`文本文件,并配置如下内容:
```yml
neutrino:
data:
db:
type: mysql
# 自己的数据库实例,创建一个空的名为'neutrino-proxy'的数据库即可,首次启动服务端会自动初始化
url: jdbc:mysql://xxxx:3306/neutrino-proxy?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true&useAffectedRows=true&useSSL=false
driver-class: com.mysql.jdbc.Driver
# 数据库帐号
username: xxx
# 数据库密码
password: xxx
```
- 然后再执行上面的docker一键部署命令即可
## 2、部署客户端
- 命令中的服务端ip、license请自行补充
- 若是首次使用,请仔细月度快速上手,以确定license从哪里取得
```shell
docker run -it -d --restart=always --name npclient -e SERVER_IP=xxxx -e LICENSE_KEY=xxxx \
aoshiguchen/neutrino-proxy-client:latest
```
@@ -1,5 +0,0 @@
---
title: 原生部署
date: 2023-10-26 13:51:44
permalink: /pages/69699a/
---
@@ -0,0 +1,123 @@
---
title: 快速上手
date: 2023-03-28 20:30:00
permalink: /pages/793dcb
article: false
---
## 1、 部署服务端
### 1.1、 Docker一键部署
> 当前最新版本为1.9.0,下面的脚本中,可以使用:`registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy:1.9.0` 指定版本安装,推荐使用`latest`直接安装最新版。
#### 使用默认sqlite数据库
```shell
docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 \
-d --restart=always --name neutrino-proxy \
registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy:latest
```
#### 指定自己的mysql数据库
- 在服务器上创建目录:/root/neutrino-proxy/config
- 在该目录下创建`app.yml`文本文件,并配置如下内容:
```yml
neutrino:
data:
db:
type: mysql
# 自己的数据库实例,创建一个空的名为'neutrino-proxy'的数据库即可,首次启动服务端会自动初始化
url: jdbc:mysql://xxxx:3306/neutrino-proxy?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true&useAffectedRows=true&useSSL=false
driver-class: com.mysql.jdbc.Driver
# 数据库帐号
username: xxx
# 数据库密码
password: xxx
```
- 然后执行如下命令:
```shell
docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 \
-v /root/neutrino-proxy/config:/root/neutrino-proxy/config \
-d --restart=always --name neutrino \
registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy:latest
```
### 1.2、使用jar包自行部署
- 首先确保服务器上已安装java8运行环境
- 打开[发行版页面](https://gitee.com/dromara/neutrino-proxy/releases),下载最新的release包:`neutrino-proxy-server.jar``neutrino-proxy-admin.zip`
- 在服务器上新建部署目录:`/work/projects/neutrino-proxy-server`
-` neutrino-proxy-server.jar``neutrino-proxy-admin.zip`上传至服务器部署目录。
- 解压`neutrino-proxy-admin.zip`文件
- 执行命令`java -Dfile.encoding=utf-8 -jar neutrino-proxy-server.jar`启动服务端完成部署,默认使用sqlite数据库。
- 若需要指定自己的mysql数据库,同样的需要在当前目录下新建`app.yml`文件,文件内容同上。执行命令`java -Dfile.encoding=utf-8 -jar neutrino-proxy-server.jar config=app.yml`启动服务端完成部署
- 可参照 https://gitee.com/dromara/neutrino-proxy/blob/master/scripts/unix/server_start.sh 使用shell脚本启动服务端。
## 2、管理后台配置
- 服务端部署成功后,访问`http://{服务端IP}:8888`打开后台管理页面。
- 使用默认的管理员帐号登录:admin/123456
- 打开`代理配置>License管理`页面,可以看到系统已经自动为管理员初始化了一条License记录,复制该`LicenseKey`备用,后续客户端配置需要。
- 打开`代理配置>端口映射`页面,可以看到系统已经自动为初始化了几条端口映射。可根据需要自行添加、修改。这里我们以`9101 -> 127.0.0.1:8080`映射为例
## 3、启动客户端
- 首先确保本地已安装java8运行环境
- 打开[发行版页面](https://gitee.com/dromara/neutrino-proxy/releases),下载最新的release包:`neutrino-proxy-client.jar`
- 在本地`neutrino-proxy-client.jar`同级别目录下新建`app.yml`文件,并配置如下内容:
```yml
neutrino:
proxy:
tunnel:
# ssl证书密钥(使用jjar包内自带的证书,则此处无需修改)
key-store-password: 123456
# ssl证书管理密钥(使用jjar包内自带的证书,则此处无需修改。自定义证书,则此处配置对应的路径)
jks-path: classpath:/test.jks
# 代理服务端IP
server-ip: localhost
# 代理服务端IP, 若是非ssl端口,则ssl-enable需要配置为false
server-port: 9002
# 是否启用ssl
ssl-enable: true
# licenseKey,客户端凭证。此处需要配置刚刚从管理后台复制的LicenseKey
license-key: xxxx
```
- 执行命令`java -jar neutrino-proxy-client.jar config=app.yml`启动客户端
- 查看服务端License管理,刷新页面,对应的License在线状态为`在线`,则表明客户端已正常连接。
## 4、代理验证
- 本地启动被代理服务,如:redis、本地web项目、本地mysql等等
- 先确保本地能正常访问被代理服务,如果本地都不能访问,不用想代理更不可能!!!
- 通过服务端IP+9101(上面License配置的端口映射重的服务端端口)访问本地被代理服务
访问成功,至此首次完整的内网穿透体验完成。开源不易,请速至[Gitee仓库](https://gitee.com/dromara/neutrino-proxy)一键三连🤝
## 5、客户端Docker部署
> 因为一些原因,官方不推荐客户端使用Docker方式部署,但有不少朋友希望采用这种方式,因此从1.9.0版本开始维护了客户端镜像,版本号同服务端,也可使用`latest`直接安装最新版。
- 客户端镜像地址:registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy-client:latest
- 注意:客户端采用docker部署时,服务端端口映射客户端ip请不要配置127.0.0.1应该配置为容器访问宿主机的ip或者hostname,具体请自行百度
<!--
## 4.开发&调试
::: tip
1. 不建议在原默认vuepress项目上单独安装使用本主题包,而是clone我的整个项目再替换你自己的内容即可。
2. 修改`config.js`配置后需要重新启动项目才会生效。
3. 更多关于项目上手的问题,请查阅 [问答](/pages/9cc27d/)。
:::
## 版本升级
主题的版本会不定期更新,你只需更新npm主题包即可:
```sh
npm update vuepress-theme-vdoing
```
::: tip
1. 如更新后没起作用或报错,尝试把`node_modules`文件夹删除再`npm i`重新安装。
2. 在.vuepress/config.js中,设置`theme: 'vdoing'`才是使用npm主题依赖包:
```js
// config.js
module.exports = {
theme: 'vdoing', // npm主题依赖包
// theme: require.resolve('../../vdoing'), // 使用本地主题包
}
```
:::
-->
@@ -0,0 +1,58 @@
---
title: 常见问题汇总
date: 2023-07-01 13:35:00
permalink: /pages/a00001/
---
## 1. 客户端启动后连不上服务端,一直在重连
### 1.1. 启动日志包含`not found license-key config`相关字样
出现这种情况,说明客户端没获取到配置的license,可按如下检查:
- 客户端是否有配置app.yml,app.yml中是否有配置`license-key`
- 客户端启动参数是否指定app.yml配置,若未指定客户端不会加载任何jar外部的配置文件
- 客户端启动参数指定的配置文件路径是否正确?如:`java -jar neutrino-proxy-client.jar config=app.yml`,代表`app.yml`文件与jar在同级别目录下,如果不在同级别目录,请使用绝对/相对路径指定
- 除此之外license还可以用以下方法直接在启动参数中指定:
- `java -jar -DLICENSE_KEY=xxxx -DSERVER_IP=x.x.x.x -DSERVER_PORT=9000 -DSSL_ENABLE=false neutrino-proxy-client.jar`
- `java -jar neutrino-proxy-client.jar serverIp=x.x.x.x serverPort=9000 sslEnable=false licenseKey=xxxx`
### 1.2. 配置文件确定都已经配置,且启动参数正确指定了,但是没有出现`认证成功日志`
- 确认客户端配置的`server-ip`,必须是服务端所在机器的ip,且保证客户端所在机器能正常ping通
- 确认客户端配置的`server-port``ssl-enable`,默认情况应配置为9000、false或9002、true,除非服务端app.yml有改动隧道对外端口
- 确认服务端对外的9000、9002端口是否已经放开
- 服务端如果采用docker部署,需要确保容器的9000、9002端口映射到宿主机
## 2. 关于中微子代理涉及的2类SSL证书
### 2.1. HTTPS证书
该证书用于服务端支持HTTPS,若需要在服务端`app.yml`中配置即可
### 2.2. 隧道SSL证书
该证书用于对客户端-服务端之间的数据通信进行加密,因此客户端/服务端均需要配置该证书。可参考如下命令生成:
```
keytool -genkey -alias test1 -keyalg RSA -keysize 1024 -validity 3650 -keypass 123456 -storepass 123456 -keystore "./test.jks"
```
## 3. 1.9.0 版本udp代理无效
### 问题描述
代理本地udp端口9231,公网访问代理端口无效,代理端口测试发送成功,但是本地服务没有收到,使用路由器的ddns功能也可以成功代理。
### 解决方案
+ 防火墙开放端口的时候一定要指定udp协议
+ 还有如果想收到回复需要配置两个响应参数
+ 响应数量根据实际响应数量配置,可以配置的大一些,但是不能比实际小
+ 超时时间根据实际响应时间配置,比如正常响应时间是10s,这里就可以配置15000毫秒等
<img :src="$withBase('/img/run-example/question_3_1.png')"></img>
+ 相关链接:[1.9.0版本udp代理无效 · Issue #I83XOI · dromara/neutrino-proxy - Gitee.com](https://gitee.com/dromara/neutrino-proxy/issues/I83XOI)
+ 贡献者:gitee:眉黛如画
## 4. Vue项目出现Invalid Host header 的解决方案
### 问题描述
内网穿透 Vue项目出现Invalid Host header 的解决方案
### 解决方案
manifest.json中配置
```
"h5":{
"devServer":{
"disableHostCheck":true
}
},
```
+ 相关链接:[内网穿透 Vue项目出现Invalid Host header 的解决方案](https://blog.csdn.net/weixin_41549915/article/details/96132925)
+ 贡献者:wx:明天会更好
@@ -0,0 +1,39 @@
---
title: 项目结构
date: 2020-05-11 13:54:56
permalink: /pages/2f674a
article: false
---
# 主要目录、文件
```
├── data.db (为配置mysql时,项目启动默认初始化生成的本地sqlite数据库文件)
├── docs (项目相关的一些文档)
├── neutrino-proxy-admin (管理后台前端项目,基于vue-element-admin)
├── neutrino-proxy-client (基于netty的代理客户端,用于和服务端交互、转发内网数据)
├── neutrino-proxy-core (代理相关的公共代码(协议、常量))
├── neutrino-proxy-server (基于netty的代理服务端,用于和客户段交互,将客户端转发的内网数据转发至外网端口)
└── todolist.MD (近期的开发计划)
```
# 代理服务端 `neutrino-proxy-server`
- base:基础的配置、初始化代码
- constant:服务端常量、枚举定义
- dal:持久层mapper、实体
- job:定时任务执行入口
- proxy:代理核心实现
- service:基础业务
- util:基础工具封装
- resource/mappermybatis SQL文件
- resource/sql:维护mysql/sqlite的初始化SQL、SQL变更记录
- resource/app.yml:项目默认配置
- resource/test.jks:默认的SSL证书
# 代理客户端 `neutrino-proxy-client`
- config:基础配置
- core:客户端代理核心入口
- handler:客户端代理数据处理逻辑
- util:基础工具封装
- resource/app.yml:项目默认配置
- resource/test.jks:默认的SSL证书
@@ -0,0 +1,15 @@
---
title: 演示环境
date: 2020-05-12 15:10:15
permalink: /pages/db78e2
article: false
---
### 演示环境
> 由于部分用户使用演示环境代理非法网站导致演示环境服务器被封禁,因此不再提供演示服务。
可使用分配好的游客license试用。服务器带宽较低,仅供学习使用!
管理后台地址:<a href="http://103.163.47.16:9527" target="_blank">http://103.163.47.16:9527</a>
游客账号:visitor/123456
@@ -1,20 +0,0 @@
---
title: 客户端连接服务端失败
date: 2023-10-25 17:55:20
permalink: /pages/31d253/
---
## 1.1. 启动日志包含`not found license-key config`相关字样
出现这种情况,说明客户端没获取到配置的license,可按如下检查:
- 客户端是否有配置app.yml,app.yml中是否有配置`license-key`
- 客户端启动参数是否指定app.yml配置,若未指定客户端不会加载任何jar外部的配置文件
- 客户端启动参数指定的配置文件路径是否正确?如:`java -jar neutrino-proxy-client.jar config=app.yml`,代表`app.yml`文件与jar在同级别目录下,如果不在同级别目录,请使用绝对/相对路径指定
- 除此之外license还可以用以下方法直接在启动参数中指定:
- `java -jar -DLICENSE_KEY=xxxx -DSERVER_IP=x.x.x.x -DSERVER_PORT=9000 -DSSL_ENABLE=false neutrino-proxy-client.jar`
- `java -jar neutrino-proxy-client.jar serverIp=x.x.x.x serverPort=9000 sslEnable=false licenseKey=xxxx`
## 1.2. 配置文件确定都已经配置,且启动参数正确指定了,但是没有出现`认证成功日志`
- 确认客户端配置的`server-ip`,必须是服务端所在机器的ip,且保证客户端所在机器能正常ping通
- 确认客户端配置的`server-port``ssl-enable`,默认情况应配置为9000、false或9002、true,除非服务端app.yml有改动隧道对外端口
- 确认服务端对外的9000、9002端口是否已经放开
- 服务端如果采用docker部署,需要确保容器的9000、9002端口映射到宿主机
@@ -1,14 +0,0 @@
---
title: 易混淆的2类证书
date: 2023-10-25 17:56:59
permalink: /pages/e4c3d7/
---
## 2.1. HTTPS证书
该证书用于服务端支持HTTPS,若需要在服务端`app.yml`中配置即可
## 2.2. 隧道SSL证书
该证书用于对客户端-服务端之间的数据通信进行加密,因此客户端/服务端均需要配置该证书。可参考如下命令生成:
```
keytool -genkey -alias test1 -keyalg RSA -keysize 1024 -validity 3650 -keypass 123456 -storepass 123456 -keystore "./test.jks"
```
@@ -1,16 +0,0 @@
---
title: udp代理无效
date: 2023-10-25 17:58:35
permalink: /pages/7b990f/
---
## 问题描述
代理本地udp端口9231,公网访问代理端口无效,代理端口测试发送成功,但是本地服务没有收到,使用路由器的ddns功能也可以成功代理。
## 解决方案
+ 防火墙开放端口的时候一定要指定udp协议
+ 还有如果想收到回复需要配置两个响应参数
+ 响应数量根据实际响应数量配置,可以配置的大一些,但是不能比实际小
+ 超时时间根据实际响应时间配置,比如正常响应时间是10s,这里就可以配置15000毫秒等
<img :src="$withBase('/img/run-example/question_3_1.png')"></img>
+ 相关链接:[1.9.0版本udp代理无效 · Issue #I83XOI · dromara/neutrino-proxy - Gitee.com](https://gitee.com/dromara/neutrino-proxy/issues/I83XOI)
+ 贡献者:gitee:眉黛如画
@@ -1,19 +0,0 @@
---
title: Vue项目出现Invalid Host header 的解决方案
date: 2023-10-25 17:59:29
permalink: /pages/441163/
---
## 问题描述
内网穿透 Vue项目出现Invalid Host header 的解决方案
## 解决方案
manifest.json中配置
```
"h5":{
"devServer":{
"disableHostCheck":true
}
},
```
+ 相关链接:[内网穿透 Vue项目出现Invalid Host header 的解决方案](https://blog.csdn.net/weixin_41549915/article/details/96132925)
+ 贡献者:wx:明天会更好
@@ -1,39 +0,0 @@
---
title: 个人赞赏
date: 2023-10-26 13:08:02
permalink: /pages/1ab20b/
---
## 个人赞赏说明
随着用户增加,需要协助解决的问题也多种多样,为了能给用户提供 `更优质``更准确` 的 疑难问题 解答我们推出赞赏咨询服务
| 赞赏金额 | 服务时长 | 服务说明 |
|:-----|:-----|:----------------------|
| 任意金额 | - | 您将获得赞助者列表的永久留名。 |
| 30 | 一个月 | 您在群内反馈的问题将优先得到作者响应 |
| 80 | 三个月 | 获得微信一对一的咨询服务 |
| 180 | 三个月 | 获得官网首页特别赞助席位一个,一次远程协助 |
| 更多金额 |-| 您将获得私人定制服务 |
> 注意1:服务项目是逐级叠加:如,您赞赏的金额是 80 员那么您将享受:任意金额、一个月、三个月的服务内容
> 注意2:二开问题不在个人赞赏支持服务范畴内,如需咨询二开问题或者二开方案请找作者协商
## 赞赏途径
> 除4以外,赞赏后请及时通过官网首页微信二维码与作者取得联系
- 1、微信赞赏
- 2、支付宝转账
- 3、Gitee项目捐赠:[点击这里](https://gitee.com/dromara/neutrino-proxy)打开后拉到最底部点击捐赠
- 4、微信好友转账
<table>
<tr>
<td align="center">微信赞赏</td><td align="center">支付宝转账</td>
</tr>
<tr>
<td><img width="300px" src="./a1.png"></td><td><img width="300px" src="./a2.png"></td>
</tr>
<tr>
</tr>
</table>
@@ -1,28 +0,0 @@
---
title: 项目结构
date: 2020-05-11 13:54:56
permalink: /pages/2f674a
article: false
---
# 主要目录、文件
```
├── assets (资源文件)
├── docs (项目相关的一些文档)
├── neutrino-proxy-admin (管理后台前端项目,基于vue-element-admin)
├── neutrino-proxy-client (基于netty的代理客户端,用于和服务端交互、转发内网数据)
├── neutrino-proxy-core (代理相关的公共代码(协议、常量))
├── neutrino-proxy-server (基于netty的代理服务端,用于和客户段交互,将客户端转发的内网数据转发至外网端口)
├── neutrino-proxy-vuepress (中微子代理官网文档)
├── scripts (常用的编译、打包脚本)
├── Milestone.md (里程碑事件节点)
├── VLog.md (版本变更记录)
└── todolist.MD (近期的开发计划)
```
# 代码分支说明
- dev:常规开发分支,日常的开发、Bug修复、提交PR都在此分支
- feature/xxx:特征分支,一些试验性开发、提交PR都在此分支,xxx可自行取一个有意义的名称
- release/xxx:发行版分支,作为阶段性成果、重大更新的版本固化分支。受保护,不允许任何提交。
- master:主分支,定期同步最新代码,目前仅支持本人(傲世孤尘/雨韵诗泽)提交。
Binary file not shown.

Before

Width:  |  Height:  |  Size: 418 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 296 KiB

@@ -1,15 +0,0 @@
---
title: 2.x
date: 2023-10-26 17:43:43
permalink: /pages/ff3519/
---
## 2.0.0
- solon版本升级为`2.5.11`
- jdk版本升级为17
- 支持原生编译改造
- 默认支持的数据库由sqlite改为h2
- 升级须知:
- jdk版本升级为了jdk17,jar部署时请注意
- 去掉了默认的sqlite数据库,改为了h2。如果之前使用sqlite,请自行处理数据迁移
- 配置文件做了较大调整,请参照官网使用须知中的`服务端配置``客户端配置`进行更新
@@ -1,72 +0,0 @@
---
title: 1.x
date: 2023-10-26 17:43:34
permalink: /pages/dda8e5/
---
## 1.9.0
- 端口映射支持UDP协议
- 端口映射HTTP(S)新增打开网页按钮,优先使用域名打开
- 新增/编辑端口映射时端口占用检测功能屏蔽,解决docker下使用的各种问题
## 1.8.6
- 端口映射选择端口支持分页
- 新增/更新端口映射,增加端口占用检测(端口映射编辑时,如果端口号没有变动,则不验证。避免出现端口映射正在使用时,无法更新端口映射其他信息的问题)
- 下拉搜索license,支持模糊搜索
- license下拉用户搜索,支持模糊搜索
- 端口映射HTTP(S)新增打开网页按钮
- 客户端断开连接时,记录日志空指针异常问题修复
## 1.8.5
- 后台端口池管理支持批量删除
- 端口映射下拉选择端口支持搜索
- 客户端/服务端配置增加心跳日志开关,有需要时开启,方便排查问题
- 客户端/服务端读写超时逻辑微调
## 1.8.4
- 增加对mariadb的支持
- 服务端/客户端,支持配置文件、启动参数指定日志级别
- 客户端支持配置文件指定重连间隔,是否开启无限重连
## 1.8.3
- 客户端重连优化
- 服务端验证客户端身份逻辑优化
## 1.8.2
- 增加HTTPS的支持。
## 1.8.0
- 端口映射支持选择协议
- HTTP协议下映射支持配置子域名(前提是server端配置了域名)
## 1.7.1
- 针对管理后台各页面的排序、搜索条件的优化
- 增加端口池分组、相关的端口映射优化
- 增加了报表管理模块:用户流量报表、license流量报表、用户流量月度明细、license流量月度明细
- 完成首页图表展示:license统计、端口映射统计、今日流量统计、汇总流量统计、最近15日流量折线图
## 1.7.0
- 底层框架更换为Solon + MybatisPlus
## 1.6.4
- 支持代理服务端用户(删除/禁用)、端口池(删除/禁用/启用)、License(删除/禁用/启用)、端口映射(新增/删除/禁用/启用)实时生效
- 启动参数优化
- 服务端静态资源服务支持缓存、gzip压缩,提升响应速度
## 1.6.0
- 新增日志管理模块,调度日志迁移至日志管理
- 管理后台新增登录日志
- 新增首页流量统计
## 1.5.0
- 管理后台新增用户管理、License管理、端口映射、调度管理、客户端连接日志、调度日志
- 支持默认sqlite数据库
- 底层框架Aop、Banner、SqlMapper、Ioc、@Value注解、Yml配置加载、静态资源服务等优化
- 底层框架新增@Async@Singleton等注解
- 新增AsgcCompiler、ApplicationEvent机制封装
## 1.0.0
> 第一个基本可用版本
- 基于自研底层应用框架、Netty
- 纯配置实现、无管理后台
- 支持TCP代理
@@ -1,24 +0,0 @@
---
title: 里程碑
date: 2023-10-26 17:41:26
permalink: /pages/e406dd/
---
- 2023-10-31 2.0.0版本发布,升级jdk版本至jdk17、支持原生编译、去掉sqlite改为默认H2数据库
- 2023-09-25 中微子代理Gitee Star数突破1000
- 2023-09-22 1.9.0版本发布,端口映射支持UDP协议
- 2023-09-07 1.8.6版本发布,后台若干细节优化
- 2023-07-04 1.8.5版本发布,后台若干细节优化、配置文件优化
- 2023-06-08 1.8.4版本发布,增加对mariadb的支持、配置文件支持指定日志级别、重连参数
- 2023-06-03 1.8.3版本发布,客户端重连优化、服务端验证客户端身份逻辑优化
- 2023-05-27 1.8.2版本发布,增加HTTPS支持
- 2023-04-03 1.8.0版本发布,端口映射支持选择协议,HTTP映射支持子域名
- 2023-03-26 1.7.1版本发布,新增端口池分组、新增报表管理模块、首页图表优化
- 2023-03-12 1.7.0版本发布,底层框架更换为Solon + MybatisPlus
- 2023-02-23 1.6.4版本发布,管理后台增、删、改、禁用实时生效,启动参数、GZip优化
- 2023-01-16 加入Dromara组织
- 2023-01-08 中微子代理Gitee Star突破100
- 2022-11-23 1.6.0版本发布,新增日志管理模块,新增首页流量统计
- 2022-10-12 1.5.0版本发布,底层框架优化,新增管理后台
- 2022-06-16 1.0.0版本发布,基于自研应用框架、纯配置无管理后台
@@ -0,0 +1,39 @@
---
title: 最近更新
date: 2020-05-25 12:01:52
permalink: /pages/9cc27d
# sidebar: false
article: false
---
# TODO
### 1.x剩余规划
- [ ] 参考鹊桥,增加对域名的支持
- [ ] 官网上线
#### Bug
- windows环境下直接运行发布版的jar包,日志输出乱码
- 代理mysql时,使用未开启远程访问的账号走代理访问mysql,代理客户端出现断开现象
### 2.x规划
- 插件开发
- [ ] neutrino-proxy-solon-plugin
- [ ] neutrino-proxy-jetbrains-plugin
- [ ] neutrino-proxy-starter (SpringBoot)
- 基础优化
- [ ] 支持批量端口映射
- [ ] 代理协议规范化,方便后续更好扩展、支持不同语言客户端接入
- 监控运维
- [ ] 监控服务端状态
- [ ] 支持调整服务端端口、证书
- [ ] 服务端版本、协议版本、客户端版本管理
- [ ] 服务端日志
- client+计划启动
- [ ] 安卓客户端
- [ ] 基于electron-egg的多平台客户端
### 3.x规划
- [ ] 支持针对用户限速、限流
- [ ] 支持P2P穿透
- [ ] 支持原生编译
@@ -0,0 +1,45 @@
---
title: 如何贡献
date: 2023-03-29 12:55:44
permalink: /pages/69a632/
---
# 🎋代码分支说明
- dev:常规开发分支,日常的开发、Bug修复、提交PR都在此分支
- feature/xxx:特征分支,一些试验性开发、提交PR都在此分支,xxx可自行取一个有意义的名称
- release/xxx:发行版分支,作为阶段性成果、重大更新的版本固化分支。受保护,不允许任何提交。
- master:主分支,定期同步最新代码,目前仅支持本人(傲世孤尘/雨韵诗泽)提交。
# ✊贡献的方式
包括,但不限于以下形式:
- 提交[issues](https://gitee.com/dromara/neutrino-proxy/issues)
- 参与[issues](https://gitee.com/dromara/neutrino-proxy/issues)解决的必要性、解决方案的讨论、给出建设性的意见
- 领取[issues](https://gitee.com/dromara/neutrino-proxy/issues) 并完成开发、提交PR
- 为[本项目](https://gitee.com/dromara/neutrino-proxy)完善代码注释
- 为[本项目](https://gitee.com/dromara/neutrino-proxy)增加测试代码
- 为[本项目](https://gitee.com/dromara/neutrino-proxy)优化现有代码
- 为[本项目](https://gitee.com/dromara/neutrino-proxy)优化操作体验
- 通过公众号、博客、贴吧、论坛等形式分享/宣传中微子代理
- 丰富项目文档,包括使用过程中踩过的坑、需要优化的点、具体问题的解决方法等
# 🧬贡献代码的步骤
- 在Gitee或者Github上fork项目到自己的repofork,一定要把项目fork一份。
- 把fork过去的项目也就是你的项目clone到你的本地
- 同步feature/1.7.1最新代码
- 修改代码
- 开发完成后,不忙着提PR,再拉一遍最新代码,如果有冲突、解决冲突
- commit后push到自己的库
- 登录Gitee在你首页可以看到一个 pull request 按钮,点击它,填写一些说明信息,然后提交即可。
- 等待维护者合并
# 📐PR的规范
> 你可能发现有的代码并不符合这个规范,但我们后续都会朝着这个方向迈进。后续我们会逐步全面规范化,请先保证新提交的代码满足以下要求:
- 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
- 原则上,不允许自行添加第三方依赖库。若确有必要,请先和项目负责人沟通达成一致。
- 对现有代码的优化,请在注释中说明原因。
- 如果涉及到数据库的变更,则至少需要做到以下绩点:
- sqlite、mysql下均测试通过
-`./neutrino-proxy-server/src/main/resource/sql`下维护更新对应的表结构sql文件
- 对于新增的表,维护必要的初始化数据
- 在对应的mysql、sqlite的update目录下,维护SQL变更记录,确保SQL执行测试通过
+6 -6
View File
@@ -20,13 +20,13 @@ features: # 可选的
- title: 端口映射
details: 新增、编辑、删除、禁用实时生效。
- title: Docker
details: 服务端/客户端支持Docker一键部署。
details: 服务端支持Docker一键部署。
- title: 隧道SSL加密
details: 隧道通信支持SSL,保护您的数据安全
- title: 多种协议
details: 支持TCP、HTTP、HTTPS、UDP
- title: 原生部署
details: 支持原生部署,更简单、性能更好的使用体验
- title: HTTPS
details: 支持HTTPS
- title: 多客户端支持
details: 暂未支持
# 文章列表显示方式: detailed 默认,显示详细版文章列表(包括作者、分类、标签、摘要、分页等)| simple => 显示简约版文章列表(仅标题和日期)| none 不显示文章列表
postList: none
@@ -137,7 +137,7 @@ postList: none
或者加入我们的交流群:
<div align="center">
<img :src="$withBase('/img/qrcode/wxq.png')" class="no-zoom" style="width:200px;margin: 10px;">
<p>中微子 微信群(添加我微信备注"中微子进群")</p>
<p>中微子 微信群(添加我微信备注"进群")</p>
</div>
<br/>