官网文档结构调整.

2023-10-25 18:20:43 +08:00
parent 066b63d38a
commit 8b564cb2f5
18 changed files with 44 additions and 40 deletions
@@ -5,7 +5,7 @@
    - [x] 启动参数
    - [x] 外部配置文件
    - [x] 环境变量
- [ ] 日志
+- [x] 日志
    - [x] 控制台输出
    - [x] debug启动有netty错误日志
    - [x] 文件输出
@@ -0,0 +1,5 @@
+---
+title: jar部署
+date: 2023-10-25 18:12:08
+permalink: /pages/df2741/
+---
@@ -0,0 +1,5 @@
+---
+title: docker部署
+date: 2023-10-25 18:12:19
+permalink: /pages/66e72c/
+---
@@ -0,0 +1,5 @@
+---
+title: 原生部署
+date: 2023-10-25 18:12:31
+permalink: /pages/db7097/
+---
@@ -1,39 +0,0 @@
---
-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/mapper：mybatis 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,28 @@
+---
+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：主分支，定期同步最新代码，目前仅支持本人(傲世孤尘/雨韵诗泽)提交。