diff --git a/README.md b/README.md index f00a9a1f..52e49b47 100644 --- a/README.md +++ b/README.md @@ -34,144 +34,19 @@ ![License管理](assets/run-example/license1.png) ![端口映射管理](assets/run-example/port-mapping1.png) -# 4、项目结构 -- neutrino-proxy - - neutrino-proxy-core 与代理相关的公共常量、编解码器 - - neutrino-proxy-client 代理客户端项目 - - neutrino-proxy-server 代理服务端项目 - - neutrino-proxy-admin 代理监控项目（基于vue-element-admin开发） - -# 5、运行 -## 5.1、使用keytool工具生成ssl证书, 若不需要ssl加密可跳过 -```shell -keytool -genkey -alias test1 -keyalg RSA -keysize 1024 -validity 3650 -keypass 123456 -storepass 123456 -keystore "./test.jks" -``` - -## 5.2、修改服务端配置（app.yml） -```yml -application: - name: neutrino-proxy-server - -neutrino: - proxy: - protocol: - max-frame-length: 2097152 - length-field-offset: 0 - length-field-length: 4 - initial-bytes-to-strip: 0 - length-adjustment: 0 - read-idle-time: 60 - write-idle-time: 40 - all-idle-time-seconds: 0 - tunnel: - boss-thread-count: 2 - work-thread-count: 10 - # 服务端端口，用于保持与客户端的连接，非SSL - port: ${OPEN_PORT:9000} - # 服务端端口，用于保持与客户端的连接，SSL,需要jks证书文件，若不需要ssl支持，可不配置 - ssl-port: ${SSL_PORT:9002} - # 证书配置，用于隧道通信SSL加密 - key-store-password: ${STORE_PASS:123456} - key-manager-password: ${MGR_PASS:123456} - jks-path: ${JKS_PATH:classpath:/test.jks} - server: - boss-thread-count: 5 - work-thread-count: 20 - # HTTP代理端口，默认80，也可以用其他端口，走nginx转发 - http-proxy-port: ${HTTP_PROXY_PORT:80} - # HTTPS代理端口，默认443，也可以用其他端口，走nginx转发 - https-proxy-port: ${HTTPS_PROXY_PORT:443} - # 如果不配置，则不支持域名映射 - domain-name: ${DOMAIN_NAME:} - # 证书配置，用于支持HTTPS - key-store-password: ${HTTPS_STORE_PASS:} - jks-path: ${HTTPS_JKS_PATH:} - data: - # 数据库配置（支持mysql） - type: sqlite - url: jdbc:sqlite:data.db - driver-class: org.sqlite.JDBC - username: - password: -``` - -## 5.3、启动服务端 -> java -jar neutrino-proxy-server.jar - -## 5.4、修改客户端配置 -```yml -application: - name: neutrino-proxy-client - -proxy: - protocol: - max-frame-length: 2097152 - length-field-offset: 0 - length-field-length: 4 - initial-bytes-to-strip: 0 - length-adjustment: 0 - read-idle-time: 60 - write-idle-time: 30 - all-idle-time-seconds: 0 - client: - # ssl证书密码 - key-store-password: 123456 - # ssl证书存放位置 - jks-path: classpath:/test.jks - # 服务端ip，若部署到服务器，则配置服务器的ip - server-ip: localhost - # 服务端端口，若使用ssl，则需要配置为服务端的"ssl-port" - server-port: 9000 - # 是否启用ssl，启用则必须配置ssl相关参数 - ssl-enable: false -``` -## 5.5、代理示意图 +# 4、代理示意图 ![代理流程](assets/design/neutrino-proxy-process.jpg) -## 5.6、启动客户端 -### 5.6.1、启动参数直接指定配置 -> java -jar neutrino-proxy-client.jar serverIp=localhost serverPort=9000 licenseKey=b0a907332b474b25897c4dcb31fc7eb6 - -### 5.6.2、启动参数指定外部配置文件 -> java -jar neutrino-proxy-client.jar config=app.properties - -配置文件格式如下： -``` -neutrino.proxy.client.server-ip=localhost -neutrino.proxy.client.server-port=9002 -neutrino.proxy.client.ssl-enable=true -neutrino.proxy.client.key-store-password=123456 -neutrino.proxy.client.jks-path=classpath:/test.jks -neutrino.proxy.client.license-key=b0a907332b474b25897c4dcb31fc7eb6 -``` - -## 5.7、Docker快速启动 -```shell script - # 一键部署前端和后端，客户端按上方部署即可 - docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 -d --name neutrino registry.cn-hangzhou.aliyuncs.com/asgc/aoshiguchen-docker-images:1.64 - # 如没docker环境，可以一键部署docker环境（centos 7.8）系统 - curl http://www.wangke666.cn/static/createDocker.sh | bash -``` - -# 6、演示环境 +# 5、演示环境 > 可使用分配好的游客license试用。服务器带宽较低，仅供学习使用！ - 管理后台地址：http://103.163.47.16:9527 - 游客账号：visitor/123456 -# 7、未来迭代方向 -- 优化代码、增强稳定性 -- 服务端增加管理页面，提供报表、授权、限流等功能 -- 从项目中分离、孵化出另一个开源项目(neutrino-framework) - -# 8、技术文档 -- [Aop](./docs/Aop.MD) -- [Channel](./docs/Channel.MD) - -# 9、联系我们 +# 6、联系我们 - 微信: yuyunshize - Gitee: https://gitee.com/asgc/neutrino-proxy -# 10、贡献者列表 +# 7、贡献者列表

diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/100.常见问题汇总.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/100.常见问题汇总.md new file mode 100644 index 00000000..06062e45 --- /dev/null +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/100.常见问题汇总.md @@ -0,0 +1,32 @@ +--- +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.1、配置文件确定都已经配置，且启动参数正确指定了，但是没有出现`认证成功日志` +- 确认客户端配置的`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" +```