diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/01.快速上手.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/01.快速上手.md index 013b73af..705e67c5 100644 --- a/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/01.快速上手.md +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/01.快速上手.md @@ -5,119 +5,36 @@ permalink: /pages/793dcb article: false --- -## 1、 部署服务端 -### 1.1、 Docker一键部署 -> 当前最新版本为1.9.0，下面的脚本中，可以使用：`registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy:1.9.0` 指定版本安装，推荐使用`latest`直接安装最新版。 +::: tip +当前最新版本为2.0.0，如果从之前的版本升级而来，请注意以下变更 -#### 使用默认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 -``` +1、jdk版本升级为了jdk17，jar部署时请注意 -#### 指定自己的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 -``` +2、去掉了默认的sqlite数据库，改为了h2。如果之前使用sqlite，请自行处理数据迁移 -### 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脚本启动服务端。 +3、配置文件做了较大调整，请参照使用须知中的`服务端配置`、`客户端配置`进行更新 +::: -## 2、管理后台配置 -- 服务端部署成功后，访问`http://{服务端IP}:8888`打开后台管理页面。 -- 使用默认的管理员帐号登录：admin/123456 -- 打开`代理配置>License管理`页面，可以看到系统已经自动为管理员初始化了一条License记录，复制该`LicenseKey`备用，后续客户端配置需要。 -- 打开`代理配置>端口映射`页面，可以看到系统已经自动为初始化了几条端口映射。可根据需要自行添加、修改。这里我们以`9101 -> 127.0.0.1:8080`映射为例 +## 1、快速上手须知 +- 所谓快速上手，就是针对从来没用过的新手编写的、快速完成从安装部署到首次使用的最简化流程 +- 该流程中请严格按照说明步骤执行，不要靠猜测自作聪明的修改配置 +- 如果的确需要修改，请先把安装部署、使用须知、常见问题全部仔细读一遍 +- 快速上手中涉及到的配置，仅仅是快速体验所必须的配置，完整的配置请参照使用须知中的`服务端配置`、`客户端配置` -## 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在线状态为`在线`，则表明客户端已正常连接。 +## 2、部署服务 +- 根据需要自行选择jar、docker、原生部署任意一种完成部署 +- 三种方式分别参见对应的文档 +- 任何一种部署方式，不要求客户端与服务端一致。如：服务端采用docker部署，客户端可以用docker部署、也可以用jar、原生部署 +- 管理后台说明 + - 服务端部署成功后，访问http://{服务端IP}:8888打开后台管理页面。使用默认的管理员帐号登录：admin/123456 + - 打开代理配置>License管理页面，可以看到系统已经自动为管理员初始化了一条License记录，复制该LicenseKey备用，后续客户端配置需要。 +- 客户端说明 + - 客户端启动后，查看服务端License管理，刷新页面，对应的License在线状态为`在线`，则表明客户端已正常连接。 -## 4、代理验证 -- 本地启动被代理服务，如：redis、本地web项目、本地mysql等等 +## 3、代理验证 +- 本地启动被代理服务，如：redis、本地web项目、本地mysql等等，假设被代理服务端口为：8080 - 先确保本地能正常访问被代理服务，如果本地都不能访问，不用想代理更不可能！！！ +- 服务端管理后台端口映射管理，使用默认的licesne创建一条端口映射，如：9101 -> 127.0.0.1:8080 - 通过服务端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，具体请自行百度 - - diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/02.使用jar部署.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/02.使用jar部署.md new file mode 100644 index 00000000..3b2d5f1d --- /dev/null +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/02.使用jar部署.md @@ -0,0 +1,54 @@ +--- +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、部署客户端 +- 在本地`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`启动客户端 + diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/03.使用docker容器化部署.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/03.使用docker容器化部署.md new file mode 100644 index 00000000..cdabe0c6 --- /dev/null +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/03.使用docker容器化部署.md @@ -0,0 +1,45 @@ +--- +title: 使用docker容器化部署 +date: 2023-10-26 13:51:29 +permalink: /pages/5b9bef/ +--- + + +## 1、 部署服务端 +> 当前最新版本为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 +``` + +## 2、部署客户端 +> 因为一些原因，官方不推荐客户端使用Docker方式部署，但有不少朋友希望采用这种方式，因此从1.9.0版本开始维护了客户端镜像，版本号同服务端，也可使用`latest`直接安装最新版。 +- 客户端镜像地址：registry.cn-hangzhou.aliyuncs.com/asgc/neutrino-proxy-client:latest +- 注意：客户端采用docker部署时，服务端端口映射客户端ip请不要配置127.0.0.1应该配置为容器访问宿主机的ip或者hostname，具体请自行百度 diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/04.原生部署.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/04.原生部署.md new file mode 100644 index 00000000..d0e77b85 --- /dev/null +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.安装部署/04.原生部署.md @@ -0,0 +1,5 @@ +--- +title: 原生部署 +date: 2023-10-26 13:51:44 +permalink: /pages/69699a/ +---