📝 修改文档.

This commit is contained in:
lijiahang
2024-05-27 10:26:55 +08:00
parent f54acf595b
commit 48a53bc248
24 changed files with 88 additions and 88 deletions

View File

@@ -11,9 +11,7 @@
⚡ npm 建议使用淘宝镜像 `npm config set registry https://registry.npmmirror.com/`
⚡ pnpm 建议使用淘宝镜像 `pnpm config set registry https://registry.npmmirror.com/`
### 配置
1. 拉取代码
### 拉取代码
```
# github
@@ -22,7 +20,7 @@ git clone https://github.com/lijiahangmax/orion-visor
git clone https://gitee.com/lijiahangmax/orion-visor
```
2. 初始化数据库
### 初始化数据库
```
# 执行脚本
@@ -32,7 +30,7 @@ orion-visor/sql/init-3-schema-quartz.sql
orion-visor/sql/init-4-data.sql
```
3. 修改后端配置
### 修改后端配置
```
# 修改配置文件 (mysql, redis, secret-key)
@@ -46,9 +44,9 @@ mvn -U clean install -DskipTests
com.orion.visor.launch.LaunchApplication
```
4. 修改前端配置
### 修改前端配置
```
```shell
# 进入代码目录
cd orion-visor/orion-visor-ui
# 下载 pnpm

View File

@@ -19,7 +19,7 @@ Dashboard 修改)
### 拉取代码
```
```shell
# github
git clone https://github.com/lijiahangmax/orion-visor
# gitee
@@ -41,18 +41,18 @@ cd orion-visor
### 启动
```
```shell
docker compose up -d
```
### 连接 mysql (如果需要在 navicat 中连接)
### 修改加密方式
```
访问 adminer: http://localhost:8081
服务器: orion-visor-mysql
用户名: root
密码: Data@123456
数据库: orion-visor
码: Data@123456
数据库: orion_visor
点击左侧 SQL命令 输入:
ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'Data@123456';
@@ -62,5 +62,5 @@ ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'Data@123456';
### 测试访问
在浏览器中输入 http://localhost:1081/ 访问
账号: admin
密码: admin
账号: `admin`
密码: `admin`

View File

@@ -1,27 +1,32 @@
> ##### 1. 数据误删除怎么办?
### 数据误删除怎么办?
数据库的数据都采用了逻辑删除, 可以将已删除的数据中的 `deleted` 字段改为 `0`
如果不知道数据是哪一条, 可以查询用户操作日志, 点击 `参数` 寻找操作的id
> ##### 2. 执行命令时为什么会找不到环境变量?
### 执行命令时为什么会找不到环境变量?
可以在执行命令的第一行设置 `source /etc/profile` 来加载环境变量
> ##### 3. 命令中途执行失败如何设置中断执行?
### 命令中途执行失败如何设置中断执行?
可以在执行命令的第一行设置 `set -e`
作用是: 当执行出现意料之外的情况时, 立即退出
> ##### 4. 在调度任务、批量执行 命令执行成功的依据是什么?
### 在调度任务、批量执行 命令执行成功的依据是什么?
是获取命令的 `exitcode` 判断是否为 `0` 如果非0则代表命令执行失败
同理, 在命令的最后一行设置 `exit 1` 结果将会是失败, 可以用此来中断后续流程
> ##### 5. 调度任务、批量执行 的日志文件中如何只保存原始输出?
### 调度任务、批量执行 的日志文件中如何只保存原始输出?
修改 `application.yaml` `app.exec-log.append-ansi``false`
> ##### 6. 为什么使用密钥认证还是无法连接机器?
### SFTP 为什么有些文件无法编辑?
只有普通文件可以在线编辑, 也就是 attr 为 `-` 开头的文件, 且文件大小不超过 `2MB` (默认)
修改 `.env.production` `VITE_SFTP_PREVIEW_MB` 改为一个合适的大小(MB) 重新构建
### 为什么使用密钥认证还是无法连接机器?
```
# 升级 openssh
@@ -41,9 +46,3 @@ AuthorizedKeysFile .ssh/authorized_keys
# 重启 sshd 服务
service sshd restart
```
<br/>
⚡ 详细使用请参考操作手册~
<br/>

View File

@@ -12,9 +12,7 @@
⚡ npm 建议使用淘宝镜像 `npm config set registry https://registry.npmmirror.com/`
⚡ pnpm 建议使用淘宝镜像 `pnpm config set registry https://registry.npmmirror.com/`
### 构建
1. 拉取代码
### 拉取代码
```
# github
@@ -23,7 +21,7 @@ git clone https://github.com/lijiahangmax/orion-visor
git clone https://gitee.com/lijiahangmax/orion-visor
```
2. 初始化数据库
### 初始化数据库
```
# 执行脚本
@@ -33,7 +31,7 @@ orion-visor/sql/init-3-schema-quartz.sql
orion-visor/sql/init-4-data.sql
```
3. 构建后端代码
### 构建后端代码
```
# 修改配置文件 (mysql, redis, secret-key)
@@ -45,7 +43,7 @@ cd orion-visor
mvn -U clean install -DskipTests
```
4. 构建前端代码
### 构建前端代码
```
# 进入代码目录
@@ -122,7 +120,7 @@ server {
```
复制 orion-visor/orion-visor-ui/dist 到 /usr/share/nginx/html
复制 orion-visor/orion-visor-launch/target/orion-visor-launch.jar 到 /data/orion
复制 orion-visor/orion-visor-launch/target/orion-visor-launch.jar 到 /data/orion-visor-space
# 启动后台服务
nohup java -jar orion-visor-launch.jar --spring.profiles.active=prod 2>&1 &
# 启动 nginx