dev: 文档

docs/分支.md

+# 切换分支
+切换分支页面，可以切换 `v1` 和 `v2` 系统的分支
+
+![切换分支](./images/分支.png)
+
+**刷新**  
+点击刷新按钮，可以更新该目录内 `git` 的分支，点击下拉框后也会发现新的分支列表
+
+**切换分支**  
+点击切换分支，会将对应系统目录内的 `git` 分支切换为下拉框内的目标分支
+
+## 备注
+不要在编译系统的时候切换分支！  
+不要在编译系统的时候切换分支！  
+不要在编译系统的时候切换分支！  
+
+因为编译系统时，执行了后端程序，可能会引起文件上锁等情况，切换分支时可能会造成不明问题。
+
+但是可以在运行系统时切换分支，因为运行系统利用的是打包后的 `java` 文件，这些文件是被 `git` 忽略的
\ No newline at end of file

docs/安装.md

+# 安装
+在 `node v20` 及以上版本中，安装依赖库
+
+> npm install
+
+## 编译
+编译该项目
+
+> npm run build
+
+编译结束后会产生 `.output` 目录，将 `.output` 目录内的内容，压缩到 `.output.tar` 压缩文件内
+
+通过 `ssh` 工具，比如 `MobaXterm`，连接 `192.168.0.4` 服务器
+
+## 前置准备
+
+### 安装 Postgres 容器
+通过 `Docker` 安装 `Postgres` 容器，并设置初始用户名密码为 `postgres` ，初始数据库为 `postgres`
+
+> docker run postgres:12 /bin/bash -p 25556:5432
+
+### 安装 Redis
+通过 `Docker` 安装
+
+> docker run redis:5 /bin/bash -p 25557:6379
+
+### 安装 Zookeeper
+
+`192.168.0.4` 服务器已安装
+
+## 服务器
+通过 `Docker` 创建一个服务容器
+
+> docker run -it node:16 /bin/bash -p 30000:8080
+
+将压缩文件上传到 `192.168.0.4` 服务器内，再通过命令导入到容器内
+
+> docker cp /var/.output.tar [容器ID]:/var/.output.tar
+
+通过命令进入容器内
+
+> docker exec -it [容器ID] bash
+
+在目录内创建文件夹并解压缩
+
+> cd /var  
+> mkdir nuxt-backend-helper  
+> mv .output.tar ./nuxt-backend-helper  
+> cd nuxt-backend-helper  
+> tar -xvf .output.tar
+
+执行命令启动服务
+
+> NUXT_PG_HOST=192.168.0.4 NUXT_PG_PORT=25556 NUXT_PG_USER=postgres NUXT_PG_PASSWORD=postgres NUXT_PG_DATABASE=postgres NUXT_PUBLIC_DOCKER_HOST=192.168.0.4 PORT=8080 node ./server/index.mjs
+
+命令具有以下参数：
+
+* **`NUXT_PG_HOST`**: PG 数据库宿主机 ip  
+* **`NUXT_PG_PORT`**: PG 数据库宿主机端口  
+* **`NUXT_PG_USER`**: PG 数据库用户名  
+* **`NUXT_PG_PASSWORD`**: PG 数据库密码  
+* **`NUXT_PG_DATABASE`**: PG 数据库表名  
+* **`NUXT_PUBLIC_DOCKER_HOST`**: 容器宿主机 IP  
+* **`PORT`**: 服务端口
\ No newline at end of file

docs/登录.md

+# 登录
+输入 `http://192.168.0.4:30000` 进入登录页，在登录页中输入前端开发者的用户名，点击 `登录` 后进入[首页](./首页.md)
+
+> 输入未记录的用户名会自动创建一个新的 Docker 容器，存储该用户相关的文件
+
+![登录页](./images/登录页.png)
\ No newline at end of file

docs/配置.md

