diff --git a/README.md b/README.md index 9bf947b..b00d197 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/03-configuration/03-wfc-quickstart.md b/docs/03-configuration/03-wfc-quickstart.md index acf68f8..10624cd 100644 --- a/docs/03-configuration/03-wfc-quickstart.md +++ b/docs/03-configuration/03-wfc-quickstart.md @@ -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 file,will be copy to /etc/systemd/system + └── system +``` + * 配置软件 ```sh diff --git a/docs/03-configuration/03-wfc-quickstart.pdf b/docs/03-configuration/03-wfc-quickstart.pdf index 11908da..c03d89b 100644 Binary files a/docs/03-configuration/03-wfc-quickstart.pdf and b/docs/03-configuration/03-wfc-quickstart.pdf differ