From ef8d1b00360d1e1ef61acf4c7c514594d4762728 Mon Sep 17 00:00:00 2001 From: aoshiguchen <1052045476@qq.com> Date: Tue, 28 Mar 2023 23:25:00 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E5=BF=AB=E9=80=9F=E4=BD=BF?= =?UTF-8?q?=E7=94=A8=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/快速使用.MD | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 docs/快速使用.MD diff --git a/docs/快速使用.MD b/docs/快速使用.MD new file mode 100644 index 00000000..9964c02c --- /dev/null +++ b/docs/快速使用.MD @@ -0,0 +1,79 @@ +# 1、部署服务端 +## 1.1、Docker一键安装 +### 使用默认sqlite数据库 +```shell +docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 \ +-d --restart=always --name neutrino \ +registry.cn-hangzhou.aliyuncs.com/asgc/aoshiguchen-docker-images:1.7 +``` + +### 指定自己的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: wHCvf3@hmw^D* +``` +- 然后执行如下命令： +```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/aoshiguchen-docker-images:1.7 +``` + +## 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 -jar neutrino-proxy-server.jar`启动服务端完成部署，默认使用sqlite数据库。 +- 若需要指定自己的mysql数据库，同样的需要在当前目录下新建`app.yml`文件，文件内容同上。执行命令`java -jar neutrino-proxy-server.jar config=app.yml`启动服务端完成部署 +- 可参照 https://gitee.com/dromara/neutrino-proxy/blob/master/bin/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: + client: + # 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`启动客户端 +- 查看服务端License管理，刷新页面，对应的License在线状态为`在线`，则表明客户端已正常连接。 + +# 4、代理验证 +- 本地启动被代理服务，如：redis、本地web项目、本地mysql等等 +- 先确保本地能正常访问被代理服务，如果本地都不能访问，不用想代理更不可能！！！ +- 通过服务端IP+9101（上面License配置的端口映射重的服务端端口）访问本地被代理服务 + +访问成功，至此首次完整的内网穿透体验完成。开源不易，请速至[Gitee仓库](https://gitee.com/dromara/neutrino-proxy)一键三连🤝 \ No newline at end of file