2
0

update doc for readme and quickstart

This commit is contained in:
simonzhangsz
2024-12-14 14:54:57 +08:00
parent 3936144e1f
commit f324d90fd8
3 changed files with 59 additions and 5 deletions

View File

@@ -1,4 +1,4 @@
# WANFi Controller & Billing System
# WANFi Control & Billing System
## 构建目录
@@ -7,7 +7,8 @@ build.wfc/
├── bin # build binary file
├── build # build directory
│   ├── bin
│   ├── docker
│   ├── docker # docker compose root directory
│   │   ├── env
│   │   ├── mysql
│   │   │   ├── conf
│   │   │   ├── data

View File

@@ -1,12 +1,12 @@
# WANFi Controller & Billing System
# WANFi Control & Billing System
## 准备工作
```text
Linux >= Ubuntu 22.04
JDK >= 1.8 (Recommended version 1.8)
Docker >= 24.0.7, build 24.0.7-0ubuntu2~22.04.1
Docker-compose >= 1.29.2
docker >= 24.0.7, build 24.0.7-0ubuntu2~22.04.1
docker-compose >= 1.29.2
```
## 获取安装包
@@ -31,6 +31,59 @@ Docker-compose >= 1.29.2
sudo tar xvfz wfc-1.0.2-20241212.tar.gz -C /opt/wfc
```
* 安装后目录树
```text
/opt/wfc # work root directory
├── bin # shell script and binary file
├── docker # docker compose work directory
│   ├── env # default docker environment file, will be copy to docker compose work directory
│   ├── mysql # mysql database container directory
│   │   ├── conf
│   │   ├── data
│   │   ├── db
│   │   ├── logs
│   │   └── tmp
│   ├── nacos # nacos container directory
│   │   ├── conf
│   │   └── logs
│   ├── nginx # nginx container directory
│   │   ├── conf
│   │   ├── conf.d
│   │   ├── html
│   │   │   └── dist
│   │   │   ├── sys # system portal
│   │   │   └── u # user portal
│   │   └── logs
│   ├── redis # redis container directroy
│   │   ├── conf
│   │   └── data
│   └── wfc # wfc container root directory
│   ├── auth # auth root directory
│   │   └── jar
│   ├── gateway # gateway root directory
│   │   └── jar
│   ├── modules # modules root directory
│   │   ├── file
│   │   │   └── jar
│   │   ├── gen
│   │   │   └── jar
│   │   ├── job
│   │   │   └── jar
│   │   ├── payment
│   │   │   └── jar
│   │   ├── system
│   │   │   └── jar
│   │   └── user
│   │   └── jar
│   ├── upload # file upload directory
│   └── visual
│   └── monitor
│   └── jar
└── systemd # system service daemon filewill be copy to /etc/systemd/system
└── system
```
* 配置软件
```sh