+# 修改配置
+修改配置页面，可以让开发者设置自定义配置，保存后会导入到后端运行的 `properties` 配置文件内。
+
+![修改配置](./images/修改配置.png)
+
+> `租户` 和 `调试` 配置仅 `logwire-v2` 系统独有
+
+## 租户配置
+租户配置里，提供了 **租户ID**，**租户HOST**，**租户数据库Schema**，**租户主要Schema**。
+
+**租户ID**  
+填写用户名相同的值
+
+**租户HOST**  
+填写一系列 `ip:port` 地址，以英文都好分割，只有这些地址才可以访问后端服务
+
+**租户数据库Schema**  
+固定填写 `library`  
+
+**租户主要Schema**  
+不需填写
+
+## 调试配置
+参与远程调试的后端开发者的 `ip`
+
+## 其他配置
+通过新增自定义配置，配置会同步到配置文件内
\ No newline at end of file

docs/首页.md

+# 首页
+
+## 首次登录用户
+首次登录用户，进入首页后如图
+
+![首次登录页](./images/首页.png)
+
+此时 `logwire-v1` 和 `logwire-v2` 系统都还未初始化，点击 `logwire-v2` 旁的初始化按钮
+
+> 因为开发的先后顺序，所以必须先初始化 `logwire-v2` ，再初始化 `logwire-v1`
+
+![初始化](./images/初始化.png)
+
+在初次初始化时，**肯定**会失败，这是因为 `gitlab` 的用户没有和容器内的 `git` 环境关联，现在需要将提示中的**加粗字体**，放入到 `gitlab ssh` 设置中，并重新点击初始化，耗时较久
+
+![ssh密钥](./images/ssh密钥.png)
+
+全部初始化后，右侧按钮会变为 `编译` 和 `运行`
+
+> `运行` 按钮需要在执行一次编译后才会显示
+
+![初始化结束](./images/初始化结束.png)
+
+## logwire-v2 操作
+除了常规的 `编译` `运行` 按钮，对于 `logwire-v2` 系统还具有以下操作：
+
+* `切换分支`：跳转到[切换分支](./分支.md)页面
+* `修改配置`：跳转到[修改配置](./配置.md)页面
+* `打开 Vscode`: 打开容器内 `logwire-v2` 的目录页
+* `调试`：执行调试程序。
+* `打包微信压缩文件`：为了方便设计器打包小程序文件后，快速的下载打包文件
+
+### 编译
+点击 `编译` 按钮后，会打包后端程序。首次点击时耗费时间久，是为了下载后端打包所需要的文件。
+
+### 运行
+点击 `运行` 按钮后，等待一段时间，出现提示后，设置对应的配置即可启动服务
+
+
+![运行](./images/运行.png)
+
+此时提示内容如下
+
+> TIP: 请代理后端请求到 192.168.0.4:30001, 开发环境域名和端口号为 192.168.0.190:23335,192.168.0.190:23336,a.test.com:23335,a.test.com:23336,a.test.com:29000
+
+需要前端开发者将 `vue.config.js` 配置文件中，关于 `devServer` 的接口代理到 `http://192.168.0.4:30001` 地址上。并且只有 `192.168.0.190:23335,192.168.0.190:23336,a.test.com:23335,a.test.com:23336,a.test.com:29000` 这些 `host` 地址可以访问该后端程序，这是 `logwire` 的后端框架决定的。
+
+### 调试  
+调试需要在 [配置](./配置.md) 页面，输入后端开发者的 ip 地址。在编译 `logwire-v2` 系统后，点击调试按钮。会将后端的 `IDEA` 的远程调试工具连接到容器内的 `java` 程序。
+
+> 如果系统正在运行，必须先停止！
+
+## logwire-v1 操作
+除了常规的 `编译` `运行` 按钮，对于 `logwire-v1` 系统还具有以下操作：
+
+* `切换分支`：跳转到切换分支页面
+* `修改配置`：跳转到修改配置页面
+* `打开 Vscode`: 打开容器内 `logwire-v1` 的目录页