2
0

feat: 文档修改

This commit is contained in:
caiyuchao
2025-06-24 11:36:34 +08:00
parent e7fbefc93a
commit 4da46c065c
5 changed files with 72 additions and 11 deletions

View File

@@ -1,4 +1,4 @@
# Licence软件操作手册
justify-content# Licence软件操作手册
## 项目介绍
@@ -30,7 +30,7 @@ License也就是版权许可证书一般用于收费软件给付费用户提
generatelic脚本参数说明
-t 证书到期时间,必填,格式如"2026-05-31 23:59:59"
-code 激活码,可选,格式如"ud9BGY9yZzo/ekXvf5vXzS4RmyCXm9a7rBqiUy1q7x+0kIBSz6AJ98MtGQiojJLpFbYRD1RkP2UsbtGCxyyozTK69+OWukfq9zTMu2qCkXcajL+HhuF/0VaJQDSWPjp+J"
激活码用于指定机器使用证书,激活码在wanfi项目运行后自动生成在/opt/wfc/docker/conf/license/activation_code.txt
激活码用于指定机器使用证书,激活码在MacroHub项目运行后自动生成在/opt/wfc/docker/conf/license/activation_code.txt
证书生成在/opt/lic/docker/license/license.lic
将license.lic文件放入wanfi项目目录/opt/wfc/docker/conf/license/wanfi项目才可使用
将license.lic文件放入MacroHub项目目录/opt/wfc/docker/conf/license/MacroHub项目才可使用

View File

@@ -1,4 +1,4 @@
# WANFi软件快速安装
# MacroHub软件快速安装
## 准备工作
@@ -316,12 +316,73 @@ docker-buildx >= 0.14.1
![](media/omada-auth-settings-1.png)
![](media/pay-omada-auth-settings-2.png)
* 邮件内容自定义
* 邮件内容自定义
客户平台邮件模板位于/opt/wfc/docker/conf/templates/system/mail.html
户平台邮件模板位于/opt/wfc/docker/conf/templates/user/mail.html
修改邮件模板即可修改后直接生效模板采用Thymeleaf引擎支持html语法可自定义文本内容和样式。
除了验证码占位符<span th:text="${verificationCode}"></span>和失效时间占位符<span th:text="${expirationTime}">10</span>,其余内容均可自定义修改
客户平台邮件模板位于目录/opt/wfc/docker/conf/templates/system/
户平台邮件模板位于目录/opt/wfc/docker/conf/templates/user/
验证码模板mail.html
流量提醒模板trafficReminder.html
余额提醒模板balanceReminder.html
发票模板: invoice.html
修改邮件模板即可修改后直接生效模板采用Thymeleaf引擎支持html语法可自定义文本内容和样式。
除了占位符变量如<span th:text="${verificationCode}"></span>等,其余内容均可自定义修改
* 修改套餐流量不足或余额不足配置项
```sh
cd /opt/wfc/docker/wfc/modules/user/conf/
cat application.yml
...
# 提醒配置
reminder:
# 是否开启流量提醒
trafficEnable: true
# 流量提醒阈值,单位:百分比, 如剩余小于10%会触发邮件提醒
trafficThreshold: 10
# 是否开启余额提醒
balanceEnable: true
# 余额提醒阈值,单位:跟随系统, 如余额小于5元会触发邮件提醒
balanceThreshold: 5
# 流量提醒邮件标题
trafficTitle: 'Traffic Reminder'
# 余额提醒邮件标题
balanceTitle: 'Balance Reminder'
...
```
* 统一修改系统名
修改环境变量文件
```sh
cd /opt/wfc/docker
cat .env
...
SYSTEM_TITLE=MacroHub
...
```
修改后需要重新执行并重启
```sh
cd /opt/wfc/bin
sudo ./wfcsetup.sh all 192.168.13.128 # 参数2是宿主机IP地址
```
或者直接修改国际化文件无需重启
```sh
cd /opt/wfc/docker/nginx/html/dist/u/langs
cat zh-cn.js
cat en-us.js
...
system: {
title: 'MacroHub'
}
...
```
* 启动/查看/停止/版本软件

View File

@@ -1,8 +1,8 @@
# WANFi软件编译手册
# MacroHub软件编译手册
## 项目介绍
WANFi远距离WiFi产品设计软件服务和计费系统主要用于WiFi AP设备管理、用户管理及费用管理系统包含客户平台和用户平台客户平台包含设备管理和用户套餐计费管理及系统管理等功能用户平台主要面向终端用户终端用户可通过充值和购买流量套餐实现互联网接入服务。WANFi控制平台目前基于TPLINK Omada平台API实现。
MacroHub远距离WiFi产品设计软件服务和计费系统主要用于WiFi AP设备管理、用户管理及费用管理系统包含客户平台和用户平台客户平台包含设备管理和用户套餐计费管理及系统管理等功能用户平台主要面向终端用户终端用户可通过充值和购买流量套餐实现互联网接入服务。MacroHub控制平台目前基于TPLINK Omada平台API实现。
本项目基于Spring Cloud、Ant Design Vue的前后端分离的开发平台 采用微服务解决方案,包括核心模块:角色用户、菜单权限、网关路由、数据权限等,使用中间件:日志脱敏、任务调度、短信邮箱等。