docs: 📚 更新文档
67
ReadMe.md
|
|
@ -15,7 +15,15 @@ Gitee地址
|
|||
|
||||
整个项目都采用响应式设计，可以兼容移动设备，除了表格显示在移动端可能不够友好外，其他方面表现良好。由于表格本身具有一定的复杂性，手机上查看效果可能不理想，目前无法对其进行修改。
|
||||
|
||||
|
||||
|
||||
|
||||
## 登录内容
|
||||
|
||||
登录可以选择用户名和密码登录或者是邮箱方式登录
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 1. 首页定制
|
||||
|
||||
|
|
@ -31,11 +39,11 @@ Gitee地址
|
|||
|
||||
系统菜单图标支持动态图标。
|
||||
|
||||
|
||||
|
||||
|
||||
在添加外链时，路由名称即为外链地址。
|
||||
|
||||
|
||||
|
||||
|
||||
### 用户管理
|
||||
|
||||
|
|
@ -43,29 +51,29 @@ Gitee地址
|
|||
|
||||
其中系统中有一个默认用户是不会在前台用户进行展示的`Administrator`这个用户是系统预留，以防出错或维护使用
|
||||
|
||||
|
||||
|
||||
|
||||
### 角色权限管理
|
||||
|
||||
权限管理中的权限添加支持树型结构。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
在新增权限时，请求地址可以是正则表达式或者Java中的antpath，两者皆可兼容。
|
||||
|
||||
|
||||
|
||||
|
||||
部门管理同样采用树型结构。
|
||||
|
||||
|
||||
|
||||
|
||||
## 3. 系统配置
|
||||
|
||||
### 菜单图标
|
||||
|
||||
|
||||
|
||||
|
||||
### 邮件用户配置
|
||||
|
||||
|
|
@ -75,19 +83,19 @@ Gitee地址
|
|||
|
||||
其中默认选项无论有多少用户最终默认的只会有一个
|
||||
|
||||
|
||||
|
||||
|
||||
### 邮件模板
|
||||
|
||||
第一个是发送验证码邮件模板
|
||||
|
||||
|
||||
|
||||
|
||||
### 前端页面配置
|
||||
|
||||
因为这个模板作者将配置选项放在了前端文件中的`public`文件夹下， 配置选项现已变为动态，交给后端管理
|
||||
|
||||
|
||||
|
||||
|
||||
## 4. 系统监控
|
||||
|
||||
|
|
@ -95,43 +103,43 @@ Gitee地址
|
|||
|
||||
查看当前服务的CPU占用情况，使用SpringBoot中的`actuator`端点。图表每2秒请求一次，页面兼容移动设备。
|
||||
|
||||
|
||||
|
||||
|
||||
### 后台文件管理
|
||||
|
||||
|
||||
|
||||
|
||||
### 用户登录日志
|
||||
|
||||
|
||||
|
||||
|
||||
### 任务执行日志
|
||||
|
||||
使用任务调度时执行状态都会记录在这个里面
|
||||
|
||||
|
||||
|
||||
|
||||
### 系统缓存
|
||||
|
||||
项目中使用了SpringCache，如果请求的内容可以缓存在SpringCache中
|
||||
|
||||
|
||||
|
||||
|
||||
## 5. 定时任务
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 6. 多语言
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 外部页面
|
||||
|
||||
|
||||
|
||||
|
||||
# 环境部署
|
||||
|
||||
|
|
@ -222,25 +230,25 @@ server {
|
|||
|
||||
若无法下载，请先使用pnpm下载。若不需使用pnpm，请删除或修改相应内容。
|
||||
|
||||
|
||||
|
||||
|
||||
### docker配置
|
||||
|
||||
|
||||
|
||||
|
||||
### 配置环境
|
||||
|
||||
设置启动端口号和项目地址机器后端请求地址
|
||||
|
||||
|
||||
|
||||
|
||||
#### 配置线上环境
|
||||
|
||||
设置项目启动端口号，线上环境默认请求路径为`/admin`，需在NGINX中将访问请求前缀更改为`/admin`。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### 配置开发环境
|
||||
|
||||
|
|
@ -248,11 +256,11 @@ server {
|
|||
|
||||
前端设置的请求前缀为`/api`，但后端接受的前缀为`/admin`，因此需在服务中修改此内容。
|
||||
|
||||
|
||||
|
||||
|
||||
**修改请求路径**
|
||||
|
||||
|
||||
|
||||
|
||||
### 部署命令
|
||||
|
||||
|
|
@ -263,3 +271,4 @@ docker build -f Dockerfile -t bunny_auth_web:1.0.0 . && docker run -p 80:80 --na
|
|||
# 展望未来
|
||||
|
||||
1. 计划将文件上传服务改为本地的OSS，Minio可能会被移除。
|
||||
1. 消息服务，管理员相关的消息公告内容
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 183 KiB |
|
Before Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 120 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 134 KiB |
|
Before Width: | Height: | Size: 110 KiB |